regram-stringify

regram plugin to add support for serializing tgast to plain text.

What is this?

This package is a unified (regram) plugin that defines how to take tgast syntax tree as input and turn it into a plain text.

When should I use this?

This plugin adds support to unified for serializing tgast to plain text.

Install

Install the package using your preferred package manager:

1# deno
2deno add npm:regram-stringify
3
4# bun
5bun add regram-stringify
6
7# pnpm
8pnpm add regram-stringify
9
10# yarn
11yarn add regram-stringify
12
13# npm
14npm install regram-stringify

Use

Say we have the following module example.js:

1import { unified } from "unified";
2import { regramParse } from "regram-parse";
3import { regramStringify } from "regram-stringify";
4
5const message = {
6  text: "Hello, bold world!",
7  entities: [
8    { type: "bold", offset: 7, length: 4 },
9  ],
10};
11
12const file = unified()
13  .use(regramParse)
14  .use(regramStringify)
15  .processSync(message);
16
17console.log(String(file));

…then running node example.js yields:

Hello, bold world!

API

This package exports the identifier regramStringify. There is no default export.

unified().use(regramStringify)

Add support for serializing tgast to plain text.

Parameters

There are no parameters.

Returns

Nothing (undefined).