retext-english

[![Build][build-badge]][build]
[![Coverage][coverage-badge]][coverage]
[![Downloads][downloads-badge]][downloads]
[![Size][size-badge]][size]
[![Sponsors][sponsors-badge]][collective]
[![Backers][backers-badge]][collective]
[![Chat][chat-badge]][chat]

[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][retext] 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][retext-core] for any Latin-script
text, or for Dutch use unified itself with
[retext-dutch][retext-dutch] and [retext-stringify][retext-stringify].

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

Install

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

``sh
npm install retext-english
`

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

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

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

`html

`

Use

`js
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:

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

`txt
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][api-retext-english].

$3

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][contributing] in [retextjs/.github][health] for ways
to get started.
See [support.md`][support] for ways to get help.

This project has a [code of conduct][coc].
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][collective]!

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

License

[MIT][license] © [Titus Wormer][author]

[build-badge]: https://github.com/retextjs/retext/workflows/main/badge.svg

[build]: https://github.com/retextjs/retext/actions

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

[coverage]: https://codecov.io/github/retextjs/retext

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

[downloads]: https://www.npmjs.com/package/retext-english

[size-badge]: https://img.shields.io/bundlephobia/minzip/retext-english.svg

[size]: https://bundlephobia.com/result?p=retext-english

[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg

[backers-badge]: https://opencollective.com/unified/backers/badge.svg

[collective]: https://opencollective.com/unified

[chat-badge]: https://img.shields.io/badge/chat-discussions-success.svg

[chat]: https://github.com/retextjs/retext/discussions

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

[contributing]: https://github.com/retextjs/.github/blob/main/contributing.md

[support]: https://github.com/retextjs/.github/blob/main/support.md

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

[license]: https://github.com/retextjs/retext/blob/main/license

[author]: https://wooorm.com

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

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

[esmsh]: https://esm.sh

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

[parse-english]: https://github.com/wooorm/parse-english

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

[retext-core]: https://github.com/retextjs/retext/tree/main/packages/retext

[retext-stringify]: https://github.com/retextjs/retext/tree/main/packages/retext-stringify

[retext-dutch]: https://github.com/retextjs/retext/tree/main/packages/retext-dutch

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

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

[api-retext-english]: #unifieduseretextenglish