# 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 ``` ## 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]!

Vercel	Motif		HashiCorp		GitBook		Gatsby

Netlify	Coinbase	ThemeIsle	Expo	Boost Note	Markdown Space	Holloway
	You?

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

retext

Downloads in past1 Month3 Months6 Months1 Year2 Years5 YearsAll time

Stats

Sick of boring JavaScript newsletters?

Downloads in past