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

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.

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

[
  {
    "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

2.3.0 / 2016-09-11

• Update is-expression to 3.0.0

2.2.2 / 2016-09-07

• Support non-standard class names that start with two hyphens in class literals, most notably used in Bemto

2.2.1 / 2016-08-29

• Fix semantics of isExpression plugin

2.2.0 / 2016-08-26

• Allow customizing isExpression

2.1.0 / 2016-08-22

• Allow attributes that start with a colon

2.0.3 / 2016-08-07

• Allow when expressions with colons
• Fix incorrect location of some errors

2.0.2 / 2016-06-02

• Fix incorrect location of some invalid expressions in an attribute.

2.0.1 / 2016-05-31

• Update README for filename option

2.0.0 / 2016-05-14

• Take the filename as an option rather than special casing it. This means that lex only takes 2 arguments rather than 3
• Add support for an inline comment after a block. This means block names can no longer contain //
• Add type checking on arguments

1.2.0 / 2016-05-14

• Throw a more helpful error if someone attempts to use the old - each foo in bar syntax (it should not have the - prefix)
• Add Error reporting for invalid case expressions

1.0.1 / 2016-04-18

• Update dependencies
  • Update to is-expression@2 which allows ES2015-style template strings by default.

1.0.0 / 2015-12-23

• First stable release