recma

unified processor to add support for parsing and serializing JavaScript.

Contents

• What is this?
• When should I use this?
• Install
• Use
• API
  • recma()
• Syntax
• Syntax tree
• Types
• Compatibility
• Security
• Contribute
• License

What is this?

This package is a unified processor with support for parsing JavaScript as input and serializing JavaScript as output by using unified with recma-parse and recma-stringify.

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

When should I use this?

You can use this package when you want to use unified, have JS as input, and want JS as output. This package is a shortcut for unified().use(recmaParse).use(recmaStringify). When the input isn’t JS (meaning you don’t need recma-parse) or the output is not JS (you don’t need recma-stringify), it’s recommended to use unified directly.

Install

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

npm install recma

In Deno with esm.sh:

import {recma} from 'https://esm.sh/recma@1'

In browsers with esm.sh:

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

Use

Say we have the following module example.js:

import recmaBuildJsx from 'recma-build-jsx'
import recmaJsx from 'recma-jsx'
import {recma} from 'recma'

const file = await recma()
  .use(recmaJsx)
  .use(recmaBuildJsx)
  .process('console.log(<em>Hi!</em>)')

console.log(String(file))

…running that with node example.js yields:

console.log(React.createElement("em", null, "Hi!"));

API

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

recma()

Create a new unified processor that already uses recma-parse and recma-stringify.

You can add more plugins with use. See unified for more information.

Syntax

JS is parsed and 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 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, recma@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