# @stackline/retext-english
> retext plugin to parse English prose.
[](https://www.npmjs.com/package/@stackline/retext-english)
[](https://github.com/alexandroit/stackline-retext-english)
[](https://github.com/alexandroit/stackline-retext-english)
[](https://alexandro.net/docs/vanilla/retext-english/)
[](https://www.reddit.com/r/Stackline/)
**[Documentation](https://alexandro.net/docs/vanilla/retext-english/)** | **[npm](https://www.npmjs.com/package/@stackline/retext-english)** | **[Issues](https://github.com/alexandroit/stackline-retext-english/issues)** | **[Repository](https://github.com/alexandroit/stackline-retext-english)**
**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](https://github.com/retextjs/retext); 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
```bash
npm install @stackline/retext-english
```
Preserve existing imports and plugin resolution with an npm alias:
```bash
npm install retext-english@npm:@stackline/retext-english
```
## Usage and API reference
### retext-english
[**retext**][retext] plugin to parse English natural language.
[Parser][] for [**unified**][unified].
Parses English language prose to [**nlcst**][nlcst] syntax trees.
## Sponsors
Support this effort and give back by sponsoring on [OpenCollective][collective]!
## Install
This package is [ESM only](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c):
Node 12+ is needed to use it and it must be `import`ed instead of `require`d.
[npm][]:
```sh
npm install @stackline/retext-english
```
## Use
```js
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`][parse-english]).
## Contribute
See [`contributing.md`][contributing] in [`retextjs/.github`][health] for ways
to get started.
See [`support.md`][support] for ways to get help.
Ideas for new plugins and tools can be posted in [`retextjs/ideas`][ideas].
A curated list of awesome retext resources can be found in [**awesome
retext**][awesome].
This project has a [code of conduct][coc].
By interacting with this repository, organization, or community you agree to
abide by its terms.
## 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
[ideas]: https://github.com/retextjs/ideas
[awesome]: https://github.com/retextjs/awesome-retext
[license]: https://github.com/retextjs/retext/blob/main/license
[author]: https://wooorm.com
[npm]: https://docs.npmjs.com/cli/install
[unified]: https://github.com/unifiedjs/unified
[retext]: https://github.com/retextjs/retext
[nlcst]: https://github.com/syntax-tree/nlcst
[parser]: https://github.com/unifiedjs/unified#processorparser
[parse-english]: https://github.com/wooorm/parse-english
## Credits and original authors
- Original project: [retext-english](https://github.com/retextjs/retext).
- Titus Wormer.
- Copyright (c) 2014 Titus Wormer .
- Stackline maintenance: [Alexandro Paixao Marques](https://www.linkedin.com/in/aleinfo/) and [Stackline contributors](https://github.com/alexandroit).
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
- [Stackline website](https://alexandro.net/)
- [GitHub projects](https://github.com/alexandroit)
- [npm packages](https://www.npmjs.com/~alex360qc)
- [Reddit community — r/Stackline](https://www.reddit.com/r/Stackline/)
- [Maintainer LinkedIn](https://www.linkedin.com/in/aleinfo/)
Use this repository's issue tracker for reproducible bugs and feature requests. Join r/Stackline for examples, usage questions and release discussions.
Documentation-only release: runtime file bytes and dependencies are unchanged from 1.0.0.
Release: https://github.com/alexandroit/stackline-retext-english/releases/tag/docs-stackline-retext-english-v1.0.2
