Awesome
snapdragon-token
Create a snapdragon token. Used by the snapdragon lexer, but can also be used by plugins.
Please consider following this project's author, Jon Schlinkert, and consider starring the project to show your :heart: and support.
Install
Install with npm:
$ npm install --save snapdragon-token
Usage
const Token = require('snapdragon-token');
API
Token
Create a new Token
with the given value
and type
.
Params
type
{String|Object}: The token type to use whenvalue
is a string.value
{String}: Value to setreturns
{Object}: Token instance
Example
const token = new Token('*', 'Star');
const token = new Token({type: 'star', value: '*'});
console.log(token) //=> Token { type: 'star', value: '*' }
Release history
See the changelog.
Token objects
Lexer tokens are represented as Token
objects that implement the following interface:
interface Token {
type: string;
value: string;
match: array | undefined;
}
Token properties
type
{string} - A string representing the token variant type. This property is necessary for classifying one or more characters so that parsers or compilers can determine what to do with the token.value
{string} - The substring (or lexeme) that was captured for the token.match
{array|undefined} - If a regular expression was used to capture a substring, theRegExp.exec()
orString.match()
arguments array can be stored on the token.
Source location
Add the source location (start, end, index and range) information to tokens using either of the following plugins (depending on preference for property naming conventions):
About
<details> <summary><strong>Contributing</strong></summary>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.
</details> <details> <summary><strong>Running Tests</strong></summary>Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:
$ npm install && npm test
</details>
<details>
<summary><strong>Building docs</strong></summary>
(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)
To generate the readme, run the following command:
$ npm install -g verbose/verb#dev verb-generate-readme && verb
</details>
Related projects
You might also be interested in these projects:
- 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: Easy-to-use plugin system for creating powerful, fast and versatile parsers and compilers, with built-in source-map… more | homepage
Author
Jon Schlinkert
License
Copyright © 2018, Jon Schlinkert. Released under the MIT License.
This file was generated by verb-generate-readme, v0.6.0, on April 26, 2018.