You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
46 lines
1.8 KiB
46 lines
1.8 KiB
# pug-strip-comments |
|
|
|
Strips comments from Pug token stream |
|
|
|
[](https://travis-ci.org/pugjs/pug-strip-comments) |
|
[](https://david-dm.org/pugjs/pug?path=packages/pug-strip-comments) |
|
[](https://david-dm.org/pugjs/pug?path=packages/pug-strip-comments&type=dev) |
|
[](https://www.npmjs.org/package/pug-strip-comments) |
|
|
|
## Installation |
|
|
|
npm install pug-strip-comments |
|
|
|
## Usage |
|
|
|
```js |
|
var lex = require('pug-lexer'); |
|
var stripComments = require('pug-strip-comments'); |
|
|
|
var tokens = lex('//- unbuffered\n// buffered'); |
|
// [ { type: 'comment', line: 1, val: ' unbuffered', buffer: false }, |
|
// { type: 'newline', line: 2 }, |
|
// { type: 'comment', line: 2, val: ' buffered', buffer: true }, |
|
// { type: 'eos', line: 2 } ] |
|
|
|
// Only strip unbuffered comments (default) |
|
stripComments(tokens, { filename: 'pug' }); |
|
// [ { type: 'newline', line: 2 }, |
|
// { type: 'comment', line: 2, val: ' buffered', buffer: true }, |
|
// { type: 'eos', line: 2 } ] |
|
|
|
// Only strip buffered comments (when you want to play a joke on your coworkers) |
|
stripComments(tokens, { filename: 'pug', stripUnbuffered: false, stripBuffered: true }); |
|
// [ { type: 'comment', line: 1, val: ' unbuffered', buffer: false }, |
|
// { type: 'newline', line: 2 }, |
|
// { type: 'eos', line: 2 } ] |
|
|
|
// Strip both (if you want Pug VERY clean) |
|
stripComments(tokens, { filename: 'pug', stripBuffered: true }); |
|
// [ { type: 'newline', line: 2 }, |
|
// { type: 'eos', line: 2 } ] |
|
``` |
|
|
|
## License |
|
|
|
MIT
|
|
|