posthtml-loader
v2.0.1
PostHTML for Webpack
0/weekUpdated 1 years agoMITUnpacked: 16.4 KB
Published by Michael Ciniawsky
npm install posthtml-loader[![npm][npm]][npm-url]
[![node][node]][node-url]
[![deps][deps]][deps-url]
[![tests][tests]][tests-url]
[![coverage][cover]][cover-url]
[![code style][style]][style-url]
[![chat][chat]][chat-url]
PostHTML Loader
Install
``bash`
npm i -D posthtml-loader
Usage
`js`
import html from './file.html'
webpack.config.js
`js`
module: {
rules: [
{
test: /\.html$/,
use: [
'html-loader',
{
loader: 'posthtml-loader',
options: {
ident: 'posthtml',
parser: 'PostHTML Parser',
plugins: [
/ PostHTML Plugins /
require('posthtml-plugin')(options)
]
}
}
]
}
]
},
Options
|Name|Type|Default|Description|
|:--:|:--:|:-----:|:----------|
|config|{Object}|undefined|PostHTML Config|parser
||{String/Function}|undefined|PostHTML Parser|skipParse
||{Boolean}|false|PostHTML Options SkipParse|render
||{String/Function}|undefined|PostHTML Render|plugins
||{Array/Function}|[]|PostHTML Plugins|sync
||{boolean}|false|PostHTML Options Sync|directives
||{Array
$3
|Name|Type|Default|Description|
|:--:|:--:|:-----:|:----------|
|path|{String}|loader.resourcePath|PostHTML Config Path|ctx
||{Object}|{}|PostHTML Config Context|
If you want to use are shareable config file instead of inline options in your webpack.config.js create a posthtml.config.js file and place it somewhere down the file tree in your project. The nearest config relative to dirname(file) currently processed by the loader applies. This enables Config Cascading. Despite some edge cases the config file will be loaded automatically and no additional setup is required. If you don't intend to use Config Cascading, it's recommended to place posthtml.config.js in the root ./ of your project
`
src
├── components
│ ├── component.html
│ ├── posthtml.config.js (components)
├── index.html
├── posthtml.config.js (index)
└── webpack.config.js
#### Path
If you normally place all your config files in a separate folder e.g ./config it is necessary to explicitly set the config path in webpack.config.js
webpack.config.js
`js`
{
loader: 'posthtml-loader',
options: {
config: {
path: 'path/to/.config/'
}
}
}
#### Context
|Name|Type|Default|Description|
|:--:|:--:|:-----:|:----------|
|env|{String}|'development'|process.env.NODE_ENV|file
||{Object}|{ dirname, basename, extname }|File|options
||{Object}|{}|Plugin Options (Context)|
posthtml.config.js
`js`
module.exports = ({ file, options, env }) => ({
parser: 'posthtml-sugarml',
plugins: {
'posthtml-include': options.include,
'posthtml-content': options.content,
'htmlnano': env === 'production' ? {} : false
}
})
webpack.config.js
`js`
{
loader: 'posthtml-loader',
options: {
config: {
ctx: {
include: {...options},
content: {...options}
}
}
}
}
$3
If you want to use a custom parser e.g SugarML, you can pass it in under the parser key in the loader options
#### {String}
webpack.config.js
`js`
{
loader: 'posthtml-loader',
options: {
parser: 'posthtml-sugarml'
}
}
#### {Function}
webpack.config.js
`js`
{
loader: 'posthtml-loader',
options: {
parser: require('posthtml-sugarml')()
}
}
$3
If you want to use disable parsing, you can pass it in under the skipParse key in the loader options
#### {Boolean}
webpack.config.js
`js`
{
loader: 'posthtml-loader',
options: {
skipParse: false
}
}
$3
If you want to use a custom render, you can pass it in under the render key in the loader options
#### {String}
webpack.config.js
`js`
{
loader: 'posthtml-loader',
options: {
render: 'posthtml-you-render'
}
}
#### {Function}
webpack.config.js
`js`
{
loader: 'posthtml-loader',
options: {
parser: require('posthtml-you-render')()
}
}
$3
Plugins are specified under the plugins key in the loader options
#### {Array}
webpack.config.js
`js`
{
loader: 'posthtml-loader',
options: {
plugins: [
require('posthtml-plugin')()
]
}
}
#### {Function}
webpack.config.js
`js`
{
loader: 'posthtml-loader',
options: {
plugins (loader) {
return [
require('posthtml-plugin')()
]
}
}
}
$3
Enables sync mode, plugins will run synchronously, throws an error when used with async plugins
#### {Boolean}
webpack.config.js
`js`
{
loader: 'posthtml-loader',
options: {
sync: true
}
}
$3
If you want to use a custom directives, you can pass it in under the directives key in the loader options
#### {Array}
webpack.config.js
`js``
{
loader: 'posthtml-loader',
options: {
directives: [{name: '?php', start: '<', end: '>'}]
}
}
Maintainer
Michael Ciniawsky |  Ivan Demidov |
[npm]: https://img.shields.io/npm/v/posthtml-loader.svg
[npm-url]: https://npmjs.com/package/posthtml-loader
[node]: https://img.shields.io/node/v/posthtml-loader.svg
[node-url]: https://nodejs.org/
[deps]: https://david-dm.org/posthtml/posthtml-loader.svg
[deps-url]: https://david-dm.org/posthtml/posthtml-loader
[tests]: http://img.shields.io/travis/posthtml/posthtml-loader.svg
[tests-url]: https://travis-ci.org/posthtml/posthtml-loader
[cover]: https://coveralls.io/repos/github/posthtml/posthtml-loader/badge.svg
[cover-url]: https://coveralls.io/github/posthtml/posthtml-loader
[style]: https://img.shields.io/badge/code%20style-standard-yellow.svg
[style-url]: http://standardjs.com/
[chat]: https://badges.gitter.im/posthtml/posthtml.svg
[chat-url]: https://gitter.im/posthtml/posthtml