pug-lexer

The pug lexer. This module is responsible for taking a string and converting it into an array of tokens.

Installation

npm install pug-lexer

Usage

1var lex = require('pug-lexer');

lex(str, filename, options)

Convert Pug string to an array of tokens.

filename, if provided, is used in error handling.

options can contain the following property:

• plugins (array): An array of plugins, in the order they should be applied.

1console.log(JSON.stringify(lex('div(data-foo="bar")', 'my-file.pug'), null, '  '))

1[
2  {
3    "type": "tag",
4    "line": 1,
5    "val": "div",
6    "selfClosing": false
7  },
8  {
9    "type": "attrs",
10    "line": 1,
11    "attrs": [
12      {
13        "name": "data-foo",
14        "val": "\"bar\"",
15        "escaped": true
16      }
17    ]
18  },
19  {
20    "type": "eos",
21    "line": 1
22  }
23]

new lex.Lexer(str, filename, 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:

• 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