From d345b84a7281d21f94cdaeb5ae2fb4d3524d9034 Mon Sep 17 00:00:00 2001 From: rzvxa <3788964+rzvxa@users.noreply.github.com> Date: Sat, 20 Jul 2024 12:22:26 +0000 Subject: [PATCH] feat(ast): add `#[ast]` attribute to non-visited AST types. (#4309) Mark everything mentioned in https://github.com/oxc-project/oxc/pull/3815#issuecomment-2186736258 as AST. We now error on the occurrence of non-ast items in the source of truth. It doesn't make sure that all fields and variants are `#[ast]` and therefore `repr_stable` but there are only a handful of non-AST types used here(mainly Atom and Span). Since we don't have access to the external types we can't make sure of it unless we find a way to const assert it. The best we can do until then is to check all field/variant types to be either `#[ast]` or in a white list. I can add this check to the codegen in an upcoming PR. --- crates/oxc_ast/src/ast/js.rs | 10 ++++++++++ crates/oxc_ast/src/ast/jsx.rs | 2 ++ crates/oxc_ast/src/ast/literal.rs | 2 ++ crates/oxc_ast/src/ast/ts.rs | 6 ++++++ tasks/ast_codegen/src/schema.rs | 2 +- 5 files changed, 21 insertions(+), 1 deletion(-) diff --git a/crates/oxc_ast/src/ast/js.rs b/crates/oxc_ast/src/ast/js.rs index 4c516b713..616db7148 100644 --- a/crates/oxc_ast/src/ast/js.rs +++ b/crates/oxc_ast/src/ast/js.rs @@ -322,6 +322,7 @@ pub enum PropertyKey<'a> { } } +#[ast] #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)] #[cfg_attr(feature = "serialize", derive(Serialize, Tsify))] #[cfg_attr(feature = "serialize", serde(rename_all = "lowercase"))] @@ -369,6 +370,7 @@ pub struct TemplateElement<'a> { } /// See [template-strings-cooked-vs-raw](https://exploringjs.com/impatient-js/ch_template-literals.html#template-strings-cooked-vs-raw) +#[ast] #[derive(Debug, Hash)] #[cfg_attr(feature = "serialize", derive(Serialize, Tsify))] pub struct TemplateElementValue<'a> { @@ -1012,6 +1014,7 @@ pub struct VariableDeclaration<'a> { pub declare: bool, } +#[ast] #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)] #[cfg_attr(feature = "serialize", derive(Serialize, Tsify))] #[cfg_attr(feature = "serialize", serde(rename_all = "lowercase"))] @@ -1475,6 +1478,7 @@ pub struct Function<'a> { pub scope_id: Cell>, } +#[ast] #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)] #[cfg_attr(feature = "serialize", derive(Serialize, Tsify))] pub enum FunctionType { @@ -1518,6 +1522,7 @@ pub struct FormalParameter<'a> { pub r#override: bool, } +#[ast] #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)] #[cfg_attr(feature = "serialize", derive(Serialize, Tsify))] pub enum FormalParameterKind { @@ -1602,6 +1607,7 @@ pub struct Class<'a> { pub scope_id: Cell>, } +#[ast] #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)] #[cfg_attr(feature = "serialize", derive(Serialize, Tsify))] pub enum ClassType { @@ -1656,6 +1662,7 @@ pub struct MethodDefinition<'a> { pub accessibility: Option, } +#[ast] #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)] #[cfg_attr(feature = "serialize", derive(Serialize, Tsify))] pub enum MethodDefinitionType { @@ -1685,6 +1692,7 @@ pub struct PropertyDefinition<'a> { pub accessibility: Option, } +#[ast] #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)] #[cfg_attr(feature = "serialize", derive(Serialize, Tsify))] pub enum PropertyDefinitionType { @@ -1692,6 +1700,7 @@ pub enum PropertyDefinitionType { TSAbstractPropertyDefinition, } +#[ast] #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)] #[cfg_attr(feature = "serialize", derive(Serialize, Tsify))] #[cfg_attr(feature = "serialize", serde(rename_all = "lowercase"))] @@ -1761,6 +1770,7 @@ macro_rules! match_module_declaration { } pub use match_module_declaration; +#[ast] #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)] #[cfg_attr(feature = "serialize", derive(Serialize, Tsify))] pub enum AccessorPropertyType { diff --git a/crates/oxc_ast/src/ast/jsx.rs b/crates/oxc_ast/src/ast/jsx.rs index 9f9c101f8..bb7d9d2b4 100644 --- a/crates/oxc_ast/src/ast/jsx.rs +++ b/crates/oxc_ast/src/ast/jsx.rs @@ -70,6 +70,7 @@ pub struct JSXFragment<'a> { pub children: Vec<'a, JSXChild<'a>>, } +#[ast] #[derive(Debug, Hash)] #[cfg_attr(feature = "serialize", derive(Serialize, Tsify))] #[cfg_attr(feature = "serialize", serde(tag = "type"))] @@ -78,6 +79,7 @@ pub struct JSXOpeningFragment { pub span: Span, } +#[ast] #[derive(Debug, Hash)] #[cfg_attr(feature = "serialize", derive(Serialize, Tsify))] #[cfg_attr(feature = "serialize", serde(tag = "type"))] diff --git a/crates/oxc_ast/src/ast/literal.rs b/crates/oxc_ast/src/ast/literal.rs index 380f9ef8f..359485df3 100644 --- a/crates/oxc_ast/src/ast/literal.rs +++ b/crates/oxc_ast/src/ast/literal.rs @@ -75,6 +75,7 @@ pub struct RegExpLiteral<'a> { pub regex: RegExp<'a>, } +#[ast] #[derive(Debug, Clone, Hash)] #[cfg_attr(feature = "serialize", derive(Serialize, Tsify))] pub struct RegExp<'a> { @@ -82,6 +83,7 @@ pub struct RegExp<'a> { pub flags: RegExpFlags, } +#[ast] #[derive(Debug, Clone, Hash)] #[cfg_attr(feature = "serialize", derive(Serialize, Tsify))] pub struct EmptyObject; diff --git a/crates/oxc_ast/src/ast/ts.rs b/crates/oxc_ast/src/ast/ts.rs index b8bbdac18..5881d3470 100644 --- a/crates/oxc_ast/src/ast/ts.rs +++ b/crates/oxc_ast/src/ast/ts.rs @@ -294,6 +294,7 @@ pub struct TSTypeOperator<'a> { pub type_annotation: TSType<'a>, } +#[ast] #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)] #[cfg_attr(feature = "serialize", derive(Serialize, Tsify))] #[cfg_attr(feature = "serialize", serde(rename_all = "lowercase"))] @@ -621,6 +622,7 @@ pub struct TSTypeAliasDeclaration<'a> { pub scope_id: Cell>, } +#[ast] #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)] #[cfg_attr(feature = "serialize", derive(Serialize, Tsify))] #[cfg_attr(feature = "serialize", serde(rename_all = "lowercase"))] @@ -722,6 +724,7 @@ pub struct TSCallSignatureDeclaration<'a> { pub type_parameters: Option>>, } +#[ast] #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)] #[cfg_attr(feature = "serialize", derive(Serialize, Tsify))] #[cfg_attr(feature = "serialize", serde(rename_all = "lowercase"))] @@ -838,6 +841,7 @@ pub struct TSModuleDeclaration<'a> { pub scope_id: Cell>, } +#[ast] #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)] #[cfg_attr(feature = "serialize", derive(Serialize, Tsify))] #[cfg_attr(feature = "serialize", serde(rename_all = "lowercase"))] @@ -1019,6 +1023,7 @@ pub struct TSMappedType<'a> { pub scope_id: Cell>, } +#[ast] #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)] #[cfg_attr(feature = "serialize", derive(Serialize, Tsify))] #[cfg_attr(feature = "serialize", serde(rename_all = "camelCase"))] @@ -1172,6 +1177,7 @@ pub struct TSInstantiationExpression<'a> { pub type_parameters: Box<'a, TSTypeParameterInstantiation<'a>>, } +#[ast] #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)] #[cfg_attr(feature = "serialize", derive(Serialize, Tsify))] #[cfg_attr(feature = "serialize", serde(rename_all = "camelCase"))] diff --git a/tasks/ast_codegen/src/schema.rs b/tasks/ast_codegen/src/schema.rs index 9054a7c7e..c3f3ef54d 100644 --- a/tasks/ast_codegen/src/schema.rs +++ b/tasks/ast_codegen/src/schema.rs @@ -386,7 +386,7 @@ pub fn analyze(type_def: &TypeRef) -> Result<()> { // AST without visit! type_def.borrow_mut().set_ast(true)?; } - Some(AstAttr::None) => { /* non AST types */ } + Some(AstAttr::None) => return Err(String::from("All `enums` and `structs` defined in the source of truth should be marked with an `#[ast]` attribute!")), None => { /* unrelated items like `use`, `type` and `macro` definitions */ } }