Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/flex-development/esast
ECMAScript Abstract Syntax Tree format
https://github.com/flex-development/esast
ast ecmascript es esast javascript js syntax-tree unist unist-spec
Last synced: about 2 months ago
JSON representation
ECMAScript Abstract Syntax Tree format
- Host: GitHub
- URL: https://github.com/flex-development/esast
- Owner: flex-development
- License: bsd-3-clause
- Created: 2024-03-06T01:12:20.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-08-09T23:29:06.000Z (5 months ago)
- Last Synced: 2024-08-10T00:34:26.423Z (5 months ago)
- Topics: ast, ecmascript, es, esast, javascript, js, syntax-tree, unist, unist-spec
- Language: TypeScript
- Homepage: https://github.com/flex-development/esast
- Size: 2.14 MB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/funding.yml
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# esast
[](https://github.com/flex-development/esast/releases/latest)
[](https://npmjs.com/package/@flex-development/esast)
[](https://github.com/voxpelli/badges-cjs-esm)
[](LICENSE.md)
[](https://conventionalcommits.org/)
[](https://typescriptlang.org/)
[](https://vitest.dev/)
[](https://yarnpkg.com/)
**E**CMA**S**cript **A**bstract **S**yntax **T**ree format.
---
**esast** is a specification for representing [JavaScript][javascript] as an [abstract syntax tree][unist-syntax-tree].
It implements the [**unist**][unist] spec.
## Contents
- [Introduction](#introduction)
- [Where this specification fits](#where-this-specification-fits)
- [ESTree](#estree)
- [Types](#types)
- [Nodes (abstract)](#nodes-abstract)
- [`Node`](#node)
- [`Literal`](#literal)
- [`Parent`](#parent)
- [Nodes](#nodes)
- [Glossary](#glossary)
- [List of utilities](#list-of-utilities)
- [Contribute](#contribute)
## Introduction
This document defines a format for representing ECMAScript as an [abstract syntax tree][unist-syntax-tree]. Development
of esast started in March 2024. This specification is written in a [TypeScript][typescript]-like grammar.
### Where this specification fits
esast extends [unist][unist], a format for syntax trees, to benefit from its [ecosystem of utilities][unist-utilities].
esast relates to [ESTree][estree] in that the first is inspired by the latter; an esast is a unist-flavored estree.
esast relates to [JavaScript][javascript] in that it represents it, but esast is not limited to JavaScript and can be
extended to support other JavaScript-based languages, like [TypeScript][typescript].
### ESTree
**TODO**: estree differences
## Types
TypeScript users can integrate `esast` type definitions into their project by installing the appropriate packages:
```sh
yarn add @flex-development/esast
```
See Git - Protocols | Yarn
for details regarding installing from Git.
## Nodes (abstract)
### `Node`
```ts
interface Node extends unist.Node {}
```
**Node** ([**unist.Node**][unist-node]) is a syntactic unit in esast syntax trees.
### `Literal`
```ts
interface Literal extends Node {
value: RegExp | bigint | boolean | number | string | null | undefined
}
```
**Literal** represents an abstract interface in esast containing a value.
Its `value` field is one of the following:
- a regular expression (`RegExp`)
- a `bigint` primitive
- a `boolean`
- a `number`
- a `string`
- `null`
- `undefined`
### `Parent`
```ts
interface Parent extends Node {
children: Child[]
}
```
**Parent** represents an abstract interface in esast containing other nodes (said to be [*children*][unist-child]).
The `children` field is a list representing the children of a node.
## Nodes
**TODO**: nodes
This specification is a work in progess. Please refer to the [source code](src/nodes/) for preliminary documentation.
## Glossary
See the [unist glossary][unist-glossary].
## List of utilities
See the [unist list of utilities][unist-utilities] for more utilities.
- [`estree-util-is-identifier-name`][estree-util-is-identifier-name] — check if something can be an identifier name
## Related
- [`docast`][docast] — docblock abstract syntax tree format
- [`mdast`][mdast] — markdown abstract syntax tree format
## Contribute
See [`CONTRIBUTING.md`](CONTRIBUTING.md).
Ideas for new utilities and tools can be posted in [esast/ideas][esast-ideas].
This project has a [code of conduct](CODE_OF_CONDUCT.md). By interacting with this repository, organization, or
community you agree to abide by its terms.
[docast]: https://github.com/flex-development/docast
[esast-ideas]: https://github.com/flex-development/esast/discussions/new?category=idea
[estree-util-is-identifier-name]: https://github.com/syntax-tree/estree-util-is-identifier-name
[estree]: https://github.com/estree/estree
[javascript]: https://tc39.es/ecma262
[mdast]: https://github.com/syntax-tree/mdast
[typescript]: https://typescriptlang.org
[unist-child]: https://github.com/syntax-tree/unist#child
[unist-glossary]: https://github.com/syntax-tree/unist#glossary
[unist-node]: https://github.com/syntax-tree/unist#node
[unist-syntax-tree]: https://github.com/syntax-tree/unist#syntax-tree
[unist-utilities]: https://github.com/syntax-tree/unist#list-of-utilities
[unist]: https://github.com/syntax-tree/unist