Alexandro.Net

Version 1.0.0

@stackline/rehype-retext

rehype plugin to transform to retext

Independent maintenance of rehype-retext 3.0.2. Original authors and licenses are retained.

Installation

# Preserve existing imports with an npm alias
npm install rehype-retext@npm:@stackline/rehype-retext@1.0.0
# Or use the scoped package name in your imports
npm install @stackline/rehype-retext@1.0.0

Node.js: See compatibility notes. Read the compatibility and maintenance notes before migrating.

Usage and API

The reference below may retain upstream package names. Use the alias installation above to run those imports with this Stackline release.

@stackline/rehype-retext

Independent maintenance fork of rehype-retext@3.0.2, preserving its API and published type declarations.

npm install @stackline/rehype-retext
# Keep existing imports:
npm install rehype-retext@npm:@stackline/rehype-retext@1.0.0

Stackline · Issues · Community

See UPSTREAM.md for source identity and issue review, and CHANGELOG.md for maintenance changes. Functional tests also run against the final npm tarball; releases are published from GitHub Actions with provenance.

Upstream documentation

rehype-retext

Build Coverage Downloads Size Sponsors Backers Chat

rehype plugin to support retext.

Contents

What is this?

This package is a unified (rehype) plugin to support 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 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 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, 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. In Node.js (version 12.20+, 14.14+, or 16.0+), install with npm:

npm install rehype-retext

In Deno with Skypack:

import rehypeRetext from 'https://cdn.skypack.dev/rehype-retext@3?dts'

In browsers with Skypack:

<script type="module">
  import rehypeRetext from 'https://cdn.skypack.dev/rehype-retext@3?min'
</script>

Use

Say we have the following file example.html:

<!doctype html>
<meta charset=utf8>
<title>Hello!</title>
<article>
  A implicit sentence.
  <h1>This and and that.</h1>
</article>

And our module example.js looks as follows:

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

main()

async function main() {
  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))
}

Now running node example.js yields:

example.html
    5:3-5:4  warning  Use `An` before `implicit`, not `A`  retext-indefinite-article  retext-indefinite-article
  6:12-6:19  warning  Expected `and` once, not twice       and                        retext-repeated-words

⚠ 2 warnings

<!doctypehtml><meta charset=utf8><title>Hello!</title><article>A implicit sentence.<h1>This and and that.</h1></article>

API

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

unified().use(rehypeRetext, destination)

rehype plugin to support retext. There are no options but destination is required.

destination

destination is either a parser or a processor.

As HTML defines paragraphs, that definition is used for Paragraphs: <p> and <h1-6> are explicitly supported, and implicit paragraphs in flow content are also supported.

Types

This package is fully typed with TypeScript. It exports the Parser and Processor types, which specify the interfaces of the accepted destination.

Compatibility

Projects maintained by the unified collective are compatible with all maintained versions of Node.js. As of now, that is Node.js 12.20+, 14.14+, and 16.0+. Our projects sometimes work with older versions, but this is not guaranteed.

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) attacks.

Related

Contribute

See contributing.md in rehypejs/.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

Upstream issues and maintenance review

Upstream and maintenance review

This package maintains rehype-retext@3.0.2 under the independent @stackline/rehype-retext name.

Issue triage

The queried open-issue list contained no issue entries. This does not establish that the upstream is abandoned or bug-free. No runtime bug fix is claimed for this initial maintenance release.

The evidence query fetched the latest 100 open and 30 closed issue/PR entries and removed PRs. Closed entries were collected for context; this report does not claim an exhaustive historic review.

Release discipline

The source commit, passing CI and CodeQL, reviewed CI tarball hash, npm provenance, normal and aliased installs, and immutable GitHub release are checked before a release is complete. Published versions and tags are never replaced.

Release changes

Changelog

1.0.0

Release files and references

Package bytes, npm provenance and the immutable GitHub release were verified for this version. Security checks describe the reviewed release; documented compatibility risks and upstream reports are not blanket claims of resolution.