recma-stringify

recma plugin to add support for serializing JavaScript.

Contents

• What is this?
• When should I use this?
• Install
• Use
• API
  • unified().use(recmaStringify[, options])
  • Options
• Syntax
• Syntax tree
• Types
• Compatibility
• Security
• Contribute
• License

What is this?

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

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

When should I use this?

This plugin adds support to unified for serializing JavaScript. If you also need to parse JavaScript, you can alternatively use recma, which combines unified, this plugin, and recma-parse.

If you don’t use plugins and have access to the syntax tree, you can directly use estree-util-to-js, which is used inside this plugin. recma focusses on making it easier to transform code by abstracting such internals away.

Install

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

npm install recma-stringify

In Deno with esm.sh:

import recmaStringify from 'https://esm.sh/recma-stringify@1'

In browsers with esm.sh:

<script type="module">
  import recmaStringify from 'https://esm.sh/recma-stringify@1?bundle'
</script>

Use

Say we have the following module example.js:

import recmaJsx from 'recma-jsx'
import recmaStringify from 'recma-stringify'
import rehypeParse from 'rehype-parse'
import rehypeRecma from 'rehype-recma'
import {unified} from 'unified'

const file = await unified()
  .use(rehypeParse, {fragment: true})
  .use(rehypeRecma)
  .use(recmaJsx)
  .use(recmaStringify)
  .process('<p>Hi!<h1>Hello!')

console.log(String(file))

…running that with node example.js yields:

<><p>{"Hi!"}</p><h1>{"Hello!"}</h1></>;

API

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

unified().use(recmaStringify[, options])

Plugin to add support for serializing to JavaScript.

Parameters

• options (Options, optional) — configuration

Returns

Nothing (undefined).

Options

Configuration (TypeScript type).

Same as Options from estree-util-to-js. Passing filePath is not supported as it is handled for you.

Syntax

JS is serialized according to ECMA-262, which is also followed by all browsers and engines such as Node.js.

Syntax tree

The syntax tree format used in recma is esast and estree.

Types

This package is fully typed with TypeScript. It exports the additional type Options.

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, recma-strignify@1, compatible with Node.js 16.

Security

As recma works on JS and evaluating JS is unsafe, use of recma can also be unsafe. Do not evaluate unsafe code.

Use of recma plugins could also open you up to other attacks. Carefully assess each plugin and the risks involved in using them.

For info on how to submit a report, see our security policy.

Contribute

See § Contribute on our site for ways to get started. See § Support 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.

License

MIT © Titus Wormer