Product
Introducing SSO
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
retext-english
Advanced tools
Readme
retext plugin to add support for parsing English natural language.
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 for info on what the retext ecosystem is.
This plugin adds support to unified for parsing English.
If the prose is not English, use retext
for any Latin-script
text, or for Dutch use unified
itself with
retext-dutch
and retext-stringify
.
If you just want the syntax tree, you can use parse-english
directly.
This package is ESM only. In Node.js (version 16+), install with npm:
npm install retext-english
In Deno with esm.sh
:
import retextEnglish from 'https://esm.sh/retext-english@5'
In browsers with esm.sh
:
<script type="module">
import retextEnglish from 'https://esm.sh/retext-english@5?bundle'
</script>
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:
He’s set on beating your butt for sheriff! 👮
1:26-1:30 warning Be careful with `butt`, it’s profane in some cases butt retext-profanities
⚠ 1 warning
This package exports no identifiers.
The default export is retextEnglish
.
unified().use(retextEnglish)
Add support for parsing English natural language.
There are no parameters.
Nothing (undefined
).
The syntax tree used in retext is nlcst.
This package is fully typed with TypeScript. It exports no additional types.
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.
See contributing.md
in retextjs/.github
for ways
to get started.
See support.md
for ways to get help.
This project has a code of conduct. By interacting with this repository, organization, or community you agree to abide by its terms.
Support this effort and give back by sponsoring on OpenCollective!
Vercel |
Motif |
HashiCorp |
GitBook |
Gatsby | ||||
Netlify |
Coinbase |
ThemeIsle |
Expo |
Boost Note |
Markdown Space |
Holloway | ||
You? |
FAQs
retext plugin to parse English prose
The npm package retext-english receives a total of 84,274 weekly downloads. As such, retext-english popularity was classified as popular.
We found that retext-english demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.