Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/here-be/snapdragon-bracket
Plugin that adds a `.captureSet()` method to snapdragon, for matching and capturing substrings that have an `open` and `close`, like braces, brackets, etc
https://github.com/here-be/snapdragon-bracket
ast brackets capture compiler javascript node nodejs parser plugin regex snapdragon snapdragon-plugin
Last synced: about 2 months ago
JSON representation
Plugin that adds a `.captureSet()` method to snapdragon, for matching and capturing substrings that have an `open` and `close`, like braces, brackets, etc
- Host: GitHub
- URL: https://github.com/here-be/snapdragon-bracket
- Owner: here-be
- License: mit
- Created: 2017-01-21T10:18:05.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2017-01-21T10:21:15.000Z (almost 8 years ago)
- Last Synced: 2024-11-08T11:56:05.739Z (2 months ago)
- Topics: ast, brackets, capture, compiler, javascript, node, nodejs, parser, plugin, regex, snapdragon, snapdragon-plugin
- Language: JavaScript
- Size: 10.7 KB
- Stars: 2
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: .github/contributing.md
- License: LICENSE
Awesome Lists containing this project
README
# snapdragon-capture-set [](https://www.npmjs.com/package/snapdragon-capture-set) [](https://npmjs.org/package/snapdragon-capture-set) [](https://npmjs.org/package/snapdragon-capture-set) [](https://travis-ci.org/jonschlinkert/snapdragon-capture-set)
> Plugin that adds a `.captureSet()` method to snapdragon, for matching and capturing substrings that have an `open` and `close`, like braces, brackets, etc
Table of Contents
- [Install](#install)
- [Usage](#usage)
- [API](#api)
- [About](#about)
## Install
Install with [npm](https://www.npmjs.com/):
```sh
$ npm install --save snapdragon-capture-set
```
## Usage
```js
var Snapdragon = require('snapdragon');
var captureSet = require('snapdragon-capture-set');
var parser = new Snapdragon.Parser()
.use(captureSet())
.captureSet('brace', /^\{/, /^\}/)
.set('text', function() {
var pos = this.position();
var m = this.match(/^[^{}]/);
if (!m) return;
return pos({
type: 'text',
val: m[0]
});
});
var ast = parser.parse('a{b,{c,d},e}f');
console.log(ast.nodes[2]);
// Node {
// type: 'brace',
// nodes:
// [ Node { type: 'brace.open', val: '{', position: [Object] },
// Node { type: 'text', val: 'b', position: [Object] },
// Node { type: 'text', val: ',', position: [Object] },
// Node { type: 'brace', nodes: [Object], position: [Object] },
// Node { type: 'text', val: ',', position: [Object] },
// Node { type: 'text', val: 'e', position: [Object] },
// Node { type: 'brace.close', val: '}', position: [Object] } ],
// position: Position { start: { line: 1, column: 2 }, end: { line: 1, column: 3 } } }
```
## API
**Example**
```js
var Snapdragon = require('snapdragon');
var captureSet = require('snapdragon-capture-set');
// snapdragon
var snapdragon = new Snapdragon();
snapdragon.use(captureSet());
// parser
snapdragon.parser.use(captureSet());
```
### [captureSet](index.js#L52)
Create a node of the given `type` using the specified regex or function.
**Params**
* `type` **{String}**
* `regex` **{RegExp|Function}**: Pass the regex to use for capturing the `open` and `close` nodes.
* `returns` **{Object}**: Returns the parser instance for chaining
**Example**
```js
parser.captureSet('brace', /^\{/, /^\}/);
```
## About
### Related projects
* [snapdragon-capture](https://www.npmjs.com/package/snapdragon-capture): Snapdragon plugin that adds a capture method to the parser instance. | [homepage](https://github.com/jonschlinkert/snapdragon-capture "Snapdragon plugin that adds a capture method to the parser instance.")
* [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/jonschlinkert/snapdragon-util "Utilities for the snapdragon parser/compiler.")
### 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.
### Building docs
_(This document was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme) (a [verb](https://github.com/verbose/verb) generator), please don't edit the readme directly. Any changes to the readme must be made in [.verb.md](.verb.md).)_
To generate the readme and API documentation with [verb](https://github.com/verbose/verb):
```sh
$ npm install -g verb verb-generate-readme && verb
```
### Running tests
Install dev dependencies:
```sh
$ npm install -d && npm test
```
### Author
**Jon Schlinkert**
* [github/jonschlinkert](https://github.com/jonschlinkert)
* [twitter/jonschlinkert](https://twitter.com/jonschlinkert)
### License
Copyright © 2017, [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.4.1, on January 21, 2017._