{"id":20348973,"url":"https://github.com/here-be/snapdragon-bracket","last_synced_at":"2026-05-07T21:44:42.678Z","repository":{"id":57364564,"uuid":"79638655","full_name":"here-be/snapdragon-bracket","owner":"here-be","description":"Plugin that adds a `.captureSet()` method to snapdragon, for matching and capturing substrings that have an `open` and `close`, like braces, brackets, etc","archived":false,"fork":false,"pushed_at":"2017-01-21T10:21:15.000Z","size":11,"stargazers_count":2,"open_issues_count":0,"forks_count":1,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-02-12T02:42:33.031Z","etag":null,"topics":["ast","brackets","capture","compiler","javascript","node","nodejs","parser","plugin","regex","snapdragon","snapdragon-plugin"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/here-be.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":".github/contributing.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-01-21T10:18:05.000Z","updated_at":"2017-11-30T14:08:30.000Z","dependencies_parsed_at":"2022-09-13T21:01:08.081Z","dependency_job_id":null,"html_url":"https://github.com/here-be/snapdragon-bracket","commit_stats":null,"previous_names":["jonschlinkert/snapdragon-capture-set"],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/here-be%2Fsnapdragon-bracket","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/here-be%2Fsnapdragon-bracket/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/here-be%2Fsnapdragon-bracket/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/here-be%2Fsnapdragon-bracket/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/here-be","download_url":"https://codeload.github.com/here-be/snapdragon-bracket/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241877712,"owners_count":20035482,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ast","brackets","capture","compiler","javascript","node","nodejs","parser","plugin","regex","snapdragon","snapdragon-plugin"],"created_at":"2024-11-14T22:23:29.145Z","updated_at":"2026-05-07T21:44:42.623Z","avatar_url":"https://github.com/here-be.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 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\u0026label=Travis)](https://travis-ci.org/jonschlinkert/snapdragon-capture-set)\n\n\u003e Plugin that adds a `.captureSet()` method to snapdragon, for matching and capturing substrings that have an `open` and `close`, like braces, brackets, etc\n\n\u003cdetails\u003e\n\u003csummary\u003e\u003cstrong\u003eTable of Contents\u003c/strong\u003e\u003c/summary\u003e\n- [Install](#install)\n- [Usage](#usage)\n- [API](#api)\n- [About](#about)\n\u003c/details\u003e\n\n## Install\n\nInstall with [npm](https://www.npmjs.com/):\n\n```sh\n$ npm install --save snapdragon-capture-set\n```\n\n## Usage\n\n```js\nvar Snapdragon = require('snapdragon');\nvar captureSet = require('snapdragon-capture-set');\nvar parser = new Snapdragon.Parser()\n  .use(captureSet())\n  .captureSet('brace', /^\\{/, /^\\}/) \n  .set('text', function() {\n    var pos = this.position();\n    var m = this.match(/^[^{}]/);\n    if (!m) return;\n    return pos({\n      type: 'text',\n      val: m[0]\n    });\n  });\n\nvar ast = parser.parse('a{b,{c,d},e}f');\nconsole.log(ast.nodes[2]);\n// Node {\n//   type: 'brace',\n//   nodes:\n//    [ Node { type: 'brace.open', val: '{', position: [Object] },\n//      Node { type: 'text', val: 'b', position: [Object] },\n//      Node { type: 'text', val: ',', position: [Object] },\n//      Node { type: 'brace', nodes: [Object], position: [Object] },\n//      Node { type: 'text', val: ',', position: [Object] },\n//      Node { type: 'text', val: 'e', position: [Object] },\n//      Node { type: 'brace.close', val: '}', position: [Object] } ],\n//   position: Position { start: { line: 1, column: 2 }, end: { line: 1, column: 3 } } }\n```\n\n## API\n\n**Example**\n\n```js\nvar Snapdragon = require('snapdragon');\nvar captureSet = require('snapdragon-capture-set');\n\n// snapdragon\nvar snapdragon = new Snapdragon();\nsnapdragon.use(captureSet());\n\n// parser\nsnapdragon.parser.use(captureSet());\n```\n\n### [captureSet](index.js#L52)\n\nCreate a node of the given `type` using the specified regex or function.\n\n**Params**\n\n* `type` **{String}**\n* `regex` **{RegExp|Function}**: Pass the regex to use for capturing the `open` and `close` nodes.\n* `returns` **{Object}**: Returns the parser instance for chaining\n\n**Example**\n\n```js\nparser.captureSet('brace', /^\\{/, /^\\}/);\n```\n\n## About\n\n### Related projects\n\n* [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.\")\n* [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.\")\n* [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.\")\n\n### Contributing\n\nPull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).\n\nPlease read the [contributing guide](.github/contributing.md) for advice on opening issues, pull requests, and coding standards.\n\n### Building docs\n\n_(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).)_\n\nTo generate the readme and API documentation with [verb](https://github.com/verbose/verb):\n\n```sh\n$ npm install -g verb verb-generate-readme \u0026\u0026 verb\n```\n\n### Running tests\n\nInstall dev dependencies:\n\n```sh\n$ npm install -d \u0026\u0026 npm test\n```\n\n### Author\n\n**Jon Schlinkert**\n\n* [github/jonschlinkert](https://github.com/jonschlinkert)\n* [twitter/jonschlinkert](https://twitter.com/jonschlinkert)\n\n### License\n\nCopyright © 2017, [Jon Schlinkert](https://github.com/jonschlinkert).\nReleased under the [MIT license](LICENSE).\n\n***\n\n_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.4.1, on January 21, 2017._","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhere-be%2Fsnapdragon-bracket","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhere-be%2Fsnapdragon-bracket","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhere-be%2Fsnapdragon-bracket/lists"}