remark plugin to support retext.
Contents
What is this?
This package is a unified (remark) plugin to support retext.
When should I use this?
This project is useful if you want to check natural language in markdown. The retext ecosystem has many useful plugins to check prose, such as retext-indefinite-article which checks that a and an are used correctly, or retext-readability which checks that sentences are not too complex. This plugins lets you use them on markdown documents.
This plugin is not able to apply changes by retext plugins (such as done by retext-smartypants) to the markdown content.
This plugin is built on mdast-util-to-nlcst, which does the work on syntax trees. remark focusses on making it easier to transform content by abstracting such internals away.
Install
This package is ESM only. In Node.js (version 16+), install with npm:
npm install remark-retext
In Deno with esm.sh:
import remarkRetext from 'https://esm.sh/remark-retext@6'
In browsers with esm.sh:
<script type="module">
import remarkRetext from 'https://esm.sh/remark-retext@6?bundle'
</script>
Use
Say we have the following file example.md:
## Hello guys!
…and a module example.js:
import remarkParse from 'remark-parse'
import remarkRetext from 'remark-retext'
import remarkStringify from 'remark-stringify'
import retextEnglish from 'retext-english'
import retextEquality from 'retext-equality'
import {read} from 'to-vfile'
import {unified} from 'unified'
import {reporter} from 'vfile-reporter'
const file = await unified()
.use(remarkParse)
.use(remarkRetext, unified().use(retextEnglish).use(retextEquality))
.use(remarkStringify)
.process(await read('example.md'))
console.error(reporter(file))
…then running node example.js yields:
example.md
1:10-1:14 warning Unexpected potentially insensitive use of `guys`, in somes cases `people`, `persons`, `folks` may be better gals-man retext-equality
⚠ 1 warning
API
This package exports no identifiers. The default export is remarkRetext.
Bridge or mutate to retext.
Parameters
Returns
Transform (Transformer).
Notes
- if a processor is given, uses its parser to create a new nlcst tree, then runs the plugins attached to with that (bridge mode); you can add a parser to processor for example with
parse-english; other plugins used on the processor should be retext plugins - if a parser is given, uses it to create a new nlcst tree, and returns it (mutate mode); you can get a parser by importing
Parser from parse-english for example; other plugins used after remarkRetext should be retext plugins
Options
Configuration (TypeScript type).
Fields
options.ignore (Array<string>, optional) — list of mdast node types to ignore; the types 'table', 'tableRow', and 'tableCell' are always ignoredoptions.source (Array<string>, optional) — list of mdast node types to mark as nlcst source nodes; the type 'inlineCode' is always marked as source
Types
This package is fully typed with TypeScript. It exports the additional type Options.
Compatibility
Projects maintained by the unified collective are compatible with maintained versions of Node.js.
When we cut a new major release, we drop support for unmaintained versions of Node. This means we try to keep the current release line, remark-retext@6, compatible with Node.js 16.
This plugin works with unified version 6+, remark version 3+, and retext version 7+.
Security
Use of remark-retext does not involve rehype (hast) or user content so there are no openings for cross-site scripting (XSS) attacks.
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