docs(semantic): make doc tests for AstNode::contains_any etc runnable (#13595)

overlookmotel · overlookmotel · commit 5dc82ff1ea93 · 2025-09-08T12:08:01.000Z
Follow-on after #13137. That PR added methods to `AstNodes`, and doc comments include examples. Make those examples into proper runnable doctests, and fix them (`AstType::ExportDeclaration` doesn't exist).
diff --git a/crates/oxc_semantic/src/node.rs b/crates/oxc_semantic/src/node.rs
@@ -253,44 +253,68 @@ impl<'a> AstNodes<'a> {
 
     /// Checks if the AST contains any nodes of the given types.
     ///
-    /// Example:
-    /// ```ignore
+    /// ## Example
+    /// ```
+    /// # fn get_nodes<'a>() -> AstNodes<'a> { AstNodes::default() }
+    ///
+    /// use oxc_ast::AstType;
+    /// use oxc_semantic::{AstNodes, AstTypesBitset};
+    ///
     /// let for_stmt = AstTypesBitset::from_types(&[AstType::ForStatement]);
-    /// let import_export_decl = AstTypesBitset::from_types(&[AstType::ImportDeclaration, AstType::ExportDeclaration]);
+    /// let import_export_decl = AstTypesBitset::from_types(&[
+    ///   AstType::ImportDeclaration,
+    ///   AstType::ExportNamedDeclaration,
+    /// ]);
     ///
-    /// // returns true if there is a `for` loop anywhere in the AST.
-    /// nodes.contains_any(&for_stmt)
-    /// // returns true if there is at least one import OR one export in the AST.
-    /// nodes.contains_any(&import_export_decl)
+    /// let nodes: AstNodes = get_nodes();
+    /// // `true` if there is a `for` loop anywhere in the AST
+    /// nodes.contains_any(&for_stmt);
+    /// // `true` if there is at least one import OR one export in the AST
+    /// nodes.contains_any(&import_export_decl);
     /// ```
     pub fn contains_any(&self, bitset: &AstTypesBitset) -> bool {
         self.node_kinds_set.intersects(bitset)
     }
 
     /// Checks if the AST contains all of the given types.
     ///
-    /// Example:
-    /// ```ignore
+    /// ## Example
+    /// ```
+    /// # fn get_nodes<'a>() -> AstNodes<'a> { AstNodes::default() }
+    ///
+    /// use oxc_ast::AstType;
+    /// use oxc_semantic::{AstNodes, AstTypesBitset};
+    ///
     /// let for_stmt = AstTypesBitset::from_types(&[AstType::ForStatement]);
-    /// let import_export_decl = AstTypesBitset::from_types(&[AstType::ImportDeclaration, AstType::ExportDeclaration]);
+    /// let import_export_decl = AstTypesBitset::from_types(&[
+    ///   AstType::ImportDeclaration,
+    ///   AstType::ExportNamedDeclaration,
+    /// ]);
     ///
-    /// // returns true if there is a `for` loop anywhere in the AST.
-    /// nodes.contains_all(&for_stmt)
-    /// // returns true only if there is at least one import AND one export in the AST.
-    /// nodes.contains_all(&import_export_decl)
+    /// let nodes: AstNodes = get_nodes();
+    /// // `true` if there is a `for` loop anywhere in the AST
+    /// nodes.contains_all(&for_stmt);
+    /// // `true` if there is at least one import AND one export in the AST
+    /// nodes.contains_all(&import_export_decl);
     /// ```
     pub fn contains_all(&self, bitset: &AstTypesBitset) -> bool {
         self.node_kinds_set.contains(bitset)
     }
 
     /// Checks if the AST contains a node of the given type.
     ///
-    /// Example:
-    /// ```ignore
-    /// // returns true if there is a `for` loop anywhere in the AST.
-    /// nodes.contains(AstType::ForStatement)
-    /// // returns true if there is an `ImportDeclaration` anywhere in the AST.
-    /// nodes.contains(AstType::ImportDeclaration)
+    /// ## Example
+    /// ```
+    /// # fn get_nodes<'a>() -> AstNodes<'a> { AstNodes::default() }
+    ///
+    /// use oxc_ast::AstType;
+    /// use oxc_semantic::{AstNodes, AstTypesBitset};
+    ///
+    /// let nodes: AstNodes = get_nodes();
+    /// // `true` if there is a `for` loop anywhere in the AST
+    /// nodes.contains(AstType::ForStatement);
+    /// // `true` if there is an `ImportDeclaration` anywhere in the AST
+    /// nodes.contains(AstType::ImportDeclaration);
     /// ```
     pub fn contains(&self, ty: AstType) -> bool {
         self.node_kinds_set.has(ty)
