Alexandro.Net

Version 1.0.0

@stackline/retext-english

retext plugin to parse English prose

Independent maintenance of retext-english 4.1.0. Original authors and licenses are retained.

Installation

# Preserve existing imports with an npm alias
npm install retext-english@npm:@stackline/retext-english@1.0.0
# Or use the scoped package name in your imports
npm install @stackline/retext-english@1.0.0

Node.js: See compatibility notes. Read the compatibility and maintenance notes before migrating.

Usage and API

The reference below may retain upstream package names. Use the alias installation above to run those imports with this Stackline release.

@stackline/retext-english

Independent maintenance fork of retext-english@4.1.0, preserving its API and published type declarations.

npm install @stackline/retext-english
# Keep existing imports:
npm install retext-english@npm:@stackline/retext-english@1.0.0

Stackline · Issues · Community

See UPSTREAM.md for source identity and issue review, and CHANGELOG.md for maintenance changes. Functional tests also run against the final npm tarball; releases are published from GitHub Actions with provenance.

Upstream documentation

retext-english

Build Coverage Downloads Size Sponsors Backers Chat

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

Sponsors

Support this effort and give back by sponsoring on OpenCollective!

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:

npm install retext-english

Use

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-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

MIT © Titus Wormer

Upstream issues and maintenance review

Upstream and maintenance review

Independent maintenance of retext-english@4.1.0 as @stackline/retext-english.

This maintenance branch selects the npm package from the upstream monorepo into the repository root and retains the upstream Git history. Shared tests are narrowed to this package and wired to its local implementation. Other monorepo products are not published by this repository.

The npm metadata omits gitHead. The retained source commit was found in upstream history by matching every published runtime JavaScript file byte-for-byte. Generated declaration files were recovered from the integrity-verified npm artifact.

Issue triage

The bounded open-issue query returned no issue entries. This is not evidence that the upstream is abandoned or bug-free. No upstream runtime bug fix is claimed.

The evidence query fetched the latest 100 open and 30 closed issue/PR entries and removed PRs. This is a bounded review, not a claim of exhaustive issue history or resolution of every issue.

Release verification

GitHub Actions publishes the reviewed passing-CI tarball. Release completion requires exact source identity, zero open CodeQL alerts, npm provenance and tarball identity, normal and aliased installs, and matching immutable GitHub release assets. Existing versions are never replaced.

Release changes

Changelog

1.0.0

Release files and references

Package bytes, npm provenance and the immutable GitHub release were verified for this version. Security checks describe the reviewed release; documented compatibility risks and upstream reports are not blanket claims of resolution.