Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/here-be/snapdragon-token
Create a snapdragon token. Used by the snapdragon lexer, but can also be used by plugins.
https://github.com/here-be/snapdragon-token
compiler javascript lexer node nodejs parser snapdragon token tokenize tokenizer
Last synced: about 2 months ago
JSON representation
Create a snapdragon token. Used by the snapdragon lexer, but can also be used by plugins.
- Host: GitHub
- URL: https://github.com/here-be/snapdragon-token
- Owner: here-be
- License: mit
- Created: 2017-11-09T07:09:30.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2018-04-26T10:44:45.000Z (over 6 years ago)
- Last Synced: 2024-05-09T22:04:09.942Z (8 months ago)
- Topics: compiler, javascript, lexer, node, nodejs, parser, snapdragon, token, tokenize, tokenizer
- Language: JavaScript
- Homepage: https://github.com/here-be
- Size: 23.4 KB
- Stars: 2
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/contributing.md
- License: LICENSE
Awesome Lists containing this project
README
# snapdragon-token [](https://www.npmjs.com/package/snapdragon-token) [](https://npmjs.org/package/snapdragon-token) [](https://npmjs.org/package/snapdragon-token) [](https://travis-ci.org/here-be/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](https://github.com/jonschlinkert), and consider starring the project to show your :heart: and support.
## Install
Install with [npm](https://www.npmjs.com/):
```sh
$ npm install --save snapdragon-token
```
## Usage
```js
const Token = require('snapdragon-token');
```
## API
### [Token](index.js#L18)
Create a new `Token` with the given `value` and `type`.
**Params**
* `type` **{String|Object}**: The token type to use when `value` is a string.
* `value` **{String}**: Value to set
* `returns` **{Object}**: Token instance
**Example**
```js
const token = new Token('*', 'Star');
const token = new Token({type: 'star', value: '*'});
console.log(token) //=> Token { type: 'star', value: '*' }
```
## Release history
See [the changelog](CHANGELOG.md).
## Token objects
Lexer tokens are represented as `Token` objects that implement the following interface:
```js
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](#lexeme)) that was captured for the token.
* `match` **{array|undefined}** - If a regular expression was used to capture a substring, the `RegExp.exec()` or `String.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):
* [snapdragon-position](https://github.com/here-be/snapdragon-position)
* [snapdragon-location](https://github.com/here-be/snapdragon-location)
## About
Contributing
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).
Please read the [contributing guide](.github/contributing.md) for advice on opening issues, pull requests, and coding standards.
Running Tests
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:
```sh
$ npm install && npm test
```
Building docs
_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_
To generate the readme, run the following command:
```sh
$ npm install -g verbose/verb#dev verb-generate-readme && verb
```
### Related projects
You might also be interested in these projects:
* [snapdragon-node](https://www.npmjs.com/package/snapdragon-node): Snapdragon utility for creating a new AST node in custom code, such as plugins. | [homepage](https://github.com/jonschlinkert/snapdragon-node "Snapdragon utility for creating a new AST node in custom code, such as plugins.")
* [snapdragon-util](https://www.npmjs.com/package/snapdragon-util): Utilities for the snapdragon parser/compiler. | [homepage](https://github.com/here-be/snapdragon-util "Utilities for the snapdragon parser/compiler.")
* [snapdragon](https://www.npmjs.com/package/snapdragon): Easy-to-use plugin system for creating powerful, fast and versatile parsers and compilers, with built-in source-map… [more](https://github.com/here-be/snapdragon) | [homepage](https://github.com/here-be/snapdragon "Easy-to-use plugin system for creating powerful, fast and versatile parsers and compilers, with built-in source-map support.")
### Author
**Jon Schlinkert**
* [LinkedIn Profile](https://linkedin.com/in/jonschlinkert)
* [GitHub Profile](https://github.com/jonschlinkert)
* [Twitter Profile](https://twitter.com/jonschlinkert)
### License
Copyright © 2018, [Jon Schlinkert](https://github.com/jonschlinkert).
Released under the [MIT License](LICENSE).
***
_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on April 26, 2018._