retext-english

!Buildbuild-badgebuild !Coveragecoverage-badgecoverage !Downloadsdownloads-badgedownloads !Sizesize-badgesize !Sponsorssponsors-badgecollective !Backersbackers-badgecollective !Chatchat-badgechat
retextretext plugin to parse English natural language. Parser for unifiedunified. Parses English language prose to nlcstnlcst syntax trees.

Sponsors

Support this effort and give back by sponsoring on OpenCollectivecollective!

Gatsby 🥇	Vercel 🥇	Netlify	Holloway	ThemeIsle	Boost Hub	Expo
You?

Install

This package is ESM only: Node 12+ is needed to use it and it must be imported instead of required.
npm install retext-english

## Use

```js
import {unified} from 'unified'
import {stream} from 'unified-stream'
import retextEnglish from 'retext-english'
import retextStringify from 'retext-stringify'
import retextEmoji from 'retext-emoji'

const processor = unified()
  .use(retextEnglish)
  .use(retextEmoji, {convert: 'encode'})
  .use(retextStringify)

process.stdin.pipe(stream(processor)).pipe(process.stdout)

API

This package exports the following identifiers: Parser. retextEnglish is the default export.

unified().use(retextEnglish)

Parse English natural language. There is no configuration for the parser.

Parser

Access to the parser (parse-englishparse-english).

Contribute

See contributing.mdcontributing in retextjs/.githubhealth for ways to get started. See support.mdsupport for ways to get help. Ideas for new plugins and tools can be posted in retextjs/ideasideas.
A curated list of awesome retext resources can be found in awesome retextawesome.
This project has a code of conductcoc. By interacting with this repository, organization, or community you agree to abide by its terms.

License

MITlicense © Titus Wormerauthor