site/node_modules/retext-stringify/readme.md

retext-stringify

retext plugin to add support for serializing natural language.

Contents

• What is this?
• When should I use this?
• Install
• Use
• API
  • unified().use(retextStringify)
• Syntax tree
• Types
• Compatibility
• Contribute
• Sponsor
• License

What is this?

This package is a unified (retext) plugin that defines how to take a syntax tree as input and turn it into serialized natural language. When it’s used, natural language is serialized as the final result.

See the monorepo readme for info on what the retext ecosystem is.

When should I use this?

This plugin adds support to unified for serializing natural language. You can alternatively use retext instead, which combines unified, retext-latin, and this plugin.

Install

This package is ESM only. In Node.js (version 16+), install with npm:

npm install retext-stringify

In Deno with esm.sh:

import retextStringify from 'https://esm.sh/retext-stringify@4'

In browsers with esm.sh:

<script type="module">
  import retextStringify from 'https://esm.sh/retext-stringify@4?bundle'
</script>

Use

import retextEmoji from 'retext-emoji'
import retextLatin from 'retext-latin'
import retextProfanities from 'retext-profanities'
import retextStringify from 'retext-stringify'
import {unified} from 'unified'
import {reporter} from 'vfile-reporter'

const file = await unified()
  .use(retextLatin)
  .use(retextProfanities)
  .use(retextEmoji, {convert: 'encode'})
  .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

API

This package exports no identifiers. The default export is retextStringify.

unified().use(retextStringify)

Add support for serializing natural language.

Parameters

There are no parameters.

Returns

Nothing (undefined).

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-stringify@^4, 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?

License

MIT © Titus Wormer