https://github.com/here-be/snapdragon-cheerio
Snapdragon plugin for converting a cheerio AST to a snapdragon AST.
https://github.com/here-be/snapdragon-cheerio
ast cheerio html javascript node nodejs plugin snapdragon snapdragon-plugin
Last synced: 7 months ago
JSON representation
Snapdragon plugin for converting a cheerio AST to a snapdragon AST.
- Host: GitHub
- URL: https://github.com/here-be/snapdragon-cheerio
- Owner: here-be
- License: mit
- Created: 2017-01-21T11:07:01.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2017-02-15T19:27:50.000Z (over 8 years ago)
- Last Synced: 2024-05-09T22:04:16.500Z (over 1 year ago)
- Topics: ast, cheerio, html, javascript, node, nodejs, plugin, snapdragon, snapdragon-plugin
- Language: JavaScript
- Size: 16.6 KB
- Stars: 3
- 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-cheerio [](https://www.npmjs.com/package/snapdragon-cheerio) [](https://npmjs.org/package/snapdragon-cheerio) [](https://npmjs.org/package/snapdragon-cheerio) [](https://travis-ci.org/jonschlinkert/snapdragon-cheerio)
> Snapdragon plugin for converting a cheerio AST to a snapdragon AST.
## Install
Install with [npm](https://www.npmjs.com/):
```sh
$ npm install --save snapdragon-cheerio
```
## Usage
Use the `.parse` method directly to return an AST:
```js
var snapdragonCheerio = require('snapdragon-cheerio');
var ast = snapdragonCheerio.parse('It worked!');
console.log(ast);
// Node {
// type: 'string',
// nodes:
// [ Node { type: 'bos', val: '', index: 0 },
// Node { type: 'strong', attribs: {}, index: 1, nodes: [Object] },
// Node { type: 'eos', val: '', index: 2 } ] }
```
**Snapdragon plugin usage**
Pass to [snapdragon](https://github.com/jonschlinkert/snapdragon)'s `.use` method to use as a plugin:
```js
var snapdragonCheerio = require('snapdragon-cheerio');
var Snapdragon = require('snapdragon');
var snapdragon = new Snapdragon();
snapdragon.use(snapdragonCheerio());
var ast = snapdragon.parse('It worked!');
// Node {
// type: 'string',
// nodes:
// [ Node { type: 'bos', val: '', index: 0 },
// Node { type: 'strong', attribs: {}, index: 1, nodes: [Object] },
// Node { type: 'eos', val: '', index: 2 } ] }
```
Visit [snapdragon](https://github.com/jonschlinkert/snapdragon) to learn how to compile the generated AST into a string.
## About
### Related projects
* [cheerio](https://www.npmjs.com/package/cheerio): Tiny, fast, and elegant implementation of core jQuery designed specifically for the server | [homepage](https://github.com/cheeriojs/cheerio#readme "Tiny, fast, and elegant implementation of core jQuery designed specifically for the server")
* [snapdragon-capture-set](https://www.npmjs.com/package/snapdragon-capture-set): Plugin that adds a `.captureSet()` method to snapdragon, for matching and capturing substrings that have… [more](https://github.com/jonschlinkert/snapdragon-capture-set) | [homepage](https://github.com/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")
* [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.")
* [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/jonschlinkert/snapdragon) | [homepage](https://github.com/jonschlinkert/snapdragon "Easy-to-use plugin system for creating powerful, fast and versatile parsers and compilers, with built-in source-map support.")
### 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 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
```
### 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
```
### Author
**Jon Schlinkert**
* [github/jonschlinkert](https://github.com/jonschlinkert)
* [twitter/jonschlinkert](https://twitter.com/jonschlinkert)
### License
Copyright © 2017, [Jon Schlinkert](https://github.com/jonschlinkert).
MIT
***
_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.4.2, on February 15, 2017._