Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/syntax-tree/hast-util-to-estree
hast utility to transform to estree (JavaScript AST) JSX
https://github.com/syntax-tree/hast-util-to-estree
babel ecmascript estree hast hast-util html javascript js jsx
Last synced: 6 days ago
JSON representation
hast utility to transform to estree (JavaScript AST) JSX
- Host: GitHub
- URL: https://github.com/syntax-tree/hast-util-to-estree
- Owner: syntax-tree
- License: mit
- Created: 2020-12-13T14:35:49.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2023-09-01T09:15:59.000Z (about 1 year ago)
- Last Synced: 2024-10-20T13:26:39.715Z (16 days ago)
- Topics: babel, ecmascript, estree, hast, hast-util, html, javascript, js, jsx
- Language: JavaScript
- Homepage: https://unifiedjs.com
- Size: 262 KB
- Stars: 19
- Watchers: 8
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: license
Awesome Lists containing this project
README
# hast-util-to-estree
[![Build][build-badge]][build]
[![Coverage][coverage-badge]][coverage]
[![Downloads][downloads-badge]][downloads]
[![Size][size-badge]][size]
[![Sponsors][sponsors-badge]][collective]
[![Backers][backers-badge]][collective]
[![Chat][chat-badge]][chat]
[hast][] utility to transform to [estree][] (JSX).
## Contents
* [What is this?](#what-is-this)
* [When should I use this?](#when-should-i-use-this)
* [Install](#install)
* [Use](#use)
* [API](#api)
* [`toEstree(tree[, options])`](#toestreetree-options)
* [`defaultHandlers`](#defaulthandlers)
* [`ElementAttributeNameCase`](#elementattributenamecase)
* [`Handle`](#handle)
* [`Options`](#options)
* [`Space`](#space)
* [`State`](#state)
* [`StylePropertyNameCase`](#stylepropertynamecase)
* [Types](#types)
* [Compatibility](#compatibility)
* [Security](#security)
* [Related](#related)
* [Contribute](#contribute)
* [License](#license)
## What is this?
This package is a utility that takes a [hast][] (HTML) syntax tree as input and
turns it into an [estree][] (JavaScript) syntax tree (with a JSX extension).
This package also supports embedded MDX nodes.
## When should I use this?
This project is useful when you want to embed HTML as JSX inside JS while
working with syntax trees.
This is used in [MDX][].
## Install
This package is [ESM only][esm].
In Node.js (version 16+), install with [npm][]:
```sh
npm install hast-util-to-estree
```
In Deno with [`esm.sh`][esmsh]:
```js
import {toEstree} from 'https://esm.sh/hast-util-to-estree@3'
```
In browsers with [`esm.sh`][esmsh]:
```html
import {toEstree} from 'https://esm.sh/hast-util-to-estree@3?bundle'
```
## Use
Say our module `example.html` contains:
```html
Hi!
Hello, world!
SVG `<ellipse>` element
```
…and our module `example.js` looks as follows:
```js
import fs from 'node:fs/promises'
import {jsx, toJs} from 'estree-util-to-js'
import {fromHtml} from 'hast-util-from-html'
import {toEstree} from 'hast-util-to-estree'
const hast = fromHtml(await fs.readFile('example.html'))
const estree = toEstree(hast)
console.log(toJs(estree, {handlers: jsx}).value)
```
…now running `node example.js` (and prettier) yields:
```jsx
/* Commentz */
;<>
{'Hi!'}
{'\n'}
{'\n'}
{'Hello, world!'}
{'\n'}
{'\n'}
{}
{'\n'}
{'\n '}
{'SVG `` element'}
{'\n '}
{'\n'}
{'\n'}
{'\n'}
>
```
## API
This package exports the identifiers [`defaultHandlers`][api-default-handlers]
and [`toEstree`][api-to-estree].
There is no default export.
### `toEstree(tree[, options])`
Transform a hast tree (with embedded MDX nodes) into an estree (with JSX
nodes).
##### Notes
###### Comments
Comments are attached to the tree in their neighbouring nodes (`recast`,
`babel` style) and also added as a `comments` array on the program node
(`espree` style).
You may have to do `program.comments = undefined` for certain compilers.
###### Frameworks
There are differences between what JSX frameworks accept, such as whether they
accept `class` or `className`, or `background-color` or `backgroundColor`.
For JSX components written in MDX, the author has to be aware of this
difference and write code accordingly.
For hast elements transformed by this project, this will be handled through
options.
| Framework | `elementAttributeNameCase` | `stylePropertyNameCase` |
| --------- | -------------------------- | ----------------------- |
| Preact | `'html'` | `'dom'` |
| React | `'react'` | `'dom'` |
| Solid | `'html'` | `'css'` |
| Vue | `'html'` | `'dom'` |
###### Parameters
* `tree` ([`HastNode`][hast-node])
— hast tree
* `options` ([`Options`][api-options], optional)
— configuration
###### Returns
estree program node ([`Program`][program]).
The program’s last child in `body` is most likely an `ExpressionStatement`,
whose expression is a `JSXFragment` or a `JSXElement`.
Typically, there is only one node in `body`, however, this utility also supports
embedded MDX nodes in the HTML (when [`mdast-util-mdx`][mdast-util-mdx] is used
with mdast to parse markdown before passing its nodes through to hast).
When MDX ESM import/exports are used, those nodes are added before the fragment
or element in body.
There aren’t many great estree serializers out there that support JSX.
To do that, you can use [`estree-util-to-js`][estree-util-to-js].
Or, use [`estree-util-build-jsx`][build-jsx] to turn JSX into function
calls, and then serialize with whatever (`astring`, `escodegen`).
### `defaultHandlers`
Default handlers for elements (`Record`).
Each key is a node type, each value is a [`Handle`][api-handle].
### `ElementAttributeNameCase`
Specify casing to use for attribute names (TypeScript type).
HTML casing is for example `class`, `stroke-linecap`, `xml:lang`.
React casing is for example `className`, `strokeLinecap`, `xmlLang`.
###### Type
```ts
type ElementAttributeNameCase = 'html' | 'react'
```
### `Handle`
Turn a hast node into an estree node (TypeScript type).
###### Parameters
* `node` ([`HastNode`][hast-node])
— expected hast node
* `state` ([`State`][api-state])
— info passed around about the current state
###### Returns
JSX child (`JsxChild`, optional).
You can also add more results to `state.esm` and `state.comments`.
### `Options`
Configuration (TypeScript type).
###### Fields
* `elementAttributeNameCase`
([`ElementAttributeNameCase`][api-element-attribute-name-case], default:
`'react'`)
— specify casing to use for attribute names; this casing is used for hast
elements, not for embedded MDX JSX nodes (components that someone authored
manually)
* `handlers` (`Record`, optional)
— custom handlers
* `space` ([`Space`][api-space], default: `'html'`)
— which space the document is in; when an `` element is found in the
HTML space, this package already automatically switches to and from the SVG
space when entering and exiting it
* `stylePropertyNameCase`
([`StylePropertyNameCase`][api-style-property-name-case],
default: `'dom'`)
— specify casing to use for property names in `style` objects; this casing
is used for hast elements, not for embedded MDX JSX nodes (components that
someone authored manually)
* `tableCellAlignToStyle` (`boolean`, default: `true`)
— turn obsolete `align` props on `td` and `th` into CSS `style` props
### `Space`
Namespace (TypeScript type).
###### Type
```ts
type Space = 'html' | 'svg'
```
### `State`
Info passed around about the current state (TypeScript type).
###### Fields
* `all` (`(node: HastParent) => EstreeJsxChild | undefined`)
— transform children of a hast parent to estree
* `comments` (`Array`)
— list of estree comments
* `createJsxAttributeName` (`(name: string) => EstreeJsxAttributeName`)
— create a JSX attribute name
* `createJsxElementName` (`(name: string) => EstreeJsxElementName`)
— create a JSX attribute name
* `elementAttributeNameCase`
([`ElementAttributeNameCase`][api-element-attribute-name-case])
— casing to use for attribute names
* `esm` (`Array`)
— list of top-level estree nodes
* `handle` (`(node: HastNode) => EstreeJsxChild | undefined`)
— transform a hast node to estree
* `inherit` (`(from: HastNode, to: EstreeNode) => undefined`)
— take positional info and data from `from` (use `patch` if you don’t want
data)
* `patch` (`(from: HastNode, to: EstreeNode) => undefined`)
— take positional info from `from` (use `inherit` if you also want data)
* `schema` ([`Schema`][schema])
— current schema
* `stylePropertyNameCase`
([`StylePropertyNameCase`][api-style-property-name-case])
— casing for property names in `style` objects
* `tableCellAlignToStyle` (`boolean`)
— turn obsolete `align` props on `td` and `th` into CSS `style` props
### `StylePropertyNameCase`
Casing to use for property names in `style` objects (TypeScript type).
CSS casing is for example `background-color` and `-webkit-line-clamp`.
DOM casing is for example `backgroundColor` and `WebkitLineClamp`.
###### Type
```ts
type StylePropertyNameCase = 'css' | 'dom'
```
## Types
This package is fully typed with [TypeScript][].
It exports the additional types
[`ElementAttributeNameCase`][api-element-attribute-name-case],
[`Handle`][api-handle], [`Options`][api-options],
[`Space`][api-space], [`State`][api-state], and
[`StylePropertyNameCase`][api-style-property-name-case].
## 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, `hast-util-to-estree@^3`,
compatible with Node.js 16.
## Security
You’re working with JavaScript.
It’s not safe.
## Related
* [`estree-util-build-jsx`][build-jsx]
— transform JSX to function calls
* [`hastscript`][hastscript]
— hyperscript compatible interface for creating nodes
* [`hast-util-from-dom`](https://github.com/syntax-tree/hast-util-from-dom)
— transform a DOM tree to hast
## Contribute
See [`contributing.md`][contributing] in [`syntax-tree/.github`][health] for
ways to get started.
See [`support.md`][support] for ways to get help.
This project has a [code of conduct][coc].
By interacting with this repository, organization, or community you agree to
abide by its terms.
## License
[MIT][license] © [Titus Wormer][author]
[build-badge]: https://github.com/syntax-tree/hast-util-to-estree/workflows/main/badge.svg
[build]: https://github.com/syntax-tree/hast-util-to-estree/actions
[coverage-badge]: https://img.shields.io/codecov/c/github/syntax-tree/hast-util-to-estree.svg
[coverage]: https://codecov.io/github/syntax-tree/hast-util-to-estree
[downloads-badge]: https://img.shields.io/npm/dm/hast-util-to-estree.svg
[downloads]: https://www.npmjs.com/package/hast-util-to-estree
[size-badge]: https://img.shields.io/badge/dynamic/json?label=minzipped%20size&query=$.size.compressedSize&url=https://deno.bundlejs.com/?q=hast-util-to-estree
[size]: https://bundlejs.com/?q=hast-util-to-estree
[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg
[backers-badge]: https://opencollective.com/unified/backers/badge.svg
[collective]: https://opencollective.com/unified
[chat-badge]: https://img.shields.io/badge/chat-discussions-success.svg
[chat]: https://github.com/syntax-tree/unist/discussions
[npm]: https://docs.npmjs.com/cli/install
[esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c
[esmsh]: https://esm.sh
[typescript]: https://www.typescriptlang.org
[license]: license
[author]: https://wooorm.com
[health]: https://github.com/syntax-tree/.github
[contributing]: https://github.com/syntax-tree/.github/blob/main/contributing.md
[support]: https://github.com/syntax-tree/.github/blob/main/support.md
[coc]: https://github.com/syntax-tree/.github/blob/main/code-of-conduct.md
[hastscript]: https://github.com/syntax-tree/hastscript
[hast]: https://github.com/syntax-tree/hast
[hast-node]: https://github.com/syntax-tree/hast#nodes
[estree]: https://github.com/estree/estree
[program]: https://github.com/estree/estree/blob/master/es5.md#programs
[estree-util-to-js]: https://github.com/syntax-tree/estree-util-to-js
[mdast-util-mdx]: https://github.com/syntax-tree/mdast-util-mdx
[build-jsx]: https://github.com/wooorm/estree-util-build-jsx
[schema]: https://github.com/wooorm/property-information#api
[mdx]: https://mdxjs.com
[api-default-handlers]: #defaulthandlers
[api-to-estree]: #toestreetree-options
[api-element-attribute-name-case]: #elementattributenamecase
[api-handle]: #handle
[api-options]: #options
[api-space]: #space
[api-state]: #state
[api-style-property-name-case]: #stylepropertynamecase