Wondering what’s next for npm?Check out our public roadmap! »

    pug-lexer
    TypeScript icon, indicating that this package has built-in type declarations

    5.0.1 • Public • Published

    pug-lexer

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

    Build Status Dependencies Status DevDependencies Status NPM version Coverage Status

    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

    Keywords

    Install

    npm i pug-lexer

    DownloadsWeekly Downloads

    1,156,366

    Version

    5.0.1

    License

    MIT

    Unpacked Size

    59.3 kB

    Total Files

    6

    Last publish

    Collaborators

    • avatar
    • avatar