Helper methods for commonmark
npm install commonmark-helpers[![NPM version][npm-image]][npm-url]
[![Build Status][travis-image]][travis-url]
[![Coveralls Status][coveralls-image]][coveralls-url]
[![Dependency Status][depstat-image]][depstat-url]
[![DevDependency Status][depstat-dev-image]][depstat-dev-url]
> Even the strongest sometimes need help.
Basically, with commonmark-helpers you can find desire elements in markdown document
and process them in html or plaintext format.
Bunch of helpers for working with [commonmark][commonmark-readme]. Also, you can be interested,
why I created this module, that’s why I wrote a post about reasons.
Very important to notice, that this package is very simple and doesn’t contain
any smart and/or complicated logic, that’s why it’s tightly coupled with
[commonmark API for AST tree][commonmark-readme]. Check it out first.
[commonmark-readme]: https://github.com/jgm/commonmark.js#readme
``
npm install --save commonmark-helpers
`js
var md = require('commonmark-helpers');
md.text(md.match('# title\n\ntext', md.isHeader)); // title italic
md.html(italic); // plaintext
md.text(''); // plaintext
function up(node) {
if (node.literal) {
node.literal = node.literal.toUpperCase();
}
};
md.text(md.matchProcess('# LOOK\n\nMA', up)); // LOOK\n\nMA
`
Look into tests for more examples.
[tests]: https://github.com/iamstarkov/commonmark-helpers/blob/master/test.js
Return html.
##### input
Type: string / AST
Return plain text.
##### input
Type: string / AST
Return AST tree for current text.
##### input
Type: string
Return first AST-node matched my _matcher_ in process of walking through AST-tree. Returns undefined if no one AST-node have been matched.
The most powerful method in this collection.
##### input
Type: string / AST
##### matcher
Type: function. Receive: AST-node, event
In most cases you need only AST-node to match on.
The same as match() but remove first matched AST-node and return AST-tree without it.
##### input
Type: string / AST
##### matcher
Type: function. Receive: AST-node, event
In most cases you need only AST-node to match on.
The same as matchRemove() but resulting AST-tree after matcher1 passing to matcher2, result of this to matcher3 and so on. Return AST-tree without all the matched AST-nodes.
##### input
Type: string / AST
##### matcher1, matcher2, …, matcherN
Type: function. Receive: AST-node, event
In most cases you need only AST-node to match on.
Match and process AST-nodes, return modified AST-tree.
##### input
Type: string / AST
##### processor
Type: function. Receive: AST-node, event
In most cases you need only AST-node to match on and modify.
The same as matchProcess() but resulting AST-tree after processor1 passing to processor2, result of this to processor3 and so on. Return AST-tree is AST-tree with all applied processors.
##### input
Type: string / AST
##### processor1, processor2, …, processorN
Type: function. Receive: AST-node, event
In most cases you need only AST-node to match on and modify.
`js
const isType = (node, type) => node.type === type;
const isLevel = (node, level) => node.level === level;
const isText = node => isType(node, 'Text');
const isEmph = node => isType(node, 'Emph');
const isCode = node => isType(node, 'Code');
const isHtml = node => isType(node, 'Html');
const isLink = node => isType(node, 'Link');
const isItem = node => isType(node, 'Item');
const isList = node => isType(node, 'List');
const isImage = node => isType(node, 'Image');
const isStrong = node => isType(node, 'Strong');
const isHeader = node => isType(node, 'Header');
const isDocument = node => isType(node, 'Document');
const isCodeBlock = node => isType(node, 'CodeBlock');
const isHtmlBlock = node => isType(node, 'HtmlBlock');
const isSoftbreak = node => isType(node, 'Softbreak');
const isHardbreak = node => isType(node, 'Hardbreak');
const isParagraph = node => isType(node, 'Paragraph');
const isBlockQuote = node => isType(node, 'BlockQuote');
const isHorizontalRule = node => isType(node, 'HorizontalRule');
const isRoot = node => node.parent && isDocument(node.parent);
const isBreak = node => isHardbreak(node) || isSoftbreak(node);
``
MIT © Vladimir Starkov
[npm-url]: https://npmjs.org/package/commonmark-helpers
[npm-image]: https://img.shields.io/npm/v/commonmark-helpers.svg?style=flat-square
[travis-url]: https://travis-ci.org/iamstarkov/commonmark-helpers
[travis-image]: https://img.shields.io/travis/iamstarkov/commonmark-helpers.svg?style=flat-square
[coveralls-url]: https://coveralls.io/r/iamstarkov/commonmark-helpers
[coveralls-image]: https://img.shields.io/coveralls/iamstarkov/commonmark-helpers.svg?style=flat-square
[depstat-url]: https://david-dm.org/iamstarkov/commonmark-helpers
[depstat-image]: https://david-dm.org/iamstarkov/commonmark-helpers.svg?style=flat-square
[depstat-dev-url]: https://david-dm.org/iamstarkov/commonmark-helpers
[depstat-dev-image]: https://david-dm.org/iamstarkov/commonmark-helpers/dev-status.svg?style=flat-square