pax_global_header00006660000000000000000000000064130406330200014501gustar00rootroot0000000000000052 comment=e1f7c2f34f422934bdb6f9813af7593266ba79d2 snapdragon-bracket-1.0.1/000077500000000000000000000000001304063302000152455ustar00rootroot00000000000000snapdragon-bracket-1.0.1/.editorconfig000066400000000000000000000004051304063302000177210ustar00rootroot00000000000000root = true [*] indent_style = space end_of_line = lf charset = utf-8 indent_size = 2 trim_trailing_whitespace = true insert_final_newline = true [{**/{actual,fixtures,expected,templates}/**,*.md}] trim_trailing_whitespace = false insert_final_newline = falsesnapdragon-bracket-1.0.1/.eslintrc.json000066400000000000000000000071251304063302000200460ustar00rootroot00000000000000{ "ecmaFeatures": { "modules": true, "experimentalObjectRestSpread": true }, "env": { "browser": false, "es6": true, "node": true, "mocha": true }, "globals": { "document": false, "navigator": false, "window": false }, "rules": { "accessor-pairs": 2, "arrow-spacing": [2, { "before": true, "after": true }], "block-spacing": [2, "always"], "brace-style": [2, "1tbs", { "allowSingleLine": true }], "comma-dangle": [2, "never"], "comma-spacing": [2, { "before": false, "after": true }], "comma-style": [2, "last"], "constructor-super": 2, "curly": [2, "multi-line"], "dot-location": [2, "property"], "eol-last": 2, "eqeqeq": [2, "allow-null"], "generator-star-spacing": [2, { "before": true, "after": true }], "handle-callback-err": [2, "^(err|error)$" ], "indent": [2, 2, { "SwitchCase": 1 }], "key-spacing": [2, { "beforeColon": false, "afterColon": true }], "keyword-spacing": [2, { "before": true, "after": true }], "new-cap": [2, { "newIsCap": true, "capIsNew": false }], "new-parens": 2, "no-array-constructor": 2, "no-caller": 2, "no-class-assign": 2, "no-cond-assign": 2, "no-const-assign": 2, "no-control-regex": 2, "no-debugger": 2, "no-delete-var": 2, "no-dupe-args": 2, "no-dupe-class-members": 2, "no-dupe-keys": 2, "no-duplicate-case": 2, "no-empty-character-class": 2, "no-eval": 2, "no-ex-assign": 2, "no-extend-native": 2, "no-extra-bind": 2, "no-extra-boolean-cast": 2, "no-extra-parens": [2, "functions"], "no-fallthrough": 2, "no-floating-decimal": 2, "no-func-assign": 2, "no-implied-eval": 2, "no-inner-declarations": [2, "functions"], "no-invalid-regexp": 2, "no-irregular-whitespace": 2, "no-iterator": 2, "no-label-var": 2, "no-labels": 2, "no-lone-blocks": 2, "no-mixed-spaces-and-tabs": 2, "no-multi-spaces": 2, "no-multi-str": 2, "no-multiple-empty-lines": [2, { "max": 1 }], "no-native-reassign": 0, "no-negated-in-lhs": 2, "no-new": 2, "no-new-func": 2, "no-new-object": 2, "no-new-require": 2, "no-new-wrappers": 2, "no-obj-calls": 2, "no-octal": 2, "no-octal-escape": 2, "no-proto": 0, "no-redeclare": 2, "no-regex-spaces": 2, "no-return-assign": 2, "no-self-compare": 2, "no-sequences": 2, "no-shadow-restricted-names": 2, "no-spaced-func": 2, "no-sparse-arrays": 2, "no-this-before-super": 2, "no-throw-literal": 2, "no-trailing-spaces": 0, "no-undef": 2, "no-undef-init": 2, "no-unexpected-multiline": 2, "no-unneeded-ternary": [2, { "defaultAssignment": false }], "no-unreachable": 2, "no-unused-vars": [2, { "vars": "all", "args": "none" }], "no-useless-call": 0, "no-with": 2, "one-var": [0, { "initialized": "never" }], "operator-linebreak": [0, "after", { "overrides": { "?": "before", ":": "before" } }], "padded-blocks": [0, "never"], "quotes": [2, "single", "avoid-escape"], "radix": 2, "semi": [2, "always"], "semi-spacing": [2, { "before": false, "after": true }], "space-before-blocks": [2, "always"], "space-before-function-paren": [2, "never"], "space-in-parens": [2, "never"], "space-infix-ops": 2, "space-unary-ops": [2, { "words": true, "nonwords": false }], "spaced-comment": [0, "always", { "markers": ["global", "globals", "eslint", "eslint-disable", "*package", "!", ","] }], "use-isnan": 2, "valid-typeof": 2, "wrap-iife": [2, "any"], "yoda": [2, "never"] } } snapdragon-bracket-1.0.1/.gitattributes000066400000000000000000000002001304063302000201300ustar00rootroot00000000000000# Enforce Unix newlines * text eol=lf # binaries *.ai binary *.psd binary *.jpg binary *.gif binary *.png binary *.jpeg binary snapdragon-bracket-1.0.1/.github/000077500000000000000000000000001304063302000166055ustar00rootroot00000000000000snapdragon-bracket-1.0.1/.github/contributing.md000066400000000000000000000064311304063302000216420ustar00rootroot00000000000000# Contributing to snapdragon-capture-set First and foremost, thank you! We appreciate that you want to contribute to snapdragon-capture-set, your time is valuable, and your contributions mean a lot to us. **What does "contributing" mean?** Creating an issue is the simplest form of contributing to a project. But there are many ways to contribute, including the following: - Updating or correcting documentation - Feature requests - Bug reports If you'd like to learn more about contributing in general, the [Guide to Idiomatic Contributing](https://github.com/jonschlinkert/idiomatic-contributing) has a lot of useful information. **Showing support for snapdragon-capture-set** Please keep in mind that open source software is built by people like you, who spend their free time creating things the rest the community can use. Don't have time to contribute? No worries, here are some other ways to show your support for snapdragon-capture-set: - star the [project](https://github.com/jonschlinkert/snapdragon-capture-set) - tweet your support for snapdragon-capture-set ## Issues ### Before creating an issue Please try to determine if the issue is caused by an underlying library, and if so, create the issue there. Sometimes this is difficult to know. We only ask that you attempt to give a reasonable attempt to find out. Oftentimes the readme will have advice about where to go to create issues. Try to follow these guidelines - **Investigate the issue**: - **Check the readme** - oftentimes you will find notes about creating issues, and where to go depending on the type of issue. - Create the issue in the appropriate repository. ### Creating an issue Please be as descriptive as possible when creating an issue. Give us the information we need to successfully answer your question or address your issue by answering the following in your issue: - **version**: please note the version of snapdragon-capture-set are you using - **extensions, plugins, helpers, etc** (if applicable): please list any extensions you're using - **error messages**: please paste any error messages into the issue, or a [gist](https://gist.github.com/) ## Above and beyond Here are some tips for creating idiomatic issues. Taking just a little bit extra time will make your issue easier to read, easier to resolve, more likely to be found by others who have the same or similar issue in the future. - read the [Guide to Idiomatic Contributing](https://github.com/jonschlinkert/idiomatic-contributing) - take some time to learn basic markdown. This [markdown cheatsheet](https://gist.github.com/jonschlinkert/5854601) is super helpful, as is the GitHub guide to [basic markdown](https://help.github.com/articles/markdown-basics/). - Learn about [GitHub Flavored Markdown](https://help.github.com/articles/github-flavored-markdown/). And if you want to really go above and beyond, read [mastering markdown](https://guides.github.com/features/mastering-markdown/). - use backticks to wrap code. This ensures that code will retain its format, making it much more readable to others - use syntax highlighting by adding the correct language name after the first "code fence" [node-glob]: https://github.com/isaacs/node-glob [micromatch]: https://github.com/jonschlinkert/micromatch [so]: http://stackoverflow.com/questions/tagged/snapdragon-capture-setsnapdragon-bracket-1.0.1/.gitignore000066400000000000000000000004171304063302000172370ustar00rootroot00000000000000# always ignore files *.DS_Store *.sublime-* # test related, or directories generated by tests test/actual actual coverage .nyc* # npm node_modules npm-debug.log # yarn yarn.lock yarn-error.log # misc _gh_pages _draft _drafts bower_components vendor temp tmp TODO.md snapdragon-bracket-1.0.1/.travis.yml000066400000000000000000000002571304063302000173620ustar00rootroot00000000000000sudo: false os: - linux - osx language: node_js node_js: - node - '6' - '4' matrix: allow_failures: - node_js: '4' - node_js: '0.12' - node_js: '0.10' snapdragon-bracket-1.0.1/.verb.md000066400000000000000000000020611304063302000166020ustar00rootroot00000000000000## 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 {%= apidocs("index.js") %} snapdragon-bracket-1.0.1/LICENSE000066400000000000000000000020711304063302000162520ustar00rootroot00000000000000The MIT License (MIT) Copyright (c) 2017 Jon Schlinkert Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. snapdragon-bracket-1.0.1/README.md000066400000000000000000000112261304063302000165260ustar00rootroot00000000000000# snapdragon-capture-set [![NPM version](https://img.shields.io/npm/v/snapdragon-capture-set.svg?style=flat)](https://www.npmjs.com/package/snapdragon-capture-set) [![NPM monthly downloads](https://img.shields.io/npm/dm/snapdragon-capture-set.svg?style=flat)](https://npmjs.org/package/snapdragon-capture-set) [![NPM total downloads](https://img.shields.io/npm/dt/snapdragon-capture-set.svg?style=flat)](https://npmjs.org/package/snapdragon-capture-set) [![Linux Build Status](https://img.shields.io/travis/jonschlinkert/snapdragon-capture-set.svg?style=flat&label=Travis)](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._snapdragon-bracket-1.0.1/index.js000066400000000000000000000102731304063302000167150ustar00rootroot00000000000000'use strict'; var Node = require('snapdragon-node'); var extend = require('extend-shallow'); /** * Register the plugin with `snapdragon.use()` or `snapdragon.parser.use()`. * * ```js * var Snapdragon = require('snapdragon'); * var captureSet = require('snapdragon-capture-set'); * * // snapdragon * var snapdragon = new Snapdragon(); * snapdragon.use(captureSet()); * * // parser * snapdragon.parser.use(captureSet()); * ``` * @api public */ module.exports = function(options) { return function(snapdragon) { if (snapdragon.isSnapdragon) { snapdragon.parser.use(captureSet(options)); snapdragon.define('captureSet', function() { return this.parser.captureSet.apply(this.parser, arguments); }); } else if (snapdragon.isParser) { snapdragon.use(captureSet(options)); } else { throw new Error('expected an instance of snapdragon or snapdragon.parser'); } }; }; /** * Create a node of the given `type` using the specified regex or function. * * ```js * parser.captureSet('brace', /^\{/, /^\}/); * ``` * @param {String} `type` * @param {RegExp|Function} `regex` Pass the regex to use for capturing the `open` and `close` nodes. * @return {Object} Returns the parser instance for chaining * @api public */ function captureSet(options) { return function(parser) { parser.define('captureOpen', function(type, regex, fn) { this.sets[type] = this.sets[type] || []; // noop, we really only need the `.open` and `.close` visitors this.set(type, function() {}); // create the `open` visitor for "type" this.set(type + '.open', function() { var pos = this.position(); var match = this.match(regex); if (!match || !match[0]) return; this.setCount++; // get the last node, either from `this.stack` or `this.ast.nodes`, // so we can push our "parent" node onto the `nodes` array of // that node. We don't want to just push it onto the ast, because // we need to easily be able to pop it off of a stack when we // get the "close" node var prev = this.prev(); // create the "parent" node (ex: "brace") var parent = pos(new Node({ type: type, nodes: [] })); // create the "open" node (ex: "brace.open") var open = pos(new Node({ type: type + '.open', val: match[0] })); // push "open" node onto `parent.nodes`, and create // a reference to parent on `open.parent` parent.pushNode(open); // add a non-enumerable reference to the "match" arguments open.define('match', match); parent.define('match', match); if (typeof fn === 'function') { fn.call(this, open, parent); } this.push(type, parent); prev.pushNode(parent); }); return this; }); parser.define('captureClose', function(type, regex, fn) { if (typeof this.sets[type] === 'undefined') { throw new Error('an `.open` type is not registered for ' + type); } var opts = extend({}, this.options, options); // create the `close` visitor for "type" this.set(type + '.close', function() { var pos = this.position(); var match = this.match(regex); if (!match || !match[0]) return; var parent = this.pop(type); var close = pos(new Node({ type: type + '.close', val: match[0] })); if (!this.isType(parent, type)) { if (opts.strict) { throw new Error('missing opening "' + type + '"'); } this.setCount--; close.define('escaped', true); return close; } if (close.suffix === '\\') { parent.define('escaped', true); close.define('escaped', true); } parent.pushNode(close); }); return this; }); /** * Create a parser with open and close for parens, * brackets or braces */ parser.define('captureSet', function(type, openRegex, closeRegex, fn) { this.captureOpen(type, openRegex, fn); this.captureClose(type, closeRegex, fn); return this; }); }; } snapdragon-bracket-1.0.1/package.json000066400000000000000000000026641304063302000175430ustar00rootroot00000000000000{ "name": "snapdragon-capture-set", "description": "Plugin that adds a `.captureSet()` method to snapdragon, for matching and capturing substrings that have an `open` and `close`, like braces, brackets, etc", "version": "1.0.1", "homepage": "https://github.com/jonschlinkert/snapdragon-capture-set", "author": "Jon Schlinkert (https://github.com/jonschlinkert)", "repository": "jonschlinkert/snapdragon-capture-set", "bugs": { "url": "https://github.com/jonschlinkert/snapdragon-capture-set/issues" }, "license": "MIT", "files": [ "index.js" ], "main": "index.js", "engines": { "node": ">=4" }, "scripts": { "test": "mocha" }, "dependencies": { "extend-shallow": "^2.0.1", "snapdragon-node": "^1.0.0" }, "devDependencies": { "gulp-format-md": "^0.1.11", "mocha": "^3.2.0", "snapdragon": "^0.9.0", "snapdragon-util": "^1.0.1" }, "keywords": [ "capture", "match", "parse", "parser", "plugin", "set", "snapdragon", "snapdragonplugin", "visitor" ], "verb": { "toc": "collapsible", "layout": "default", "tasks": [ "readme" ], "plugins": [ "gulp-format-md" ], "related": { "list": [ "snapdragon-capture", "snapdragon-node", "snapdragon-util" ] }, "reflinks": [ "verb", "verb-generate-readme" ], "lint": { "reflinks": true } } } snapdragon-bracket-1.0.1/test/000077500000000000000000000000001304063302000162245ustar00rootroot00000000000000snapdragon-bracket-1.0.1/test/test.js000066400000000000000000000015101304063302000175360ustar00rootroot00000000000000'use strict'; require('mocha'); var assert = require('assert'); var utils = require('snapdragon-util'); var Parser = require('snapdragon/lib/parser'); var captureSet = require('..'); var parser; describe('parser', function() { beforeEach(function() { parser = new Parser(); parser.use(captureSet()); }); it('should register open and close functions', function() { parser.captureSet('brace', /^\{/, /^\}/); parser.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'); assert(utils.hasType(ast, 'brace')); assert(utils.hasType(ast.nodes[2], 'brace.open')); assert(utils.hasType(ast.nodes[2], 'brace.close')); }); });