Newer
Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
# pug-lexer
The pug lexer. This module is responsible for taking a string and converting it into an array of tokens.
[](https://travis-ci.org/pugjs/pug-lexer)
[](https://david-dm.org/pugjs/pug-lexer)
[](https://www.npmjs.org/package/pug-lexer)
[](https://codecov.io/gh/pugjs/pug-lexer)
## Installation
npm install pug-lexer
## Usage
```js
var lex = require('pug-lexer');
```
### `lex(str, options)`
Convert Pug string to an array of tokens.
`options` can contain the following properties:
- `filename` (string): The name of the Pug file; it is used in error handling if provided.
- `plugins` (array): An array of plugins, in the order they should be applied.
```js
console.log(JSON.stringify(lex('div(data-foo="bar")', {filename: 'my-file.pug'}), null, ' '))
```
```json
[
{
"type": "tag",
"line": 1,
"val": "div",
"selfClosing": false
},
{
"type": "attrs",
"line": 1,
"attrs": [
{
"name": "data-foo",
"val": "\"bar\"",
"escaped": true
}
]
},
{
"type": "eos",
"line": 1
}
]
```
### `new lex.Lexer(str, options)`
Constructor for a Lexer class. This is not meant to be used directly unless you know what you are doing.
`options` may contain the following properties:
- `filename` (string): The name of the Pug file; it is used in error handling if provided.
- `interpolated` (boolean): if the Lexer is created as a child lexer for inline tag interpolation (e.g. `#[p Hello]`). Defaults to `false`.
- `startingLine` (integer): the real line number of the first line in the input. It is also used for inline tag interpolation. Defaults to `1`.
- `plugins` (array): An array of plugins, in the order they should be applied.
## License
MIT