refactor(linter): duplicate RawTransferMetadata in oxc_linter crate (#12382)

`RawTransferMetadata` is used to store basic info about the data in the buffer which is used on JS side to locate `Program` in the buffer etc.

This struct lives in `napi/parser` crate but we're going to need it in `napi/oxlint2` too. So make a 2nd copy of it in `napi/oxlint2` and use `oxc_ast_tools` to enforce that the 2 copies are identical.

This is a bit of a hack, but it doesn't seem worthwhile creating a new crate just to hold this one struct, and it doesn't really fit in `oxc_allocator`, or any of our other existing crates.

Author: overlookmotel

.github/generated/ast_changes_watch_list.yml

@@ -38,6 +38,8 @@ src:
   - 'crates/oxc_formatter/src/generated/ast_nodes.rs'
   - 'crates/oxc_formatter/src/generated/format.rs'
   - 'crates/oxc_formatter/src/generated/format_write.rs'
+  - 'crates/oxc_linter/src/generated/assert_layouts.rs'
+  - 'crates/oxc_linter/src/lib.rs'
   - 'crates/oxc_regular_expression/src/ast.rs'
   - 'crates/oxc_regular_expression/src/generated/assert_layouts.rs'
   - 'crates/oxc_regular_expression/src/generated/derive_clone_in.rs'

Cargo.lock

@@ -17,7 +17,7 @@ description.workspace = true
 default = []
 ruledocs = ["oxc_macros/ruledocs"] # Enables the `ruledocs` feature for conditional compilation
 language_server = ["oxc_data_structures/rope"] # For the Runtime to support needed information for the language server
-oxlint2 = ["tokio/rt-multi-thread"]
+oxlint2 = ["dep:oxc_ast_macros", "tokio/rt-multi-thread"]
 disable_oxlint2 = []
 force_test_reporter = []
 
@@ -30,6 +30,7 @@ doctest = true
 [dependencies]
 oxc_allocator = { workspace = true }
 oxc_ast = { workspace = true }
+oxc_ast_macros = { workspace = true, optional = true }
 oxc_ast_visit = { workspace = true }
 oxc_cfg = { workspace = true }
 oxc_codegen = { workspace = true }

crates/oxc_ast_macros/src/generated/structs.rs

@@ -0,0 +1,31 @@
+// Auto-generated code, DO NOT EDIT DIRECTLY!
+// To edit this generated file you have to edit `tasks/ast_tools/src/generators/assert_layouts.rs`.
+
+#![allow(unused_imports)]
+
+use std::mem::{align_of, offset_of, size_of};
+
+use crate::*;
+
+#[cfg(target_pointer_width = "64")]
+const _: () = {
+    // Padding: 3 bytes
+    assert!(size_of::<RawTransferMetadata2>() == 16);
+    assert!(align_of::<RawTransferMetadata2>() == 8);
+    assert!(offset_of!(RawTransferMetadata2, data_offset) == 8);
+    assert!(offset_of!(RawTransferMetadata2, is_ts) == 12);
+    assert!(offset_of!(RawTransferMetadata2, _padding) == 0);
+};
+
+#[cfg(target_pointer_width = "32")]
+const _: () = {
+    // Padding: 3 bytes
+    assert!(size_of::<RawTransferMetadata2>() == 16);
+    assert!(align_of::<RawTransferMetadata2>() == 8);
+    assert!(offset_of!(RawTransferMetadata2, data_offset) == 8);
+    assert!(offset_of!(RawTransferMetadata2, is_ts) == 12);
+    assert!(offset_of!(RawTransferMetadata2, _padding) == 0);
+};
+
+#[cfg(not(any(target_pointer_width = "64", target_pointer_width = "32")))]
+const _: () = panic!("Platforms with pointer width other than 64 or 32 bit are not supported");

crates/oxc_linter/Cargo.toml

@@ -6,6 +6,9 @@ use std::{path::Path, rc::Rc, sync::Arc};
 use oxc_allocator::Allocator;
 use oxc_semantic::{AstNode, Semantic};
 
+#[cfg(all(feature = "oxlint2", not(feature = "disable_oxlint2")))]
+use oxc_ast_macros::ast;
+
 #[cfg(test)]
 mod tester;
 
@@ -29,6 +32,12 @@ pub mod loader;
 pub mod rules;
 pub mod table;
 
+#[cfg(all(feature = "oxlint2", not(feature = "disable_oxlint2")))]
+mod generated {
+    #[cfg(debug_assertions)]
+    pub mod assert_layouts;
+}
+
 pub use crate::{
     config::{
         BuiltinLintPlugins, Config, ConfigBuilderError, ConfigStore, ConfigStoreBuilder,
@@ -273,6 +282,33 @@ impl Linter {
     }
 }
 
+#[cfg(all(feature = "oxlint2", not(feature = "disable_oxlint2")))]
+/// Metadata written to end of buffer.
+///
+/// Duplicate of `RawTransferMetadata` in `napi/parser/src/raw_transfer_types.rs`.
+/// Any changes made here also need to be made there.
+/// `oxc_ast_tools` checks that the 2 copies are identical.
+#[ast]
+struct RawTransferMetadata2 {
+    /// Offset of `RawTransferData` within buffer.
+    pub data_offset: u32,
+    /// `true` if AST is TypeScript.
+    pub is_ts: bool,
+    /// Padding to pad struct to size 16.
+    pub(crate) _padding: u64,
+}
+
+#[cfg(all(feature = "oxlint2", not(feature = "disable_oxlint2")))]
+use RawTransferMetadata2 as RawTransferMetadata;
+
+#[cfg(all(feature = "oxlint2", not(feature = "disable_oxlint2")))]
+#[expect(dead_code)]
+impl RawTransferMetadata {
+    pub fn new(data_offset: u32, is_ts: bool) -> Self {
+        Self { data_offset, is_ts, _padding: 0 }
+    }
+}
+
 #[cfg(test)]
 mod test {
     use super::Oxlintrc;

crates/oxc_linter/src/generated/assert_layouts.rs

@@ -5238,16 +5238,16 @@ function deserializeBoxTSExternalModuleReference(pos) {
   return deserializeTSExternalModuleReference(uint32[pos >> 2]);
 }
 
-function deserializeOptionNameSpan(pos) {
-  if (uint32[(pos + 8) >> 2] === 0 && uint32[(pos + 12) >> 2] === 0) return null;
-  return deserializeNameSpan(pos);
-}
-
 function deserializeU64(pos) {
   const pos32 = pos >> 2;
   return uint32[pos32] + uint32[pos32 + 1] * 4294967296;
 }
 
+function deserializeOptionNameSpan(pos) {
+  if (uint32[(pos + 8) >> 2] === 0 && uint32[(pos + 12) >> 2] === 0) return null;
+  return deserializeNameSpan(pos);
+}
+
 function deserializeOptionU64(pos) {
   if (uint8[pos] === 0) return null;
   return deserializeU64(pos + 8);

crates/oxc_linter/src/lib.rs

@@ -5369,16 +5369,16 @@ function deserializeBoxTSExternalModuleReference(pos) {
   return deserializeTSExternalModuleReference(uint32[pos >> 2]);
 }
 
-function deserializeOptionNameSpan(pos) {
-  if (uint32[(pos + 8) >> 2] === 0 && uint32[(pos + 12) >> 2] === 0) return null;
-  return deserializeNameSpan(pos);
-}
-
 function deserializeU64(pos) {
   const pos32 = pos >> 2;
   return uint32[pos32] + uint32[pos32 + 1] * 4294967296;
 }
 
+function deserializeOptionNameSpan(pos) {
+  if (uint32[(pos + 8) >> 2] === 0 && uint32[(pos + 12) >> 2] === 0) return null;
+  return deserializeNameSpan(pos);
+}
+
 function deserializeOptionU64(pos) {
   if (uint8[pos] === 0) return null;
   return deserializeU64(pos + 8);

napi/parser/generated/deserialize/js.js

@@ -13752,17 +13752,17 @@ function constructBoxTSExternalModuleReference(pos, ast) {
   return new TSExternalModuleReference(ast.buffer.uint32[pos >> 2], ast);
 }
 
-function constructOptionNameSpan(pos, ast) {
-  if (ast.buffer.uint32[(pos + 8) >> 2] === 0 && ast.buffer.uint32[(pos + 12) >> 2] === 0) return null;
-  return new NameSpan(pos, ast);
-}
-
 function constructU64(pos, ast) {
   const { uint32 } = ast.buffer,
     pos32 = pos >> 2;
   return uint32[pos32] + uint32[pos32 + 1] * 4294967296;
 }
 
+function constructOptionNameSpan(pos, ast) {
+  if (ast.buffer.uint32[(pos + 8) >> 2] === 0 && ast.buffer.uint32[(pos + 12) >> 2] === 0) return null;
+  return new NameSpan(pos, ast);
+}
+
 function constructOptionU64(pos, ast) {
   if (ast.buffer[pos] === 0) return null;
   return constructU64(pos + 8, ast);

napi/parser/generated/deserialize/ts.js

@@ -26,6 +26,10 @@ pub struct RawTransferData<'a> {
 }
 
 /// Metadata written to end of buffer.
+///
+/// Duplicated as `RawTransferMetadata2` in `crates/oxc_linter/src/lib.rs`.
+/// Any changes made here also need to be made there.
+/// `oxc_ast_tools` checks that the 2 copies are identical.
 #[ast]
 pub struct RawTransferMetadata {
     /// Offset of `RawTransferData` within buffer.