Autoload Plugins for PostHTML

Install

1(sudo) npm i -D posthtml-load-plugins

Usage

Plugins will be loaded directly from your projects package.json file or local installed plugins.
Install them as usual with npm i -S or npm i -D or npm i.

PostHTML Plugins

After installing your plugins there a three ways to declare your plugin options.

• Set options directly as arguments.
• Set options in your package.json.
• Create a separated [name].[ext] file, where [name] is any name you like and [ext] should be either .js or .json. For an example of well formed options file see below.
• For plugins not having rules installed locally will be used default settings.
• Pretty reporting about not installed plugins.

Options

package.json

1{
2    "dependencies": {
3        "posthtml-bem": "^0.2.2",
4        "posthtml-each": "^1.0.1",
5        "posthtml-include": "^1.0.2"
6},
7    "devDependencies": {
8        "posthtml-style-to-file": "^0.1.1"
9},
10    "posthtml": {
11        "bem": {
12            "elemPrefix": "__",
13            "modPrefix": "-",
14            "modDlmtr": "--"
15        },
16        "include": {
17            "root": "./",
18            "encoding": "utf-8"
19        },
20        "styleToFile": {
21            "path": "./dist/style.css"
22        }
23    }
24}

[name].[ext]

JS

```js
module.exports = {
    bem: {
        elemPrefix: '__',
        modPrefix: '-',
        modDlmtr: '--'
    },
    include: {
        root: './',
        encoding: 'utf-8'
    },
    styleToFile: {
        path: './dist/style.css'
    }
}

or

1module.exports = [
2    {
3        bem: {
4            elemPrefix: '__',
5            modPrefix: '-',
6            modDlmtr: '--'
7        },
8        include: {
9            root: './',
10            encoding: 'utf-8'
11        }
12    }, {
13        styleToFile: {
14            path: './dist/style.css'
15        }
16    }
17]

JSON

1{
2    "bem": {
3        "elemPrefix": "__",
4        "modPrefix": "-",
5        "modDlmtr": "--"
6    },
7    "include": {
8        "root": "./",
9        "encoding": "utf-8"
10    },
11    "styleToFile": {
12        "path": "./dist/style.css"
13    }
14}

Usage

For general usage and build process integration see PostHTML Docs

Examples using Node API

Default

1const fs = require('fs');
2
3const posthtml = require('posthtml');
4const plugins = require('posthtml-load-plugins');
5
6let html = fs.readFileSync('./index.html', 'utf8');
7
8posthtml(plugins([object|array[objects]|file] /* options */, [object|array[objects]|file] /* extends */))
9    .process(html)
10    .then(result => console.log(result.html));

Options file (e.g posthtml.json)

1const fs = require('fs');
2
3const posthtml = require('posthtml');
4const plugins = require('posthtml-load-plugins')('posthtml.(js|json)');
5
6let html = fs.readFileSync('./index.html', 'utf8');
7
8posthtml(plugins)
9    .process(html)
10    .then(result => console.log(result.html));

Extends options

1const fs = require('fs');
2
3const posthtml = require('posthtml');
4const plugins = require('posthtml-load-plugins')('posthtml.(js|json)', {"posthtml-bem": {elemPrefix: '__'}});
5
6let html = fs.readFileSync('./index.html', 'utf8');
7
8posthtml(plugins)
9    .process(html)
10    .then(result => console.log(result.html));

Use with posthtml-standard-config

1const fs = require('fs');
2
3const posthtml = require('posthtml');
4const standardConfig = require('posthtml-standard-config');
5const plugins = require('posthtml-load-plugins')(standardConfig);
6
7let html = fs.readFileSync('./index.html', 'utf8');
8
9posthtml(plugins)
10    .process(html)
11    .then(result => console.log(result.html));

Contributors

Ivan Demidov

License

MIT