refactor(ast_tools): rename oxc_ast_codegen to oxc_ast_tools. (#4846

) This PR renames the `oxc_ast_codegen` crate to `oxc_ast_tools`, It improves the readability and organization of the codebase by giving the crate a name that better reflects its purpose and contents. It also improves the error message in CI.
oxc-project · Aug 12, 2024 · 8e8fcd0 · 8e8fcd0
1 parent 0a23610
commit 8e8fcd0
Show file tree

Hide file tree

Showing 39 changed files with 31 additions and 31 deletions.
diff --git a/.github/.generated_ast_watch_list.yml b/.github/.generated_ast_watch_list.yml
@@ -1,4 +1,4 @@
-# To edit this generated file you have to edit `tasks/ast_codegen/src/main.rs`
+# To edit this generated file you have to edit `tasks/ast_tools/src/main.rs`
 # Auto-generated code, DO NOT EDIT DIRECTLY!
 
 src:

diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -280,12 +280,12 @@ jobs:
         if: steps.filter.outputs.src == 'true'
         with:
           components: rustfmt
-          cache-key: codegen
+          cache-key: ast_changes
           save-cache: ${{ github.ref_name == 'main' }}
 
       - name: Check AST Changes
         if: steps.filter.outputs.src == 'true'
         run: |
-          cargo run -p oxc_ast_codegen
-          echo 'AST changes must be commited to the repo.'
-          git diff --exit-code
+          cargo run -p oxc_ast_tools
+          git diff --exit-code ||
+          echo 'AST changes caused the "generated" code to get outdated. Have you forgotten to run the `just ast` command and/or commit generated codes?'
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/crates/oxc_ast/src/ast/js.rs b/crates/oxc_ast/src/ast/js.rs
@@ -1,6 +1,6 @@
 // NB: `#[span]`, `#[scope(...)]` and `#[visit(...)]` do NOT do anything to the code.
 // They are purely markers for codegen used in
-// `tasks/ast_codegen` and `crates/oxc_traverse/scripts`. See docs in those crates.
+// `tasks/ast_tools` and `crates/oxc_traverse/scripts`. See docs in those crates.
 
 // Silence erroneous warnings from Rust Analyser for `#[derive(Tsify)]`
 #![allow(non_snake_case)]

diff --git a/crates/oxc_ast/src/ast/jsx.rs b/crates/oxc_ast/src/ast/jsx.rs
@@ -2,7 +2,7 @@
 
 // NB: `#[span]`, `#[scope(...)]` and `#[visit(...)]` do NOT do anything to the code.
 // They are purely markers for codegen used in
-// `tasks/ast_codegen` and `crates/oxc_traverse/scripts`. See docs in those crates.
+// `tasks/ast_tools` and `crates/oxc_traverse/scripts`. See docs in those crates.
 
 // Silence erroneous warnings from Rust Analyser for `#[derive(Tsify)]`
 #![allow(non_snake_case)]

diff --git a/crates/oxc_ast/src/ast/literal.rs b/crates/oxc_ast/src/ast/literal.rs
@@ -2,7 +2,7 @@
 
 // NB: `#[span]`, `#[scope(...)]` and `#[visit(...)]` do NOT do anything to the code.
 // They are purely markers for codegen used in
-// `tasks/ast_codegen` and `crates/oxc_traverse/scripts`. See docs in those crates.
+// `tasks/ast_tools` and `crates/oxc_traverse/scripts`. See docs in those crates.
 
 // Silence erroneous warnings from Rust Analyser for `#[derive(Tsify)]`
 #![allow(non_snake_case)]

diff --git a/crates/oxc_ast/src/ast/ts.rs b/crates/oxc_ast/src/ast/ts.rs
@@ -5,7 +5,7 @@
 
 // NB: `#[span]`, `#[scope(...)]` and `#[visit(...)]` do NOT do anything to the code.
 // They are purely markers for codegen used in
-// `tasks/ast_codegen` and `crates/oxc_traverse/scripts`. See docs in those crates.
+// `tasks/ast_tools` and `crates/oxc_traverse/scripts`. See docs in those crates.
 
 // Silence erroneous warnings from Rust Analyser for `#[derive(Tsify)]`
 #![allow(non_snake_case)]

diff --git a/crates/oxc_ast/src/generated/assert_layouts.rs b/crates/oxc_ast/src/generated/assert_layouts.rs
@@ -1,5 +1,5 @@
 // Auto-generated code, DO NOT EDIT DIRECTLY!
-// To edit this generated file you have to edit `tasks/ast_codegen/src/generators/assert_layouts.rs`
+// To edit this generated file you have to edit `tasks/ast_tools/src/generators/assert_layouts.rs`
 
 use std::mem::{align_of, offset_of, size_of};
 

diff --git a/crates/oxc_ast/src/generated/ast_builder.rs b/crates/oxc_ast/src/generated/ast_builder.rs
@@ -1,5 +1,5 @@
 // Auto-generated code, DO NOT EDIT DIRECTLY!
-// To edit this generated file you have to edit `tasks/ast_codegen/src/generators/ast_builder.rs`
+// To edit this generated file you have to edit `tasks/ast_tools/src/generators/ast_builder.rs`
 
 #![allow(
     clippy::default_trait_access,

diff --git a/crates/oxc_ast/src/generated/ast_kind.rs b/crates/oxc_ast/src/generated/ast_kind.rs
@@ -1,5 +1,5 @@
 // Auto-generated code, DO NOT EDIT DIRECTLY!
-// To edit this generated file you have to edit `tasks/ast_codegen/src/generators/ast_kind.rs`
+// To edit this generated file you have to edit `tasks/ast_tools/src/generators/ast_kind.rs`
 
 use oxc_span::{GetSpan, Span};
 

diff --git a/crates/oxc_ast/src/generated/derive_clone_in.rs b/crates/oxc_ast/src/generated/derive_clone_in.rs
@@ -1,5 +1,5 @@
 // Auto-generated code, DO NOT EDIT DIRECTLY!
-// To edit this generated file you have to edit `tasks/ast_codegen/src/generators/derive_clone_in.rs`
+// To edit this generated file you have to edit `tasks/ast_tools/src/generators/derive_clone_in.rs`
 
 #![allow(clippy::default_trait_access)]
 

diff --git a/crates/oxc_ast/src/generated/derive_get_span.rs b/crates/oxc_ast/src/generated/derive_get_span.rs
@@ -1,5 +1,5 @@
 // Auto-generated code, DO NOT EDIT DIRECTLY!
-// To edit this generated file you have to edit `tasks/ast_codegen/src/generators/derive_get_span.rs`
+// To edit this generated file you have to edit `tasks/ast_tools/src/generators/derive_get_span.rs`
 
 #![allow(clippy::match_same_arms)]
 

diff --git a/crates/oxc_ast/src/generated/derive_get_span_mut.rs b/crates/oxc_ast/src/generated/derive_get_span_mut.rs
@@ -1,5 +1,5 @@
 // Auto-generated code, DO NOT EDIT DIRECTLY!
-// To edit this generated file you have to edit `tasks/ast_codegen/src/generators/derive_get_span.rs`
+// To edit this generated file you have to edit `tasks/ast_tools/src/generators/derive_get_span.rs`
 
 #![allow(clippy::match_same_arms)]
 

diff --git a/crates/oxc_ast/src/generated/visit.rs b/crates/oxc_ast/src/generated/visit.rs
@@ -1,5 +1,5 @@
 // Auto-generated code, DO NOT EDIT DIRECTLY!
-// To edit this generated file you have to edit `tasks/ast_codegen/src/generators/visit.rs`
+// To edit this generated file you have to edit `tasks/ast_tools/src/generators/visit.rs`
 
 //! Visitor Pattern
 //!

diff --git a/crates/oxc_ast/src/generated/visit_mut.rs b/crates/oxc_ast/src/generated/visit_mut.rs
@@ -1,5 +1,5 @@
 // Auto-generated code, DO NOT EDIT DIRECTLY!
-// To edit this generated file you have to edit `tasks/ast_codegen/src/generators/visit.rs`
+// To edit this generated file you have to edit `tasks/ast_tools/src/generators/visit.rs`
 
 //! Visitor Pattern
 //!

diff --git a/justfile b/justfile
@@ -174,5 +174,5 @@ website path:
 
 # sync ast changes
 ast:
-  cargo run -p oxc_ast_codegen
+  cargo run -p oxc_ast_tools
   just check
diff --git a/tasks/ast_codegen/Cargo.toml → tasks/ast_tools/Cargo.toml b/tasks/ast_codegen/Cargo.toml → tasks/ast_tools/Cargo.toml
@@ -1,5 +1,5 @@
 [package]
-name              = "oxc_ast_codegen"
+name              = "oxc_ast_tools"
 version           = "0.0.0"
 publish           = false
 edition.workspace = true
@@ -9,7 +9,7 @@ license.workspace = true
 workspace = true
 
 [[bin]]
-name    = "oxc_ast_codegen"
+name    = "oxc_ast_tools"
 test    = false
 doctest = false
 

diff --git a/tasks/ast_codegen/src/codegen.rs → tasks/ast_tools/src/codegen.rs b/tasks/ast_codegen/src/codegen.rs → tasks/ast_tools/src/codegen.rs
diff --git a/tasks/ast_codegen/src/fmt.rs → tasks/ast_tools/src/fmt.rs b/tasks/ast_codegen/src/fmt.rs → tasks/ast_tools/src/fmt.rs
diff --git a/..._codegen/src/generators/assert_layouts.rs → ...st_tools/src/generators/assert_layouts.rs b/..._codegen/src/generators/assert_layouts.rs → ...st_tools/src/generators/assert_layouts.rs
diff --git a/...ast_codegen/src/generators/ast_builder.rs → ...s/ast_tools/src/generators/ast_builder.rs b/...ast_codegen/src/generators/ast_builder.rs → ...s/ast_tools/src/generators/ast_builder.rs
diff --git a/tasks/ast_codegen/src/generators/ast_kind.rs → tasks/ast_tools/src/generators/ast_kind.rs b/tasks/ast_codegen/src/generators/ast_kind.rs → tasks/ast_tools/src/generators/ast_kind.rs
diff --git a/...codegen/src/generators/derive_clone_in.rs → ...t_tools/src/generators/derive_clone_in.rs b/...codegen/src/generators/derive_clone_in.rs → ...t_tools/src/generators/derive_clone_in.rs
diff --git a/...codegen/src/generators/derive_get_span.rs → ...t_tools/src/generators/derive_get_span.rs b/...codegen/src/generators/derive_get_span.rs → ...t_tools/src/generators/derive_get_span.rs
diff --git a/tasks/ast_codegen/src/generators/mod.rs → tasks/ast_tools/src/generators/mod.rs b/tasks/ast_codegen/src/generators/mod.rs → tasks/ast_tools/src/generators/mod.rs
diff --git a/tasks/ast_codegen/src/generators/visit.rs → tasks/ast_tools/src/generators/visit.rs b/tasks/ast_codegen/src/generators/visit.rs → tasks/ast_tools/src/generators/visit.rs
diff --git a/tasks/ast_codegen/src/layout.rs → tasks/ast_tools/src/layout.rs b/tasks/ast_codegen/src/layout.rs → tasks/ast_tools/src/layout.rs
diff --git a/tasks/ast_codegen/src/main.rs → tasks/ast_tools/src/main.rs b/tasks/ast_codegen/src/main.rs → tasks/ast_tools/src/main.rs
diff --git a/tasks/ast_codegen/src/markers.rs → tasks/ast_tools/src/markers.rs b/tasks/ast_codegen/src/markers.rs → tasks/ast_tools/src/markers.rs
diff --git a/tasks/ast_codegen/src/passes/calc_layout.rs → tasks/ast_tools/src/passes/calc_layout.rs b/tasks/ast_codegen/src/passes/calc_layout.rs → tasks/ast_tools/src/passes/calc_layout.rs
@@ -17,7 +17,7 @@ use super::{define_pass, Pass};
 
 /// We use compiler to infer 64bit type layouts.
 #[cfg(not(target_pointer_width = "64"))]
-compile_error!("`oxc_ast_codegen::calc_layout` only supports 64 architectures.");
+compile_error!("This module only supports 64bit architectures.");
 
 type WellKnown = HashMap<&'static str, PlatformLayout>;
 

diff --git a/tasks/ast_codegen/src/passes/linker.rs → tasks/ast_tools/src/passes/linker.rs b/tasks/ast_codegen/src/passes/linker.rs → tasks/ast_tools/src/passes/linker.rs
diff --git a/tasks/ast_codegen/src/passes/mod.rs → tasks/ast_tools/src/passes/mod.rs b/tasks/ast_codegen/src/passes/mod.rs → tasks/ast_tools/src/passes/mod.rs
diff --git a/tasks/ast_codegen/src/rust_ast.rs → tasks/ast_tools/src/rust_ast.rs b/tasks/ast_codegen/src/rust_ast.rs → tasks/ast_tools/src/rust_ast.rs
diff --git a/tasks/ast_codegen/src/schema/defs.rs → tasks/ast_tools/src/schema/defs.rs b/tasks/ast_codegen/src/schema/defs.rs → tasks/ast_tools/src/schema/defs.rs
diff --git a/tasks/ast_codegen/src/schema/get_generics.rs → tasks/ast_tools/src/schema/get_generics.rs b/tasks/ast_codegen/src/schema/get_generics.rs → tasks/ast_tools/src/schema/get_generics.rs
diff --git a/tasks/ast_codegen/src/schema/get_ident.rs → tasks/ast_tools/src/schema/get_ident.rs b/tasks/ast_codegen/src/schema/get_ident.rs → tasks/ast_tools/src/schema/get_ident.rs
diff --git a/tasks/ast_codegen/src/schema/mod.rs → tasks/ast_tools/src/schema/mod.rs b/tasks/ast_codegen/src/schema/mod.rs → tasks/ast_tools/src/schema/mod.rs
diff --git a/tasks/ast_codegen/src/schema/to_type.rs → tasks/ast_tools/src/schema/to_type.rs b/tasks/ast_codegen/src/schema/to_type.rs → tasks/ast_tools/src/schema/to_type.rs
diff --git a/tasks/ast_codegen/src/util.rs → tasks/ast_tools/src/util.rs b/tasks/ast_codegen/src/util.rs → tasks/ast_tools/src/util.rs