retext-stringify

What is retext-stringify?

The retext-stringify package is a plugin for the retext ecosystem that serializes a syntax tree into a string. It is typically used in conjunction with other retext plugins to process natural language text and then convert the processed syntax tree back into a string format.

What are retext-stringify's main functionalities?

Basic Stringify

This code demonstrates the basic usage of retext-stringify. It processes a simple English sentence and converts the resulting syntax tree back into a string.

const retext = require('retext');
const stringify = require('retext-stringify');
const english = require('retext-english');
const report = require('vfile-reporter');

retext()
  .use(english)
  .use(stringify)
  .process('This is a simple example.', function (err, file) {
    if (err) throw err;
    console.log(String(file));
    console.error(report(file));
  });

Other packages similar to retext-stringify

remark-stringify

remark-stringify is a plugin for the remark ecosystem that serializes Markdown syntax trees into Markdown strings. It is similar to retext-stringify but is specifically designed for Markdown content.

rehype-stringify

rehype-stringify is a plugin for the rehype ecosystem that serializes HTML syntax trees into HTML strings. It is similar to retext-stringify but is specifically designed for HTML content.

mdast-util-to-string

mdast-util-to-string is a utility that converts an MDAST (Markdown Abstract Syntax Tree) node to a string. It is similar to retext-stringify but is focused on converting specific nodes rather than entire trees.

README

retext-stringify

Compiler for unified. Stringifies an nlcst syntax tree to text. Used in the retext processor.

Installation

npm:

npm install retext-stringify

Usage

var unified = require('unified');
var english = require('retext-english');
var stringify = require('retext-stringify');
var emoji = require('retext-emoji');

process.stdin
    .pipe(unified())
    .use(english)
    .use(emoji, {convert: 'encode'})
    .use(stringify)
    .pipe(process.stdout);

Table of Contents

• API
  • processor.use(stringify)
• License

API

processor.use(stringify)

Configure the processor to stringify nlcst syntax trees to text.

There is no configuration for the parser.

License

MIT © Titus Wormer