274 lines
8.2 KiB
Markdown
274 lines
8.2 KiB
Markdown
# retext
|
||
|
||
[![Build][build-badge]][build]
|
||
[![Coverage][coverage-badge]][coverage]
|
||
[![Downloads][downloads-badge]][downloads]
|
||
[![Size][size-badge]][size]
|
||
[![Sponsors][sponsors-badge]][collective]
|
||
[![Backers][backers-badge]][collective]
|
||
[![Chat][chat-badge]][chat]
|
||
|
||
**[unified][]** processor to add support for parsing and serializing
|
||
Latin-script natural language.
|
||
|
||
## Contents
|
||
|
||
* [What is this?](#what-is-this)
|
||
* [When should I use this?](#when-should-i-use-this)
|
||
* [Install](#install)
|
||
* [Use](#use)
|
||
* [API](#api)
|
||
* [`retext()`](#retext-1)
|
||
* [Syntax tree](#syntax-tree)
|
||
* [Types](#types)
|
||
* [Compatibility](#compatibility)
|
||
* [Contribute](#contribute)
|
||
* [Sponsor](#sponsor)
|
||
* [License](#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`][retext-latin] and [`retext-stringify`][retext-stringify].
|
||
|
||
See [the monorepo readme][retext] 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][esm].
|
||
In Node.js (version 16+), install with [npm][]:
|
||
|
||
```sh
|
||
npm install retext
|
||
```
|
||
|
||
In Deno with [`esm.sh`][esmsh]:
|
||
|
||
```js
|
||
import {retext} from 'https://esm.sh/retext@9'
|
||
```
|
||
|
||
In browsers with [`esm.sh`][esmsh]:
|
||
|
||
```html
|
||
<script type="module">
|
||
import {retext} from 'https://esm.sh/retext@9?bundle'
|
||
</script>
|
||
```
|
||
|
||
## Use
|
||
|
||
```js
|
||
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:
|
||
|
||
```txt
|
||
He’s set on beating your butt for sheriff! 👮
|
||
```
|
||
|
||
```txt
|
||
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`][api-retext].
|
||
There is no default export.
|
||
|
||
### `retext()`
|
||
|
||
Create a new unified processor that already uses
|
||
[`retext-latin`][retext-latin] and [`retext-stringify`][retext-stringify].
|
||
|
||
You can add more plugins with `use`.
|
||
See [`unified`][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`][contributing] in [`retextjs/.github`][health] for ways
|
||
to get started.
|
||
See [`support.md`][support] for ways to get help.
|
||
|
||
This project has a [code of conduct][coc].
|
||
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][collective]!
|
||
|
||
<table>
|
||
<tr valign="middle">
|
||
<td width="20%" align="center" rowspan="2" colspan="2">
|
||
<a href="https://vercel.com">Vercel</a><br><br>
|
||
<a href="https://vercel.com"><img src="https://avatars1.githubusercontent.com/u/14985020?s=256&v=4" width="128"></a>
|
||
</td>
|
||
<td width="20%" align="center" rowspan="2" colspan="2">
|
||
<a href="https://motif.land">Motif</a><br><br>
|
||
<a href="https://motif.land"><img src="https://avatars1.githubusercontent.com/u/74457950?s=256&v=4" width="128"></a>
|
||
</td>
|
||
<td width="20%" align="center" rowspan="2" colspan="2">
|
||
<a href="https://www.hashicorp.com">HashiCorp</a><br><br>
|
||
<a href="https://www.hashicorp.com"><img src="https://avatars1.githubusercontent.com/u/761456?s=256&v=4" width="128"></a>
|
||
</td>
|
||
<td width="20%" align="center" rowspan="2" colspan="2">
|
||
<a href="https://www.gitbook.com">GitBook</a><br><br>
|
||
<a href="https://www.gitbook.com"><img src="https://avatars1.githubusercontent.com/u/7111340?s=256&v=4" width="128"></a>
|
||
</td>
|
||
<td width="20%" align="center" rowspan="2" colspan="2">
|
||
<a href="https://www.gatsbyjs.org">Gatsby</a><br><br>
|
||
<a href="https://www.gatsbyjs.org"><img src="https://avatars1.githubusercontent.com/u/12551863?s=256&v=4" width="128"></a>
|
||
</td>
|
||
</tr>
|
||
<tr valign="middle">
|
||
</tr>
|
||
<tr valign="middle">
|
||
<td width="20%" align="center" rowspan="2" colspan="2">
|
||
<a href="https://www.netlify.com">Netlify</a><br><br>
|
||
<!--OC has a sharper image-->
|
||
<a href="https://www.netlify.com"><img src="https://images.opencollective.com/netlify/4087de2/logo/256.png" width="128"></a>
|
||
</td>
|
||
<td width="10%" align="center">
|
||
<a href="https://www.coinbase.com">Coinbase</a><br><br>
|
||
<a href="https://www.coinbase.com"><img src="https://avatars1.githubusercontent.com/u/1885080?s=256&v=4" width="64"></a>
|
||
</td>
|
||
<td width="10%" align="center">
|
||
<a href="https://themeisle.com">ThemeIsle</a><br><br>
|
||
<a href="https://themeisle.com"><img src="https://avatars1.githubusercontent.com/u/58979018?s=128&v=4" width="64"></a>
|
||
</td>
|
||
<td width="10%" align="center">
|
||
<a href="https://expo.io">Expo</a><br><br>
|
||
<a href="https://expo.io"><img src="https://avatars1.githubusercontent.com/u/12504344?s=128&v=4" width="64"></a>
|
||
</td>
|
||
<td width="10%" align="center">
|
||
<a href="https://boostnote.io">Boost Note</a><br><br>
|
||
<a href="https://boostnote.io"><img src="https://images.opencollective.com/boosthub/6318083/logo/128.png" width="64"></a>
|
||
</td>
|
||
<td width="10%" align="center">
|
||
<a href="https://markdown.space">Markdown Space</a><br><br>
|
||
<a href="https://markdown.space"><img src="https://images.opencollective.com/markdown-space/e1038ed/logo/128.png" width="64"></a>
|
||
</td>
|
||
<td width="10%" align="center">
|
||
<a href="https://www.holloway.com">Holloway</a><br><br>
|
||
<a href="https://www.holloway.com"><img src="https://avatars1.githubusercontent.com/u/35904294?s=128&v=4" width="64"></a>
|
||
</td>
|
||
<td width="10%"></td>
|
||
<td width="10%"></td>
|
||
</tr>
|
||
<tr valign="middle">
|
||
<td width="100%" align="center" colspan="8">
|
||
<br>
|
||
<a href="https://opencollective.com/unified"><strong>You?</strong></a>
|
||
<br><br>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
|
||
## License
|
||
|
||
[MIT][license] © [Titus Wormer][author]
|
||
|
||
<!-- Definitions -->
|
||
|
||
[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.svg
|
||
|
||
[downloads]: https://www.npmjs.com/package/retext
|
||
|
||
[size-badge]: https://img.shields.io/bundlejs/size/retext
|
||
|
||
[size]: https://bundlejs.com/?q=retext
|
||
|
||
[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
|
||
|
||
[license]: https://github.com/retextjs/retext/blob/main/license
|
||
|
||
[author]: https://wooorm.com
|
||
|
||
[npm]: https://docs.npmjs.com/cli/install
|
||
|
||
[esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c
|
||
|
||
[esmsh]: https://esm.sh
|
||
|
||
[nlcst]: https://github.com/syntax-tree/nlcst
|
||
|
||
[retext-latin]: https://github.com/retextjs/retext/tree/main/packages/retext-latin
|
||
|
||
[retext-stringify]: https://github.com/retextjs/retext/tree/main/packages/retext-stringify
|
||
|
||
[retext]: https://github.com/retextjs/retext
|
||
|
||
[typescript]: https://www.typescriptlang.org
|
||
|
||
[unified]: https://github.com/unifiedjs/unified
|
||
|
||
[api-retext]: #retext-1
|