snapdragon-parser

snapdragon-parser

Easily parse a string to create an AST.

Table of Contents

• Install
• Usage
• About

Install

$ npm install --save snapdragon-parser

Usage

Parser

• input {String}
• options {Object}

const Parser = require('snapdragon-parser');
const parser = new Parser();

.node

• node {Object}: The object to use to create a node
• returns {Object}: returns the created Node instance.

const node = parser.node({type: 'slash', value: '/'});
// sugar for
const Node = require('snapdragon-node');
const node = Node({type: 'slash', value: '/'});

.isNode

• node {Object}
• returns {Boolean}

.set

• type {String}
• handler {Function}

parser.set('all', function(tok) {
  // do stuff to tok
  return tok;
});

.get

• type {String}
• fn {Function}: The handler function to register.

handlers.set('star', function() {
  // do parser, lexer, or compiler stuff
});
const star = handlers.get('star');

.has

• {String}: type
• returns {Boolean}

parser.set('star', function() {});
console.log(parser.has('star')); // true

.capture

• type {String}: (required)
• regex {RegExp}: (optional)
• lexerFn {Function}: (optional)
• parserFn {Function}: (optional)
• returns {Object}: Returns the Parser instance for chaining.

.isInside

• type {String}
• returns {Boolean}

.isBlock

• node {Object}
• returns {Boolean}

parser.isBlock(new Node()); //=> false
parser.isBlock(new Node({ nodes: [] })); //=> true

.isBlock

• node {Object}
• returns {Boolean}

parser.isBlock(new Node()); //=> false
parser.isBlock(new Node({ nodes: [] })); //=> true

.isOpen

• node {Object}
• returns {Object} parentNode

.isClose

• node {Object}
• returns {Object} parentNode

.push

• node {Object}: (required)
• returns {Object} node

• emits: push

parser.set('default', function(tok) {
  return this.push(this.node(tok));
});

.pop

• node {Object}: (optional)
• returns {Object} node

• emits: pop

parser.set('default', function(tok) {
  return this.push(this.node(tok));
});

.next

• returns {Any}: Returns whatever value the handler returns.

• type {String}

• {String}: type

.parse

• input {String}
• returns {Object}: Returns an AST (abstract syntax tree).

const ast = parser.parse('foo/bar');

• options {Object}
• parent {Object}: Optionally pass a different parser instance to copy handlers from.
• returns {Object}: Returns a new Parser instance

• node {Object}
• ast {Object}
• returns {Object}

.hasListeners

• name {String}
• returns {Boolean}

• fn {Function}
• returns {Parser}: Returns the Parser instance.

const myParser = new Parser();
const plugin = parser => {
  // do stuff to parser instance
};
myParser.use(plugin);

.error

• msg {String}: Message to use in the Error.
• node {Object}
• returns {Undefined}

parser.set('foo', function(tok) {
  if (tok.value !== 'foo') {
    throw this.error('expected token.value to be "foo"', tok);
  }
});

• returns {String}

• parser {Object}
• returns {Boolean}

const Parser = require('parser');
const parser = new Parser();
console.log(Parser.isParser(parser)); //=> true
console.log(Parser.isParser({})); //=> false

About

$ npm install && npm test

$ npm install -g verbose/verb#dev verb-generate-readme && verb

Related projects

• snapdragon-lexer: Converts a string into an array of tokens, with useful methods for looking ahead and… more | homepage
• snapdragon-node: Snapdragon utility for creating a new AST node in custom code, such as plugins. | homepage
• snapdragon-position: Snapdragon util and plugin for patching the position on an AST node. | homepage
• snapdragon-token: Create a snapdragon token. Used by the snapdragon lexer, but can also be used by… more | homepage

Author

• GitHub Profile
• Twitter Profile
• LinkedIn Profile

License