Skip to content

Commit

Permalink
doc(ast): mention typescript-eslint, field ordering and shape
Browse files Browse the repository at this point in the history
closes #6453
  • Loading branch information
Boshen authored and overlookmotel committed Oct 25, 2024
1 parent 2d95009 commit d2ac19e
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions crates/oxc_ast/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@
#![allow(clippy::self_named_module_files)]
#![warn(missing_docs)]

//! # Oxc AST
//! # Oxc AST (Abstract Syntax Tree) Nodes
//!
//! Abstract Syntax Tree nodes for Oxc. Supports both TypeScript and JavaScript.
//! Supports JavaScript, TypeScript and JSX.
//!
//! This is almost similar to [estree](https://github.com/estree/estree) except a few places:
//! * `Identifier` is replaced with explicit [`BindingIdentifier`], [`IdentifierReference`], [`IdentifierName`] per spec
//! Compared to [estree] and [typescript-eslint]'s definition, node ordering is identifical and the shape is similar except a few places:
//! * `Identifier` is replaced with explicit [`BindingIdentifier`], [`IdentifierReference`], [`IdentifierName`] per ECMAScript Specification
//! * `AssignmentExpression`.`left` `Pattern` is replaced with [`AssignmentTarget`]
//!
//! ## Parsing
Expand All @@ -24,6 +24,8 @@
//! [`AssignmentTarget`]: ast::AssignmentTarget
//! [`oxc_parser`]: <https://docs.rs/oxc_parser>
//! [`Parser`]: <https://docs.rs/oxc_parser/latest/oxc_parser/struct.Parser.html>
//! [estree]: <https://github.com/estree/estree>
//! [typescript-eslint]: <https://github.com/typescript-eslint/typescript-eslint/tree/main/packages/ast-spec>
#[cfg(feature = "serialize")]
mod serialize;
Expand Down

0 comments on commit d2ac19e

Please sign in to comment.