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)
  • Parser
• 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. You can alternatively use retext instead, which combines unified, this plugin, and retext-stringify. If the prose is in Dutch, or any Latin-script language, use unified itself with retext-dutch or retext-latin, respectively.

This plugin is built on parse-english, which is a level lower, but you could use that manually too.

Install

This package is ESM only. In Node.js (version 12.20+, 14.14+, 16.0+, or 18.0+), install with npm:

npm install retext-english

In Deno with esm.sh:

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

In browsers with esm.sh:

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

Use

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

const file = await unified()
  .use(retextEnglish)
  .use(retextProfanities)
  .use(retextEmoji, {convert: 'encode'})
  .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 the identifier Parser. The default export is retextEnglish.

unified().use(retextEnglish)

Add support for parsing English input.

There are no options.

Parser

Access to the parser (parse-english).

Syntax tree

The syntax tree format used in retext is nlcst.

Types

This package is fully typed with TypeScript. There are no extra exported types.

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+, 16.0+, and 18.0+. Our projects sometimes work with older versions, but this is not guaranteed.

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!

Vercel		Motif		HashiCorp		GitBook		Gatsby
Netlify		Coinbase	ThemeIsle	Expo	Boost Note	Holloway
		You?

License

MIT © Titus Wormer