snapdragon-cheerio

Snapdragon plugin for converting a cheerio AST to a snapdragon AST.

Install

Install with npm:

$ npm install --save snapdragon-cheerio

Usage

Use the .parse method directly to return an AST:

var snapdragonCheerio = require('snapdragon-cheerio');
var ast = snapdragonCheerio.parse('<strong>It worked!</strong>');
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's .use method to use as a plugin:

var snapdragonCheerio = require('snapdragon-cheerio');
var Snapdragon = require('snapdragon');
var snapdragon = new Snapdragon();
snapdragon.use(snapdragonCheerio());

var ast = snapdragon.parse('<strong>It worked!</strong>');
// 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 to learn how to compile the generated AST into a string.

About

Related projects

cheerio: Tiny, fast, and elegant implementation of core jQuery designed specifically for the server | homepage
snapdragon-capture-set: Plugin that adds a .captureSet() method to snapdragon, for matching and capturing substrings that have… more | homepage
snapdragon-capture: Snapdragon plugin that adds a capture method to the parser instance. | homepage
snapdragon-node: Snapdragon utility for creating a new AST node in custom code, such as plugins. | homepage
snapdragon-util: Utilities for the snapdragon parser/compiler. | homepage
snapdragon: Easy-to-use plugin system for creating powerful, fast and versatile parsers and compilers, with built-in source-map… more | homepage

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Please read the contributing guide for advice on opening issues, pull requests, and coding standards.

Building docs

(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)

To generate the readme, run the following command:

$ 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:

$ npm install && npm test

Author

Jon Schlinkert

License

This file was generated by verb-generate-readme, v0.4.2, on February 15, 2017.

here-be / snapdragon-cheerio Goto Github PK