--- name: ast-grep-1d356580b6d3 description: Guide for writing ast-grep rules to perform structural code search and analysis. Use when users need to search codebases using Abstract Syntax Tree (AST) patterns, find specific code structures, or perform complex code queries that go beyond simple text search. This skill should be used when users ask to search for code patterns, find specific language constructs, or locate code with particular structural characteristics. --- # ast-grep Code Search ## Overview This skill helps translate natural language queries into ast-grep rules for structural code search. ast-grep uses Abstract Syntax Tree (AST) patterns to match code based on its structure rather than just text, enabling powerful and precise code search across large codebases. ## When to Use This Skill Use this skill when users: - Need to search for code patterns using structural matching (e.g., "find all async functions that don't have error handling") - Want to locate specific language constructs (e.g., "find all function calls with specific parameters") - Request searches that require understanding code structure rather than just text - Ask to search for code with particular AST characteristics - Need to perform complex code queries that traditional text search cannot handle ## General Workflow Follow this process to help users write effective ast-grep rules: ### Step 1: Understand the Query Clearly understand what the user wants to find. Ask clarifying questions if needed: - What specific code pattern or structure are they looking for? - Which programming language? - Are there specific edge cases or variations to consider? - What should be included or excluded from matches? ### Step 2: Create Example Code Write a simple code snippet that represents what the user wants to match. Save this to a temporary file for testing. **Example:** If searching for "async functions that use await", create a test file: ```javascript // test_example.js async function example() { const result = await fetchData(); return result; } ``` ### Step 3: Write the ast-grep Rule Translate the pattern into an ast-grep rule. Start simple and add complexity as needed. **Key principles:** - Always use `stopBy: end` for relational rules (`inside`, `has`) to ensure search goes to the end of the direction - Use `pattern` for simple structures - Use `kind` with `has`/`inside` for complex structures - Break complex queries into smaller sub-rules using `all`, `any`, or `not` **Example rule file (test_rule.yml):** ```yaml id: async-with-await language: javascript rule: kind: function_declaration has: pattern: await $EXPR stopBy: end ``` See `references/rule_reference.md` for comprehensive rule documentation. ### Step 4: Test the Rule Use ast-grep CLI to verify the rule matches the example code. There are two main approaches: **Option A: Test with inline rules (for quick iterations)** ```bash echo "async function test() { await fetch(); }" | ast-grep scan --inline-rules "id: test language: javascript rule: kind: function_declaration has: pattern: await \$EXPR stopBy: end" --stdin ``` **Option B: Test with rule files (recommended for complex rules)** ```bash ast-grep scan --rule test_rule.yml test_example.js ``` **Debugging if no matches:** 1. Simplify the rule (remove sub-rules) 2. Add `stopBy: end` to relational rules if not present 3. Use `--debug-query` to understand the AST structure (see below) 4. Check if `kind` values are correct for the language ### Step 5: Search the Codebase Once the rule matches the example code correctly, search the actual codebase: **For simple pattern searches:** ```bash ast-grep run --pattern 'console.log($ARG)' --lang javascript /path/to/project ``` **For complex rule-based searches:** ```bash ast-grep scan --rule my_rule.yml /path/to/project ``` **For inline rules (without creating files):** ```bash ast-grep scan --inline-rules "id: my-rule language: javascript rule: pattern: \$PATTERN" /path/to/project ``` ## ast-grep CLI Commands ### Inspect Code Structure (--debug-query) Dump the AST structure to understand how code is parsed: ```bash ast-grep run --pattern 'async function example() { await fetch(); }' \ --lang javascript \ --debug-query=cst ``` **Available formats:** - `cst`: Concrete Syntax Tree (shows all nodes including punctuation) - `ast`: Abstract Syntax Tree (shows only named nodes) - `pattern`: Shows how ast-grep interprets your pattern **Use this to:** - Find the correct `kind` values for nodes - Understand the structure of code you want to match - Debug why patterns aren't matching **Example:** ```bash # See the structure of your target code ast-grep run --pattern 'class User { constructor() {} }' \ --lang javascript \ --debug-query=cst # See how ast-grep interprets your pattern ast-grep run --pattern 'class $NAME { $$$BODY }' \ --lang javascript \ --debug-query=pattern ``` ### Test Rules (scan with --stdin) Test a rule against code snippet without creating files: ```bash echo "const x = await fetch();" | ast-grep scan --inline-rules "id: test language: javascript rule: pattern: await \$EXPR" --stdin ``` **Add --json for structured output:** ```bash echo "const x = await fetch();" | ast-grep scan --inline-rules "..." --stdin --json ``` ### Search with Patterns (run) Simple pattern-based search for single AST node matches: ```bash # Basic pattern search ast-grep run --pattern 'console.log($ARG)' --lang javascript . # Search specific files ast-grep run --pattern 'class $NAME' --lang python /path/to/project # JSON output for programmatic use ast-grep run --pattern 'function $NAME($$$)' --lang javascript --json . ``` **When to use:** - Simple, single-node matches - Quick searches without complex logic - When you don't need relational rules (inside/has) ### Search with Rules (scan) YAML rule-based search for complex structural queries: ```bash # With rule file ast-grep scan --rule my_rule.yml /path/to/project # With inline rules ast-grep scan --inline-rules "id: find-async language: javascript rule: kind: function_declaration has: pattern: await \$EXPR stopBy: end" /path/to/project # JSON output ast-grep scan --rule my_rule.yml --json /path/to/project ``` **When to use:** - Complex structural searches - Relational rules (inside, has, precedes, follows) - Composite logic (all, any, not) - When you need the power of full YAML rules **Tip:** For relational rules (inside/has), always add `stopBy: end` to ensure complete traversal. ## Tips for Writing Effective Rules ### Always Use stopBy: end For relational rules, always use `stopBy: end` unless there's a specific reason not to: ```yaml has: pattern: await $EXPR stopBy: end ``` This ensures the search traverses the entire subtree rather than stopping at the first non-matching node. ### Start Simple, Then Add Complexity Begin with the simplest rule that could work: 1. Try a `pattern` first 2. If that doesn't work, try `kind` to match the node type 3. Add relational rules (`has`, `inside`) as needed 4. Combine with composite rules (`all`, `any`, `not`) for complex logic ### Use the Right Rule Type - **Pattern**: For simple, direct code matching (e.g., `console.log($ARG)`) - **Kind + Relational**: For complex structures (e.g., "function containing await") - **Composite**: For logical combinations (e.g., "function with await but not in try-catch") ### Debug with AST Inspection When rules don't match: 1. Use `--debug-query=cst` to see the actual AST structure 2. Check if metavariables are being detected correctly 3. Verify the node `kind` matches what you expect 4. Ensure relational rules are searching in the right direction ### Escaping in Inline Rules When using `--inline-rules`, escape metavariables in shell commands: - Use `\$VAR` instead of `$VAR` (shell interprets `$` as variable) - Or use single quotes: `'$VAR'` works in most shells **Example:** ```bash # Correct: escaped $ ast-grep scan --inline-rules "rule: {pattern: 'console.log(\$ARG)'}" . # Or use single quotes ast-grep scan --inline-rules 'rule: {pattern: "console.log($ARG)"}' . ``` ## Common Use Cases ### Find Functions with Specific Content Find async functions that use await: ```bash ast-grep scan --inline-rules "id: async-await language: javascript rule: all: - kind: function_declaration - has: pattern: await \$EXPR stopBy: end" /path/to/project ``` ### Find Code Inside Specific Contexts Find console.log inside class methods: ```bash ast-grep scan --inline-rules "id: console-in-class language: javascript rule: pattern: console.log(\$\$\$) inside: kind: method_definition stopBy: end" /path/to/project ``` ### Find Code Missing Expected Patterns Find async functions without try-catch: ```bash ast-grep scan --inline-rules "id: async-no-trycatch language: javascript rule: all: - kind: function_declaration - has: pattern: await \$EXPR stopBy: end - not: has: pattern: try { \$\$\$ } catch (\$E) { \$\$\$ } stopBy: end" /path/to/project ``` ## Resources ### references/ Contains detailed documentation for ast-grep rule syntax: - `rule_reference.md`: Comprehensive ast-grep rule documentation covering atomic rules, relational rules, composite rules, and metavariables Load these references when detailed rule syntax information is needed. --- Source attribution: David-Li0406 Original project: https://github.com/David-Li0406/meta-skill-evloving/blob/ca3a335628981df10c36e00cb9850df2c247ab9a/skill-flow/data/skills-refined-36k/skillsmp/ast-grep-3/SKILL.md License: Apache-2.0 License information: https://www.apache.org/licenses/LICENSE-2.0 Original upstream instructions; downloaded from Mega AI Hub. ## Upstream license notice Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. # Mega AI Hub resource metadata Creator / publisher: David-Li0406 Original project: https://github.com/David-Li0406/meta-skill-evloving/blob/ca3a335628981df10c36e00cb9850df2c247ab9a/skill-flow/data/skills-refined-36k/skillsmp/ast-grep-3/SKILL.md Attribution basis: Source repository record Fields of work: Content & Media, Development & Engineering Roles: Backend Developer, Data Engineer, DevOps / SRE, QA / Test Engineer, Technical Writer Specialties: API, Backend Tools: Ast Grep Country applicability: Country not specified Classification basis: Source catalog labels Instruction SHA-256: 3856e10876e094f3048ac4dabddf3675b830e78455667af8b46c14a2cb582594