snapdragon-position

snapdragon-position

Snapdragon util and plugin for patching the position on an AST node.

Install

Install with npm:

$ npm install --save snapdragon-position

What is this?

Position is not always needed when parsing, and when converting an existing AST to a snapdragon AST the existing position information can be converted too.

This plugin adds a .position() method to the parser instance for cases when you do need position information on your AST nodes.

Usage

The main export if a function that is passed to snapdragon.use().

Example

var Snapdragon = require('snapdragon');
var position = require('snapdragon-position');
var parser = new Snapdragon.Parser();
parser.use(position());

position

Mark position and patch node.position with start and end line and column.

• returns {Function}: Returns a function that takes node and is called before returning the node in a parser visitor function.

Example

parser.set('foo', function(node) {
  var pos = this.position();
  var match = this.match(/foo/);
  if (match) {
    // pass `pos` to `this.node` to patch position
    return pos(this.node(match[0]));
  }
});

About

Related projects

• snapdragon-capture: Snapdragon plugin that adds a capture method to the parser instance. | homepage
• snapdragon-node: Snapdragon utility for creating a new AST node in custom code, such as plugins. | homepage
• snapdragon-util: Utilities for the snapdragon parser/compiler. | homepage
• snapdragon: Fast, pluggable and easy-to-use parser-renderer factory. | homepage

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Please read the contributing guide for advice on opening issues, pull requests, and coding standards.

Building docs

(This document was generated by verb-generate-readme (a verb generator), please don't edit the readme directly. Any changes to the readme must be made in .verb.md.)

To generate the readme and API documentation with verb:

$ npm install -g verb verb-generate-readme && verb

Running tests

Install dev dependencies:

$ npm install -d && npm test

Author

Jon Schlinkert

• github/jonschlinkert
• twitter/jonschlinkert

License

Copyright © 2017, Jon Schlinkert. Released under the MIT license.

This file was generated by verb-generate-readme, v0.4.1, on January 20, 2017.