retext-english

retext plugin to add support for parsing English natural language.

Contents

• What is this?
• When should I use this?
• Install
• Use
• API
  • unified().use(retextEnglish)
• Syntax tree
• Types
• Compatibility
• Contribute
• Sponsor
• License

What is this?

This package is a unified (retext) plugin that defines how to take English natural language as input and turn it into a syntax tree. When it’s used, natural language can be parsed and other retext plugins can be used after it.

See the monorepo readme for info on what the retext ecosystem is.

When should I use this?

This plugin adds support to unified for parsing English. If the prose is not English, use retext for any Latin-script text, or for Dutch use unified itself with retext-dutch and retext-stringify.

If you just want the syntax tree, you can use parse-english directly.

Install

This package is ESM only. In Node.js (version 16+), install with npm:

npm install retext-english

In Deno with esm.sh:

import retextEnglish from 'https://esm.sh/retext-english@5'

In browsers with esm.sh:

<script type="module">
  import retextEnglish from 'https://esm.sh/retext-english@5?bundle'
</script>

Use

import retextEnglish from 'retext-english'
import retextEmoji from 'retext-emoji'
import retextProfanities from 'retext-profanities'
import retextStringify from 'retext-stringify'
import {unified} from 'unified'
import {reporter} from 'vfile-reporter'

const file = await unified()
  .use(retextEnglish)
  .use(retextEmoji, {convert: 'encode'})
  .use(retextProfanities)
  .use(retextStringify)
  .process('He’s set on beating your butt for sheriff! :cop:')

console.log(String(file))
console.error(reporter(file))

Yields:

He’s set on beating your butt for sheriff! 👮

1:26-1:30 warning Be careful with `butt`, it’s profane in some cases butt retext-profanities

⚠ 1 warning

API

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

unified().use(retextEnglish)

Add support for parsing English natural language.

Parameters

There are no parameters.

Returns

Nothing (undefined).

Syntax tree

The syntax tree used in retext is nlcst.

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

Contribute

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

Sponsor

Support this effort and give back by sponsoring on OpenCollective!

License

MIT © Titus Wormer