.. | ||
index.d.ts | ||
index.js | ||
package.json | ||
readme.md |
retext
unified processor to add support for parsing and serializing Latin-script natural language.
Contents
- What is this?
- When should I use this?
- Install
- Use
- API
- Syntax tree
- Types
- Compatibility
- Contribute
- Sponsor
- License
What is this?
This package is a unified processor with support for parsing Latin-script
natural language as input and serializing it as output by using unified with
retext-latin
and retext-stringify
.
See the monorepo readme for info on what the retext ecosystem is.
When should I use this?
You can use this package when you want to use unified, have Latin-script as
input, and as output.
This package is a shortcut for
unified().use(retextLatin).use(retextStringify)
.
When the input isn’t Latin-script or is English or Dutch (meaning you don’t
need retext-latin
), it’s recommended to use unified
directly.
Install
This package is ESM only. In Node.js (version 16+), install with npm:
npm install retext
In Deno with esm.sh
:
import {retext} from 'https://esm.sh/retext@9'
In browsers with esm.sh
:
<script type="module">
import {retext} from 'https://esm.sh/retext@9?bundle'
</script>
Use
import {retext} from 'retext'
import retextEmoji from 'retext-emoji'
import retextProfanities from 'retext-profanities'
import {reporter} from 'vfile-reporter'
const file = await retext()
.use(retextEmoji, {convert: 'encode'})
.use(retextProfanities)
.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
API
This package exports the identifier retext
.
There is no default export.
retext()
Create a new unified processor that already uses
retext-latin
and retext-stringify
.
You can add more plugins with use
.
See unified
for more information.
Syntax tree
The syntax tree used in retext is nlcst.
Types
This package is fully typed with TypeScript. It exports no additional types.
Compatibility
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@^9
, compatible
with Node.js 16.
Contribute
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.
Sponsor
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? |