# commonmark-helpers

> Helper methods for commonmark

Latest version **0.4.1** (published 2015-08-08) · MIT license · 0 weekly downloads

## Install

```sh
npm install commonmark-helpers
pnpm add commonmark-helpers
yarn add commonmark-helpers
bun add commonmark-helpers
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.4.1 |
| Published | 2015-08-08 |
| First published | 2015-05-10 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 9 |
| Author | Vladimir Starkov |
| Maintainers | iamstarkov |
| Keywords | markdown, md, commonmark |

## Links

- npm: https://www.npmjs.com/package/commonmark-helpers
- Repository: https://github.com/iamstarkov/commonmark-helpers
- Homepage: https://github.com/iamstarkov/commonmark-helpers#readme
- Issues: https://github.com/iamstarkov/commonmark-helpers/issues
- npm.io page: https://npm.io/package/commonmark-helpers

## Dependencies (2)

- [ramda](https://npm.io/package/ramda.md) ^0.17.1
- [commonmark](https://npm.io/package/commonmark.md) ^0.21.0

## Alternatives

- [@mdxeditor/editor](https://npm.io/package/@mdxeditor/editor.md) — 962.4K weekly downloads
- [mmdb-lib](https://npm.io/package/mmdb-lib.md) — 680.9K weekly downloads
- [playcanvas](https://npm.io/package/playcanvas.md) — 36.2K weekly downloads
- [@glw907/cairn-cms](https://npm.io/package/@glw907/cairn-cms.md) — 967 weekly downloads
- [markdown-to-confluence](https://npm.io/package/markdown-to-confluence.md) — 103 weekly downloads

## Recent versions

- 0.4.1 (latest) — 2015-08-08
- 0.4.0 — 2015-06-25
- 0.3.0 — 2015-06-15
- 0.2.0 — 2015-06-13
- 0.1.4 — 2015-05-25
- 0.1.3 — 2015-05-25
- 0.1.2 — 2015-05-10
- 0.1.1 — 2015-05-10
- 0.1.0 — 2015-05-10

## README

# 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](https://iamstarkov.com/commonmark-helpers-release/).

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

## Install

```
npm install --save commonmark-helpers
```

## Usage

```js
var md = require('commonmark-helpers');

md.text(md.match('# title\n\ntext', md.isHeader)); // title
md.html(`*italic*`);        // <p><em>italic</em></p>\n
md.text('**`plaintext`**'); // 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).

[tests]: https://github.com/iamstarkov/commonmark-helpers/blob/master/test.js
## API

### html(input)

Return html.

##### input

Type: `string` / `AST`

### text(input)

Return plain text.

##### input

Type: `string` / `AST`

### ast(input)

Return AST tree for current text.

##### input

Type: `string`

### match(input, matcher)

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.

### matchRemove(input, matcher)

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.

### matchRemoveList(input, matcher1, [matcher2, […, matcherN]])

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.

### matchProcess(input, processor)

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.

### matchProcessList(input, processor1, [processor2, […, processorN]])

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.

### Bunch of shortcut helpers

```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);
```

## License

MIT © [Vladimir Starkov](https://iamstarkov.com/)

[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

---
_Source: https://npm.io/package/commonmark-helpers · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._