PostHTML Loader
Install
npm i -D posthtml-loader copy
Usage
import html from './file.html' copy
webpack.config.js
module : {
rules : [
{
test: /\.html$/ ,
use: [
'html-loader' ,
{
loader: 'posthtml-loader' ,
options: {
ident: 'posthtml' ,
parser: 'PostHTML Parser' ,
plugins: [
/* PostHTML Plugins */
require ( 'posthtml-plugin' )(options)
]
}
}
]
}
]
}, copy
Options
Name Type Default Description config{Object}undefinedPostHTML Config parser{String/Function}undefinedPostHTML Parser skipParse{Boolean}falsePostHTML Options SkipParse
Config
Name Type Default Description path{String}loader.resourcePathPostHTML 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 copy
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
{
loader : 'posthtml-loader' ,
options : {
config : {
path : 'path/to/.config/'
}
}
} copy
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
module . exports = ({ file, options, env }) => ({
parser: 'posthtml-sugarml' ,
plugins: {
'posthtml-include' : options.include,
'posthtml-content' : options.content,
'htmlnano' : env === 'production' ? {} : false
}
}) copy
webpack.config.js
{
loader : 'posthtml-loader' ,
options : {
config : {
ctx : {
include : { ... options},
content : { ... options}
}
}
}
} copy
Parser
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
{
loader : 'posthtml-loader' ,
options : {
parser : 'posthtml-sugarml'
}
} copy
{Function}
webpack.config.js
{
loader : 'posthtml-loader' ,
options : {
parser : require ( 'posthtml-sugarml' )()
}
} copy
skipParse
If you want to use disable parsing, you can pass it in under the skipParse key in the loader options
{Boolean}
webpack.config.js
{
loader : 'posthtml-loader' ,
options : {
skipParse : false
}
} copy
Render
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
{
loader : 'posthtml-loader' ,
options : {
render : 'posthtml-you-render'
}
} copy
{Function}
webpack.config.js
{
loader : 'posthtml-loader' ,
options : {
parser : require ( 'posthtml-you-render' )()
}
} copy
Plugins
Plugins are specified under the plugins key in the loader options
{Array}
webpack.config.js
{
loader : 'posthtml-loader' ,
options : {
plugins : [
require ( 'posthtml-plugin' )()
]
}
} copy
{Function}
webpack.config.js
{
loader : 'posthtml-loader' ,
options : {
plugins (loader) {
return [
require ( 'posthtml-plugin' )()
]
}
}
} copy
Sync
Enables sync mode, plugins will run synchronously, throws an error when used with async plugins
{Boolean}
webpack.config.js
{
loader : 'posthtml-loader' ,
options : {
sync : true
}
} copy
Directives
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
{
loader : 'posthtml-loader' ,
options : {
directives : [{name: '?php' , start: '<' , end: '>' }]
}
} copy
Maintainer