function
4 | PostHTML Plugin for Gulp
5 |
6 | **Kind**: global function
7 | **Returns**: function - Stream (Transform)
8 | **Requires**: module:plugin-error, module:through2, module:posthtml, module:posthtml-load-config
9 | **Version**: 3.0.0
10 | **Author**: Ivan Voishev (@voishev) Array | PostHTML Plugins |
16 | | options | Object | PostHTML Options |
17 |
18 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | [![npm][npm]][npm-url]
2 | [![node][node]][node-url]
3 | [![deps][deps]][deps-url]
4 | [![tests][tests]][tests-url]
5 | [![coverage][cover]][cover-url]
6 | [![code style][style]][style-url]
7 | [![chat][chat]][chat-url]
8 |
9 |
16 |
17 | 
11 | 
13 | Install
18 | 19 | ```bash 20 | npm i -D gulp-posthtml 21 | ``` 22 | 23 |Usage
24 | 25 | ```js 26 | import { task, src, dest } from 'gulp' 27 | 28 | import posthtml from 'gulp-posthtml' 29 | 30 | task('html', () => { 31 | return src('src/*.html') 32 | .pipe(posthtml()) 33 | .pipe(dest('dest')) 34 | }) 35 | ``` 36 | 37 |Options
38 | 39 | ### `Plugins` 40 | 41 | |Name|Type|Default|Description| 42 | |:--:|:--:|:-----:|:----------| 43 | |`plugins`|`{Array}`|`[]`|PostHTML Plugins| 44 | 45 | ### `Options` 46 | 47 | |Name|Type|Default|Description| 48 | |:--:|:--:|:-----:|:----------| 49 | |`options`|`{Object}`|`{}`|PostHTML Options| 50 | 51 | **gulpfile.js** 52 | ```js 53 | import { task, src, dest } from 'gulp' 54 | 55 | import tap from 'gulp-tap' 56 | import rename from 'gulp-rename' 57 | import posthtml from 'gulp-posthtml' 58 | 59 | task('html', () => { 60 | let path 61 | 62 | const plugins = [ require('posthtml-include')({ root: path }) ] 63 | const options = { parser: require('posthtml-sugarml')() } 64 | 65 | return src('src/*.html') 66 | .pipe(tap((file) => path = file.path)) 67 | .pipe(posthtml(plugins, options)) 68 | .pipe(rename({ ext: '.html' })) 69 | .pipe(dest('dest')) 70 | }) 71 | ``` 72 | 73 | ### `Config` 74 | 75 | |Name|Type|Default|Description| 76 | |:--:|:--:|:-----:|:----------| 77 | |`plugins`|`{Array}`|`[]`|PostHTML Plugins| 78 | |`options`|`{Object}`|`{}`|PostHTML Options| 79 | 80 | **gulpfile.js** 81 | ```js 82 | import { task, src, dest } from 'gulp' 83 | 84 | import rename from 'gulp-rename' 85 | import posthtml from 'gulp-posthtml' 86 | 87 | 88 | task('ssml', () => { 89 | const config = (file) => ({ 90 | plugins: [ require('posthtml-include')({ root: file.dirname }) ], 91 | options: { parser: require('posthtml-sugarml')() } 92 | }) 93 | 94 | return src('src/*.sml') 95 | .pipe(posthtml(config)) 96 | .pipe(rename({ ext: '.html' })) 97 | .pipe(dest('dest')) 98 | }) 99 | ``` 100 | 101 | ### [`posthtml.config.js`](https://github.com/posthtml/posthtml-load-config) 102 | 103 | #### `Context` 104 | 105 | |Name|Type|Default|Description| 106 | |:--:|:--:|:-----:|:----------| 107 | |`env`|`{String}`|`'development'`|process.env.NODE_ENV| 108 | |`file`|`{Object}`|`dirname, basename, extname`|File| 109 | |`options`|`{Object}`|`{}`|Options (Parser, Render, Plugin Options)| 110 | 111 | **posthtml.config.js** 112 | ```js 113 | module.exports = ({ file, options, env }) => ({ 114 | parser: 'posthtml-sugarml' 115 | plugins: { 116 | 'posthtml-include': { root: file.dirname }, 117 | 'posthtm-expressions': { locals: options.locals } 118 | 'htmlnano': env === 'production' ? {} : false 119 | } 120 | }) 121 | ``` 122 | 123 | **gulpfile.js** 124 | ```js 125 | import { task, src, dest } from 'gulp' 126 | 127 | import rename from 'gulp-rename' 128 | import posthtml from 'gulp-posthtml' 129 | 130 | 131 | task('ssml', () => { 132 | const ctx = { locals: { a: 'Hello World!'} } 133 | 134 | return src('src/*.sml') 135 | .pipe(posthtml(ctx)) 136 | .pipe(rename({ ext: '.html' })) 137 | .pipe(dest('dest')) 138 | }) 139 | ``` 140 | 141 |Maintainer
142 | 143 |
147 | 
149 | 150 | Ivan Voischev 151 | |
152 |
Contributors
157 | 158 |
162 | 
164 | 165 | Michael Ciniawsky 166 | |
167 |
9 |
11 | Lorem ipsum dolor sit amet, consectetur adipisicing elit. Modi vitae quis commodi ducimus quas sequi, laborum pariatur architecto, officiis amet sit consequatur placeat omnis explicabo sed. Illum, blanditiis doloribus quasi.
12 |
13 |
14 |
15 |
16 |
17 |
--------------------------------------------------------------------------------
/test/expect/index.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 | Hello World
10 |
9 |
12 |
13 |
14 |
--------------------------------------------------------------------------------
/test/expect/sugar-result.html:
--------------------------------------------------------------------------------
1 | Hello World
10 |
9 |
12 |
13 |
14 |
--------------------------------------------------------------------------------
/test/fixtures/index.sml:
--------------------------------------------------------------------------------
1 | doctype html
2 | html(lang='en')
3 | head
4 | title Gulp PostHTML
5 | body
6 | include(src='component.html')
7 |
--------------------------------------------------------------------------------
/test/fixtures/posthtml.config.js:
--------------------------------------------------------------------------------
1 | module.exports = (ctx) => ({
2 | parser: 'posthtml-sugarml',
3 | plugins: {
4 | 'posthtml-include': ctx.options.include,
5 | 'posthtml-content': false,
6 | htmlnano: ctx.env === 'production' ? {} : false
7 | }
8 | })
9 |
--------------------------------------------------------------------------------
/test/index.test.js:
--------------------------------------------------------------------------------
1 | // ------------------------------------
2 | // #GULP - POSTHTML - TEST - INDEX
3 | // ------------------------------------
4 |
5 | const test = require('ava')
6 | const fs = require('fs')
7 | const path = require('path')
8 | const File = require('vinyl')
9 |
10 | const fixture = (file) => {
11 | return new File({
12 | path: path.resolve('test/fixtures', file),
13 | contents: Buffer.from(
14 | fs.readFileSync(path.resolve('test/fixtures', file), 'utf8')
15 | )
16 | })
17 | }
18 |
19 | const expected = (file) => {
20 | return fs.readFileSync(path.resolve('test/expect', file), 'utf8')
21 | }
22 |
23 | const posthtml = require('..')
24 |
25 | test.cb('File', t => {
26 | t.plan(2)
27 | const html = fixture('index.html')
28 |
29 | const plugin = posthtml([])
30 |
31 | plugin.write(html)
32 |
33 | plugin.on('data', (html) => {
34 | t.true(html.isBuffer())
35 | t.is(html.contents.toString('utf8'), expected('index.html'))
36 | t.end()
37 | })
38 | })
39 |
40 | test.cb('Plugins', t => {
41 | t.plan(2)
42 | const html = fixture('index.html')
43 |
44 | const plugins = [
45 | require('posthtml-include')({ root: './test/fixtures/components' })
46 | ]
47 |
48 | const plugin = posthtml(plugins)
49 |
50 | plugin.write(html)
51 |
52 | plugin.on('data', (html) => {
53 | t.true(html.isBuffer())
54 | t.is(html.contents.toString('utf8'), expected('html-result.html'))
55 | t.end()
56 | })
57 | })
58 |
59 | test.cb('Options', t => {
60 | t.plan(2)
61 | const html = fixture('index.sml')
62 |
63 | const cb = (file) => ({
64 | plugins: [
65 | require('posthtml-include')({ root: `${file.dirname}/components` })
66 | ],
67 | options: { parser: require('posthtml-sugarml')() }
68 | })
69 |
70 | const plugin = posthtml(cb)
71 |
72 | plugin.write(html)
73 |
74 | plugin.on('data', (html) => {
75 | t.true(html.isBuffer())
76 | t.is(html.contents.toString('utf8'), expected('sugar-result.html'))
77 | t.end()
78 | })
79 | })
80 |
81 | test.cb('Function', t => {
82 | t.plan(2)
83 | const html = fixture('index.sml')
84 |
85 | const cb = (file) => ({
86 | plugins: [
87 | require('posthtml-include')({ root: `${file.dirname}/components` })
88 | ],
89 | options: { parser: require('posthtml-sugarml')() }
90 | })
91 |
92 | const plugin = posthtml(cb)
93 |
94 | plugin.write(html)
95 |
96 | plugin.on('data', (html) => {
97 | t.true(html.isBuffer())
98 | t.is(html.contents.toString('utf8'), expected('sugar-result.html'))
99 | t.end()
100 | })
101 | })
102 |
103 | test.cb('Config', t => {
104 | t.plan(2)
105 | const html = fixture('index.sml')
106 |
107 | const ctx = { include: { root: './test/fixtures/components' } }
108 |
109 | const plugin = posthtml(ctx)
110 |
111 | plugin.write(html)
112 |
113 | plugin.on('data', (html) => {
114 | t.true(html.isBuffer())
115 | t.is(html.contents.toString('utf8'), expected('sugar-result.html'))
116 | t.end()
117 | })
118 | })
119 |
--------------------------------------------------------------------------------