@stackline/retext-english

retext plugin to parse English prose.

Documentation | npm | Issues | Repository

Current package version: 1.0.2

Why this package?

@stackline/retext-english is the Stackline-maintained distribution of retext-english@4.1.0. It is an independent continuation of retext-english; original authors and licenses remain credited below.

Compatibility

Item	Value
Package	`@stackline/retext-english@1.0.2`
API target	`retext-english@4.1.0`
Supported Node.js	`See supported framework requirements`
License	`MIT`
Module type	`module`
Main entry	`index.js`
Types	`index.d.ts`
Runtime dependencies	`unherit, unified, @types/nlcst, parse-english`

Installation

npm install @stackline/retext-english

Preserve existing imports and plugin resolution with an npm alias:

npm install retext-english@npm:@stackline/retext-english

Usage and API reference

retext-english

retext plugin to parse English natural language. Parser for unified. Parses English language prose to nlcst syntax trees.

Install

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

npm:

npm install @stackline/retext-english

Use

import {unified} from 'unified'
import {stream} from 'unified-stream'
import retextEnglish from '@stackline/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-english).

Contribute

See contributing.md in retextjs/.github for ways to get started. See support.md for ways to get help. Ideas for new plugins and tools can be posted in retextjs/ideas.

A curated list of awesome retext resources can be found in awesome retext.

This project has a code of conduct. By interacting with this repository, organization, or community you agree to abide by its terms.

License

Credits and original authors

Original project: retext-english.
Titus Wormer.
Stackline maintenance: Alexandro Paixao Marques and Stackline contributors.

Original copyright, license notices and contributor acknowledgements remain part of this distribution. Stackline maintenance does not replace authorship of the original work.

Community and Links

Use this repository's issue tracker for reproducible bugs and feature requests. Join r/Stackline for examples, usage questions and release discussions.

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