Don't emit unused rule warning if rule name begins with underscore

[sbillig]

Following rust's lead, it seems reasonable to stifle the 'unused' warning when the name starts with _.

My motivation for this change is that I like to define rules for testing a portion of a grammar, particularly while first writing the grammar.

For example,

stmt   =  { ... }
_stmts = _{ (stmt ~ NEWLINE+)* }

function   =  { ... }
_functions = { ... }

Then I define some rust tests that parse files using these rules.

#[dir_test(
    dir: "$CARGO_MANIFEST_DIR/test_files/syntax/stmts",
    glob: "*.sntn"
)]
fn test_stmts(fixture: Fixture<&str>) {
    test_rule(Rule::_stmts, fixture)
}

#[dir_test(
    dir: "$CARGO_MANIFEST_DIR/test_files/syntax/func",
    glob: "*.sntn"
)]
fn test_func(fixture: Fixture<&str>) {
    test_rule(Rule::_functions, fixture)
}

Summary by CodeRabbit

• Bug Fixes
  • Improved filtering logic to exclude names starting with an underscore, in addition to built-in names. This ensures a cleaner and more accurate analysis output.

[coderabbitai]

Walkthrough

The recent change in the Analysis implementation modifies the filtering logic to exclude names starting with an underscore, in addition to excluding names present in the BUILTINS list. This ensures that internal or private names (typically prefixed with an underscore) are not considered during analysis.

Changes

File Path	Change Summary
language-server/src/analysis.rs	Modified the filter condition in the Analysis implementation to exclude names starting with _.

Poem

In the code where logic flows,
A tweak was made, and now it shows.
Names with underscores, hidden away,
Join the BUILTINS, out of the fray.
Analysis clear, precise and bright,
The code now dances in the light. 🐇✨

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

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>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @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.

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 as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file 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.

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 036aa69 and 1b064b8.

Files selected for processing (1)

• language-server/src/analysis.rs (1 hunks)

Additional comments not posted (1)

language-server/src/analysis.rs (1)

122-122: Approve the change to filter condition.

Consider adding a comment explaining why rules starting with an underscore are ignored, to maintain clarity for future maintainers.

[Jamalam360]

Thanks