refactor(ast_node): Make AST enums non_exhaustive (#11115)

**Description:** This is the split of #11100. Since we need to add unknown variants to the ast enum, this requires a lot of code changes to handle non-exhaustive matches. I'm doing this in a separate PR for review.

Author: quininer

.changeset/smart-rats-smell.md

@@ -0,0 +1,5 @@
+---
+ast_node: major
+---
+
+refactor(ast): Make ast enum `non_exhaustive`

.github/workflows/CI.yml

@@ -354,6 +354,11 @@ jobs:
  run: |
  ./scripts/github/run-cargo-hack.sh ${{ matrix.settings.crate }}
 
+ - name: Check unknown variant with transforms
+ if: matrix.settings.crate == 'swc_ecma_transforms'
+ run: |
+ env RUSTFLAGS="--cfg swc_ast_unknown" cargo check -p ${{ matrix.settings.crate }} --features typescript,react,proposal,optimization,module,compat
+
  node-test:
  name: Test node bindings - ${{ matrix.os }}
  if: >-

crates/ast_node/src/lib.rs

@@ -158,29 +158,34 @@ pub fn ast_node(
  let mut item = TokenStream::new();
  match input.data {
  Data::Enum(..) => {
- struct EnumArgs {
- clone: bool,
- }
- impl parse::Parse for EnumArgs {
- fn parse(i: parse::ParseStream<'_>) -> syn::Result<Self> {
- let name: Ident = i.parse()?;
- if name != "no_clone" {
- return Err(i.error("unknown attribute"));
- }
- Ok(EnumArgs { clone: false })
+ use syn::parse::Parser;
+
+ let attrs = <syn::punctuated::Punctuated<syn::Ident, syn::Token![,]>>::parse_terminated
+ .parse(args)
+ .expect("failed to parse #[ast_node]");
+
+ let mut has_no_clone = false;
+ let mut has_no_unknown = false;
+ for attr in &attrs {
+ if attr == "no_clone" {
+ has_no_clone = true;
+ } else if attr == "no_unknown" {
+ has_no_unknown = true;
+ } else {
+ panic!("unknown attribute: {attr:?}")
  }
  }
- let args = if args.is_empty() {
- EnumArgs { clone: true }
- } else {
- parse(args).expect("failed to parse args of #[ast_node]")
- };
 
- let clone = if args.clone {
+ let clone = if !has_no_clone {
  Some(quote!(#[derive(Clone)]))
  } else {
  None
  };
+ let non_exhaustive = if !has_no_unknown {
+ Some(quote!(#[cfg_attr(swc_ast_unknown, non_exhaustive)]))
+ } else {
+ None
+ };
 
  item.extend(quote!(
  #[allow(clippy::derive_partial_eq_without_eq)]
@@ -198,6 +203,7 @@ pub fn ast_node(
  ::swc_common::DeserializeEnum,
  )]
  #clone
+ #non_exhaustive
  #[cfg_attr(
  feature = "rkyv-impl",
  derive(rkyv::Archive, rkyv::Serialize, rkyv::Deserialize)

crates/jsdoc/src/ast.rs

@@ -30,7 +30,6 @@ pub struct TagItem {
 }
 
 #[ast_node]
-#[non_exhaustive]
 pub enum Tag {
  #[tag("Yield")]
  Yield(YieldTag),

crates/swc_bundler/Cargo.toml

@@ -18,6 +18,9 @@ version = "32.0.0"
 [lib]
 bench = false
 
+[lints.rust]
+unexpected_cfgs = { level = "warn", check-cfg = ['cfg(swc_ast_unknown)'] }
+
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 [features]
 concurrent = ["swc_common/concurrent", "dashmap", "rayon", "indexmap/rayon"]

crates/swc_bundler/src/bundler/chunk/cjs.rs

@@ -140,6 +140,8 @@ fn wrap_module(
  unreachable!("module item found but is_es6 is false: {:?}", i)
  }
  ModuleItem::Stmt(s) => s,
+ #[cfg(swc_ast_unknown)]
+ _ => panic!("unable to access unknown nodes"),
  })
  .collect(),
  ..Default::default()
@@ -318,6 +320,8 @@ where
  .into();
  return;
  }
+ #[cfg(swc_ast_unknown)]
+ _ => panic!("unable to access unknown nodes"),
  }
  }
 

crates/swc_bundler/src/bundler/chunk/computed_key.rs

@@ -73,6 +73,8 @@ where
  ModuleExportName::Str(..) => {
  unimplemented!("module string names unimplemented")
  }
+ #[cfg(swc_ast_unknown)]
+ _ => panic!("unable to access unknown nodes"),
  };
  if ctx.transitive_remap.get(&exported.ctxt).is_some() {
  let specifier = ExportSpecifier::Named(ExportNamedSpecifier {
@@ -230,6 +232,8 @@ impl Fold for ExportToReturn {
  let decl = match item {
  ModuleItem::ModuleDecl(decl) => decl,
  ModuleItem::Stmt(_) => return item,
+ #[cfg(swc_ast_unknown)]
+ _ => panic!("unable to access unknown nodes"),
  };
 
  let stmt = match decl {
@@ -287,6 +291,8 @@ impl Fold for ExportToReturn {
  )
  }
  DefaultDecl::TsInterfaceDecl(_) => None,
+ #[cfg(swc_ast_unknown)]
+ _ => panic!("unable to access unknown nodes"),
  },
  ModuleDecl::ExportDefaultExpr(_) => None,
  ModuleDecl::ExportAll(export) => return export.into(),
@@ -308,6 +314,8 @@ impl Fold for ExportToReturn {
  Some(ModuleExportName::Str(..)) => {
  unimplemented!("module string names unimplemented")
  }
+ #[cfg(swc_ast_unknown)]
+ Some(_) => panic!("unable to access unknown nodes"),
  None => {
  if let ModuleExportName::Ident(orig) = &named.orig {
  self.export_id(orig.clone());
@@ -316,6 +324,8 @@ impl Fold for ExportToReturn {
  }
  }
  },
+ #[cfg(swc_ast_unknown)]
+ _ => panic!("unable to access unknown nodes"),
  }
  }
 
@@ -332,6 +342,8 @@ impl Fold for ExportToReturn {
  ModuleDecl::TsImportEquals(_) => None,
  ModuleDecl::TsExportAssignment(_) => None,
  ModuleDecl::TsNamespaceExport(_) => None,
+ #[cfg(swc_ast_unknown)]
+ _ => panic!("unable to access unknown nodes"),
  };
 
  if let Some(stmt) = stmt {

crates/swc_bundler/src/bundler/chunk/merge.rs

@@ -264,6 +264,8 @@ where
  ModuleExportName::Str(..) => {
  unimplemented!("module string names unimplemented")
  }
+ #[cfg(swc_ast_unknown)]
+ _ => panic!("unable to access unknown nodes"),
  };
 
  let id: Id = exported.into();
@@ -286,9 +288,13 @@ where
  ModuleExportName::Str(..) => {
  unimplemented!("module string names unimplemented")
  }
+ #[cfg(swc_ast_unknown)]
+ _ => panic!("unable to access unknown nodes"),
  }
  }
  }
+ #[cfg(swc_ast_unknown)]
+ _ => panic!("unable to access unknown nodes"),
  }
  }
  }
@@ -380,11 +386,15 @@ where
  Expr::Call(CallExpr { callee, .. }) => match callee {
  Callee::Super(_) | Callee::Import(_) => continue,
  Callee::Expr(v) => v,
+ #[cfg(swc_ast_unknown)]
+ _ => panic!("unable to access unknown nodes"),
  },
  Expr::Await(AwaitExpr { arg, .. }) => match &mut **arg {
  Expr::Call(CallExpr { callee, .. }) => match callee {
  Callee::Super(_) | Callee::Import(_) => continue,
  Callee::Expr(v) => v,
+ #[cfg(swc_ast_unknown)]
+ _ => panic!("unable to access unknown nodes"),
  },
  _ => continue,
  },
@@ -518,6 +528,8 @@ where
  ModuleExportName::Str(..) => {
  unimplemented!("module string names unimplemented")
  }
+ #[cfg(swc_ast_unknown)]
+ _ => panic!("unable to access unknown nodes"),
  };
  // Default is not exported via `export *`
  if &*exported.sym == "default" {
@@ -613,6 +625,8 @@ where
  ModuleExportName::Str(..) => {
  unimplemented!("module string names unimplemented")
  }
+ #[cfg(swc_ast_unknown)]
+ _ => panic!("unable to access unknown nodes"),
  };
  new.push(
  imported
@@ -665,6 +679,8 @@ where
  );
  }
  }
+ #[cfg(swc_ast_unknown)]
+ _ => panic!("unable to access unknown nodes"),
  }
  }
 
@@ -754,6 +770,8 @@ where
  }
  }
  DefaultDecl::TsInterfaceDecl(_) => continue,
+ #[cfg(swc_ast_unknown)]
+ _ => panic!("unable to access unknown nodes"),
  }
 
  // Create `export { local_default as default }`
@@ -926,6 +944,8 @@ where
  | Decl::TsEnum(_)
  | Decl::TsModule(_)
  | Decl::Using(..) => continue,
+ #[cfg(swc_ast_unknown)]
+ _ => panic!("unable to access unknown nodes"),
  };
 
  tracing::trace!(
@@ -1023,6 +1043,8 @@ where
  "module string names unimplemented"
  )
  }
+ #[cfg(swc_ast_unknown)]
+ _ => panic!("unable to access unknown nodes"),
  };
  }
  ExportSpecifier::Default(s) => {
@@ -1069,6 +1091,8 @@ where
  definite: Default::default(),
  });
  }
+ #[cfg(swc_ast_unknown)]
+ _ => panic!("unable to access unknown nodes"),
  }
  }
 
@@ -1101,6 +1125,8 @@ where
  ModuleExportName::Str(..) => {
  unimplemented!("module string names unimplemented")
  }
+ #[cfg(swc_ast_unknown)]
+ _ => panic!("unable to access unknown nodes"),
  };
  let orig_ident = match orig {
  ModuleExportName::Ident(ident) => ident,
@@ -1202,6 +1228,8 @@ where
  ModuleExportName::Str(..) => {
  unimplemented!("module string names unimplemented")
  }
+ #[cfg(swc_ast_unknown)]
+ _ => panic!("unable to access unknown nodes"),
  }
  }
  }
@@ -1262,6 +1290,8 @@ where
  ModuleExportName::Str(..) => {
  unimplemented!("module string names unimplemented")
  }
+ #[cfg(swc_ast_unknown)]
+ _ => panic!("unable to access unknown nodes"),
  };
  vars.push((
  module_id,
@@ -1317,6 +1347,8 @@ where
  continue;
  }
  }
+ #[cfg(swc_ast_unknown)]
+ _ => panic!("unable to access unknown nodes"),
  }
  }
 

crates/swc_bundler/src/bundler/export.rs

@@ -229,6 +229,8 @@ where
  ModuleExportName::Str(..) => {
  unimplemented!("module string names unimplemented")
  }
+ #[cfg(swc_ast_unknown)]
+ _ => panic!("unable to access unknown nodes"),
  };
  }
  ExportSpecifier::Default(d) => {
@@ -243,6 +245,8 @@ where
  ModuleExportName::Str(..) => {
  unimplemented!("module string names unimplemented")
  }
+ #[cfg(swc_ast_unknown)]
+ _ => panic!("unable to access unknown nodes"),
  };
  if let Some((_, export_ctxt)) = ctxt {
  orig.ctxt = export_ctxt;
@@ -255,6 +259,8 @@ where
  Some(ModuleExportName::Str(..)) => {
  unimplemented!("module string names unimplemented")
  }
+ #[cfg(swc_ast_unknown)]
+ Some(_) => panic!("unable to access unknown nodes"),
  None => {
  let mut exported: Ident = orig.clone();
  exported.ctxt = self.export_ctxt;
@@ -280,6 +286,8 @@ where
  }
  }
  }
+ #[cfg(swc_ast_unknown)]
+ _ => panic!("unable to access unknown nodes"),
  }
  }