remark-retext

remark-retext

remark plugin to bridge or mutate to retext.

Note!

This plugin is ready for the new parser in remark (remarkjs/remark#536). No change is needed: it works exactly the same now as it did previously!

Install

This package is ESM only: Node 12+ is needed to use it and it must be imported instead of required.

npm:

npm install remark-retext

Use

Say we have the following file, example.md:

## Hello guys!

And our script, example.js, looks as follows:

import {readSync} from 'to-vfile'
import {reporter} from 'vfile-reporter'
import {unified} from 'unified'
import remarkParse from 'remark-parse'
import remarkStringify from 'remark-stringify'
import remarkRetext from 'remark-retext'
import retextEnglish from 'retext-english'
import retextEquality from 'retext-equality'

const file = readSync('example.md')

unified()
  .use(remarkParse)
  .use(remarkRetext, unified().use(retextEnglish).use(retextEquality))
  .use(remarkStringify)
  .process(file)
  .then((file) => {
    console.error(reporter(file))
  })

Now, running node example yields:

example.md
  1:10-1:14  warning  `guys` may be insensitive, use `people`, `persons`, `folks` instead  gals-man  retext-equality

⚠ 1 warning

API

This package exports no identifiers. The default export is remarkRetext.

unified().use(remarkRetext, destination[, options])

remark (mdast) plugin to bridge or mutate to retext (nlcst).

destination

destination is either a parser or a processor.

If a Unified processor is given, runs the destination processor with the new nlcst tree, then, after running discards that tree and continues on running the origin processor with the original tree (bridge mode).

If a parser (such as parse-latin, parse-english, or parse-dutch) is given, passes the tree to further plugins (mutate mode).

options

Passed to mdast-util-to-nlcst.

Security

Use of remark-retext does not involve rehype (hast) or user content so there are no openings for cross-site scripting (XSS) attacks.

Related

• rehype-retext — Transform HTML (hast) to natural language (nlcst)
• remark-rehype — Transform Markdown (mdast) to HTML (hast)
• rehype-remark — Transform HTML (hast) to Markdown (mdast)
• mdast-util-to-nlcst — Underlying algorithm

Contribute

See contributing.md in remarkjs/.github for ways to get started. See support.md for ways to get help.

This project has a code of conduct. By interacting with this repository, organization, or community you agree to abide by its terms.

License

MIT © Titus Wormer