recma-jsx

recma plugin to add support for parsing and serializing JSX.

Contents

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

What is this?

This package is a unified (recma) that enables JSX. You can use this plugin to add support for parsing and serializing it.

When should I use this?

You can use this if you want to use recma and JSX. You can also use acorn-jsx manually with acorn for parsing. And use the jsx handlers from estree-util-to-js manually.

Install

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

npm install recma-jsx

In Deno with esm.sh:

import recmaJsx from 'https://esm.sh/recma-jsx@1'

In browsers with esm.sh:

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

Use

Say we have the following module example.js:

import recmaJsx from 'recma-jsx'
import recmaParse from 'recma-parse'
import recmaStringify from 'recma-stringify'
import {unified} from 'unified'

const file = await unified()
  .use(recmaParse)
  .use(recmaJsx)
  .use(recmaStringify)
  .process('console.log(<em>Hi!</em>)')

console.log(String(file))

…running that with node example.js yields:

console.log(<em>Hi!</em>);

API

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

unified().use(recmaJsx)

Plugin to add support for parsing and serializing JSX.

Parameters

There are no parameters.

Returns

Nothing (undefined).

Syntax

JSX is parsed and serialized according to facebook/jsx.

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-jsx@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.

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