poc: use oxc as alternative parser
Summary by CodeRabbit
-
New Features
- Introduced a new command-line tool for searching AST pattern matches in JavaScript/TypeScript source files using Oxc integration.
- Added support for parsing, traversing, and pattern matching on JavaScript/TypeScript code via Oxc bindings.
-
Chores
- Added a new crate manifest for Oxc integration with ast-grep.
-
Refactor
- Updated trait methods to provide default implementations, reducing the need for manual overrides.
Walkthrough
This update introduces a new Rust crate for integrating Oxc (a JavaScript/TypeScript parser) with the ast-grep framework. It adds a Cargo manifest, implements Oxc language bindings, provides AST node and document abstractions, and supplies a command-line tool for searching AST patterns in source files. Additionally, default trait method implementations are added to the core SgNode trait.
Changes
| File(s) | Change Summary |
|---|---|
| crates/core/src/source.rs | Added default (no-op) implementations for field, field_children, and child_by_field_id in the SgNode trait. |
| crates/oxc/Cargo.toml | Introduced a new Cargo manifest for the ast-grep-oxc crate, specifying dependencies and metadata. |
| crates/oxc/src/main.rs | Added a CLI entry point to parse a file, compile an AST pattern, and print matches using Oxc and ast-grep integration. |
| crates/oxc/src/binding.rs | Added Oxc language bindings: defines OxcLang, OxcNode, OxcDoc; implements AST traversal, parsing, and error handling. |
Sequence Diagram(s)
sequenceDiagram
participant User
participant CLI (main.rs)
participant OxcDoc
participant OxcLang
participant AstGrep
participant Pattern
User->>CLI (main.rs): Provide file path & pattern
CLI (main.rs)->>OxcLang: Create language from file extension
CLI (main.rs)->>OxcDoc: Parse source text to AST document
OxcDoc->>OxcLang: Use parser & semantic analysis
CLI (main.rs)->>AstGrep: Create from OxcDoc
CLI (main.rs)->>Pattern: Compile pattern string
CLI (main.rs)->>AstGrep: Search root node with pattern
AstGrep->>CLI (main.rs): Return matches
CLI (main.rs)->>User: Print matched texts
Poem
In the warren, code takes flight,
Oxc and grep now join their might.
Patterns searched through JavaScript trees,
With Rusty paws, we parse with ease.
Default traits, new crates appear—
Hopping forward, spring is here!
🐇✨
[!NOTE]
⚡️ AI Code Reviews for VS Code, Cursor, Windsurf
CodeRabbit now has a plugin for VS Code, Cursor and Windsurf. This brings AI code reviews directly in the code editor. Each commit is reviewed immediately, finding bugs before the PR is raised. Seamless context handoff to your AI code agent ensures that you can easily incorporate review feedback. Learn more here.
✨ Finishing Touches
- [ ] 📝 Generate Docstrings
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.
🪧 Tips
Chat
There are 3 ways to chat with CodeRabbit:
- Review comments: Directly reply to a review comment made by CodeRabbit. Example:
-
I pushed a fix in commit <commit_id>, please review it. -
Explain this complex logic. -
Open a follow-up GitHub issue for this discussion.
-
- Files and specific lines of code (under the "Files changed" tab): Tag
@coderabbitaiin a new review comment at the desired location with your query. Examples:-
@coderabbitai explain this code block. -
@coderabbitai modularize this function.
-
- PR comments: Tag
@coderabbitaiin a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:-
@coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase. -
@coderabbitai read src/utils.ts and explain its main purpose. -
@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format. -
@coderabbitai help me debug CodeRabbit configuration file.
-
Support
Need help? Create a ticket on our support page for assistance with any issues or questions.
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.
CodeRabbit Commands (Invoked using PR comments)
-
@coderabbitai pauseto pause the reviews on a PR. -
@coderabbitai resumeto resume the paused reviews. -
@coderabbitai reviewto trigger an incremental review. This is useful when automatic reviews are disabled for the repository. -
@coderabbitai full reviewto do a full review from scratch and review all the files again. -
@coderabbitai summaryto regenerate the summary of the PR. -
@coderabbitai generate docstringsto generate docstrings for this PR. -
@coderabbitai generate sequence diagramto generate a sequence diagram of the changes in this PR. -
@coderabbitai resolveresolve all the CodeRabbit review comments. -
@coderabbitai configurationto show the current CodeRabbit configuration for the repository. -
@coderabbitai helpto get help.
Other keywords and placeholders
- Add
@coderabbitai ignoreanywhere in the PR description to prevent this PR from being reviewed. - Add
@coderabbitai summaryto generate the high-level summary at a specific location in the PR description. - Add
@coderabbitaianywhere in the PR title to generate the title automatically.
CodeRabbit Configuration File (.coderabbit.yaml)
- You can programmatically configure CodeRabbit by adding a
.coderabbit.yamlfile to the root of your repository. - Please see the configuration documentation for more information.
- If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation:
# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json
Documentation and Community
- Visit our Documentation for detailed information on how to use CodeRabbit.
- Join our Discord Community to get help, request features, and share feedback.
- Follow us on X/Twitter for updates and announcements.
Codecov Report
:x: Patch coverage is 0% with 337 lines in your changes missing coverage. Please review.
:white_check_mark: Project coverage is 84.86%. Comparing base (646c5a8) to head (6a92e81).
:warning: Report is 371 commits behind head on main.
| Files with missing lines | Patch % | Lines |
|---|---|---|
| crates/oxc/src/binding.rs | 0.00% | 313 Missing :warning: |
| crates/oxc/src/main.rs | 0.00% | 15 Missing :warning: |
| crates/core/src/source.rs | 0.00% | 9 Missing :warning: |
Additional details and impacted files
@@ Coverage Diff @@
## main #1970 +/- ##
==========================================
- Coverage 86.64% 84.86% -1.79%
==========================================
Files 100 102 +2
Lines 16046 16383 +337
==========================================
Hits 13903 13903
- Misses 2143 2480 +337
:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.
:rocket: New features to boost your workflow:
- :snowflake: Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
- :package: JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.
Question: Would we expose the underlying rust types, similar to how we do with the tree-sitter nodes?
It's quite handy to be able to access the underlying nodes (if needed) in the Rust crates 😄
Would we expose the underlying rust types
Yes https://github.com/ast-grep/ast-grep/blob/4eae15153d230b31e5a73aa87c66076ddc434e9a/crates/core/src/node.rs#L179-L182
@HerringtonDarkholme Curious, is this closed because it's no longer desired / a direction that will be followed; or is there a new issue / PR I should watch for updates?