Skip to content

Commit

Permalink
docs(spec): where this specification fits
Browse files Browse the repository at this point in the history
Signed-off-by: Lexus Drumgold <unicornware@flexdevelopment.llc>
  • Loading branch information
unicornware committed Mar 9, 2024
1 parent f578b08 commit a3a65a3
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,12 +41,13 @@ of esast started in March 2024. This specification is written in a [TypeScript][

### Where this specification fits

**TODO**: document [`docast`][docast] relation\
**TODO**: document estree relation\
**TODO**: document javascript relation

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
Expand Down Expand Up @@ -172,7 +173,8 @@ community you agree to abide by its terms.
<!-- [esast-util-to-js]: https://github.com/flex-development/esast-util-to-js -->

[estree-util-is-identifier-name]: https://github.com/syntax-tree/estree-util-is-identifier-name
[javascript]: https://www.ecma-international.org/ecma-262/9.0/index.html
[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
Expand Down

0 comments on commit a3a65a3

Please sign in to comment.