rehype-retext

[![Build][badge-build-image]][badge-build-url]
[![Coverage][badge-coverage-image]][badge-coverage-url]
[![Downloads][badge-downloads-image]][badge-downloads-url]
[![Size][badge-size-image]][badge-size-url]

[rehype][github-rehype] plugin to support [retext][github-retext].

Contents

* What is this?
* When should I use this?
* Install
* Use
* API
* unified().use(rehypeRetext, options)
* Types
* Compatibility
* Security
* Related
* Contribute
* License

What is this?

This package is a [unified][github-unified] ([rehype][github-rehype])
plugin to support [retext][github-retext].

unified is a project that transforms content with abstract syntax trees
(ASTs).
rehype adds support for HTML to unified.
retext adds support for natural language to unified.
hast is the HTML AST that rehype uses.
nlcst is the natural language AST that retext uses.
This is a rehype plugin that transforms hast into nlcst to support retext.

When should I use this?

This project is useful if you want to check natural language in HTML.
The retext ecosystem has many useful plugins to check prose,
such as
[retext-indefinite-article][github-retext-indefinite-article]
which checks that a and an are used correctly,
or [retext-readability][github-retext-readability] which
checks that sentences are not too complex.
This plugins lets you use them on HTML documents.

This plugin is not able to apply changes by retext plugins (such
as done by retext-smartypants) to the HTML content.

This plugin is built on [hast-util-to-nlcst][github-hast-util-to-nlcst],
which does the work on syntax trees.
rehype focusses on making it easier to transform content by abstracting such
internals away.

Install

This package is [ESM only][github-gist-esm].
In Node.js (version 16+),
install with [npm][npmjs-install]:

``sh
npm install rehype-retext
`

In Deno with [esm.sh][esmsh]:

`js
import rehypeRetext from 'https://esm.sh/rehype-retext@5'
`

In browsers with [esm.sh][esmsh]:

`html

`

Use

Say we have the following file example.html:

`html





A implicit sentence.

This and and that.


`

…and our module example.js looks as follows:

`js
import rehypeParse from 'rehype-parse'
import rehypePresetMinify from 'rehype-preset-minify'
import rehypeRetext from 'rehype-retext'
import rehypeStringify from 'rehype-stringify'
import retextEnglish from 'retext-english'
import retextIndefiniteArticle from 'retext-indefinite-article'
import retextRepeatedWords from 'retext-repeated-words'
import {read} from 'to-vfile'
import {unified} from 'unified'
import {reporter} from 'vfile-reporter'

const file = await unified()
.use(rehypeParse)
.use(
rehypeRetext,
unified()
.use(retextEnglish)
.use(retextIndefiniteArticle)
.use(retextRepeatedWords)
)
.use(rehypePresetMinify)
.use(rehypeStringify)
.process(await read('example.html'))

console.error(reporter([file]))
console.log(String(file))
`

…then running node example.js yields:

`html
example.html
5:3-5:4 warning Unexpected article A before implicit, expected An retext-indefinite-article retext-indefinite-article
6:12-6:19 warning Unexpected repeated and, remove one occurrence and retext-repeated-words

⚠ 2 warnings
`

`html


A implicit sentence.

This and and that.


`

API

This package exports no identifiers.
The default export is [rehypeRetext][api-rehype-retext].

$3

Bridge or mutate to retext.

###### Parameters

* options
([Parser][github-unified-parser] or
[Processor][github-unified-processor])
— configuration (required)

###### Returns

Transform ([Transformer][github-unified-transformer]).

###### Notes

* if a [processor][github-unified-processor] is given,
uses its parser to create a new nlcst tree,
then runs the plugins attached to with that
([bridge mode][github-unified-mode]);
you can add a parser to processor for example with retext-english;
other plugins used on the processor should be retext plugins
* if a [parser][github-unified-parser] is given,
uses it to create a new nlcst tree,
and returns it
([mutate mode][github-unified-mode]);
you can get a parser by importing Parser from parse-english for example;
other plugins used after rehypeRetext should be retext plugins

Types

This package is fully typed with [TypeScript][].
It exports no additional types.

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,
rehype-retext@5,
compatible with Node.js 16.

This plugin works with unified version 6+,
rehype version 4+,
and retext version 7+.

Security

rehype-retext does not change the syntax tree so there are no openings for
[cross-site scripting (XSS)][wikipedia-xss] attacks.

Related

* rehype-remark
— rehype plugin to turn HTML into markdown
* remark-retext
— remark plugin to support retext
* remark-rehype
— remark plugin to turn markdown into HTML

Contribute

See [contributing.md][health-contributing] in [rehypejs/.github][health]
for ways to get started.
See [support.md`][health-support] for ways to get help.

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

License

[MIT][file-license] © [Titus Wormer][wooorm]

[api-rehype-retext]: #unifieduserehyperetext-options

[badge-build-image]: https://github.com/rehypejs/rehype-retext/workflows/main/badge.svg

[badge-build-url]: https://github.com/rehypejs/rehype-retext/actions

[badge-coverage-image]: https://img.shields.io/codecov/c/github/rehypejs/rehype-retext.svg

[badge-coverage-url]: https://codecov.io/github/rehypejs/rehype-retext

[badge-downloads-image]: https://img.shields.io/npm/dm/rehype-retext.svg

[badge-downloads-url]: https://www.npmjs.com/package/rehype-retext

[badge-size-image]: https://img.shields.io/bundlejs/size/rehype-retext

[badge-size-url]: https://bundlejs.com/?q=rehype-retext

[esmsh]: https://esm.sh

[file-license]: license

[github-gist-esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c

[github-hast-util-to-nlcst]: https://github.com/syntax-tree/hast-util-to-nlcst

[github-rehype]: https://github.com/rehypejs/rehype

[github-retext]: https://github.com/retextjs/retext

[github-retext-indefinite-article]: https://github.com/retextjs/retext-indefinite-article

[github-retext-readability]: https://github.com/retextjs/retext-readability

[github-unified]: https://github.com/unifiedjs/unified

[github-unified-mode]: https://github.com/unifiedjs/unified#transforming-between-ecosystems

[github-unified-parser]: https://github.com/unifiedjs/unified#parser

[github-unified-processor]: https://github.com/unifiedjs/unified#processor

[github-unified-transformer]: https://github.com/unifiedjs/unified#transformer

[health]: https://github.com/rehypejs/.github

[health-coc]: https://github.com/rehypejs/.github/blob/main/code-of-conduct.md

[health-contributing]: https://github.com/rehypejs/.github/blob/main/contributing.md

[health-support]: https://github.com/rehypejs/.github/blob/main/support.md

[npmjs-install]: https://docs.npmjs.com/cli/install

[typescript]: https://www.typescriptlang.org

[wikipedia-xss]: https://en.wikipedia.org/wiki/Cross-site_scripting

[wooorm]: https://wooorm.com