Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add validation for tags on silent rules (fixes #1035) #1036

Merged
merged 1 commit into from
Sep 6, 2024

Conversation

tomtau
Copy link
Contributor

@tomtau tomtau commented Sep 4, 2024

Summary by CodeRabbit

  • New Features

    • Enhanced validation process for parser rules, including checks for silent and built-in rules.
    • Introduced new error handling for inappropriate tag usage on silent rules.
  • Bug Fixes

    • Updated multiple packages and dependencies to version 2.7.12, ensuring compatibility and potential bug fixes.
  • Documentation

    • Added comments to clarify parsing logic in the ParserState struct.
  • Style

    • Suppressed warnings for unused structs by adding #[allow(dead_code)] attribute to the Paren struct.

@tomtau tomtau requested a review from a team as a code owner September 4, 2024 09:55
@tomtau tomtau requested review from NoahTheDuke and removed request for a team September 4, 2024 09:55
Copy link
Contributor

coderabbitai bot commented Sep 4, 2024

Walkthrough

The changes involve version updates across multiple Cargo.toml files for various packages in the pest ecosystem, incrementing the version from 2.7.11 to 2.7.12. Additionally, the meta/src/validator.rs file introduces a new function for enhanced validation of parser rules, while other files include minor adjustments such as comments and attribute additions without altering core functionality.

Changes

Files Change Summary
debugger/Cargo.toml Version updated from 2.7.11 to 2.7.12 for the package and dependencies.
derive/Cargo.toml Version updated from 2.7.11 to 2.7.12 for the package and dependencies.
generator/Cargo.toml Version updated from 2.7.11 to 2.7.12 for the package and dependencies.
grammars/Cargo.toml Version updated from 2.7.11 to 2.7.12 for the package and dependencies.
meta/Cargo.toml Version updated from 2.7.11 to 2.7.12 for the package and dependency.
vm/Cargo.toml Version updated from 2.7.11 to 2.7.12 for the package and dependencies.
meta/src/validator.rs New function validate_tag_silent_rules added for enhanced validation.
pest/Cargo.toml Version updated from 2.7.11 to 2.7.12.
pest/examples/parens.rs Added #[allow(dead_code)] attribute to Paren struct.
pest/src/error.rs Removed position:: prefix from Position type in tests.
pest/src/parser_state.rs Added comment for clarity on parsing logic.

Sequence Diagram(s)

sequenceDiagram
    participant Validator
    participant Rules
    participant Errors

    Validator->>Rules: Validate AST
    alt Check Silent Rules
        Validator->>Errors: Collect Errors
        Errors-->>Validator: Return Error List
    end
Loading

🐇 In the land of code, where changes bloom,
New versions sprout, dispelling the gloom.
With tags and rules, we hop and play,
Enhancing our grammar in a joyful way!
So let’s celebrate, with a leap and a cheer,
For every small change brings progress near! 🌼


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
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 using 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.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration 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.

@tomtau tomtau linked an issue Sep 4, 2024 that may be closed by this pull request
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 537660c and 1d4dc46.

Files selected for processing (11)
  • debugger/Cargo.toml (2 hunks)
  • derive/Cargo.toml (2 hunks)
  • generator/Cargo.toml (2 hunks)
  • grammars/Cargo.toml (2 hunks)
  • meta/Cargo.toml (2 hunks)
  • meta/src/validator.rs (3 hunks)
  • pest/Cargo.toml (1 hunks)
  • pest/examples/parens.rs (1 hunks)
  • pest/src/error.rs (13 hunks)
  • pest/src/parser_state.rs (1 hunks)
  • vm/Cargo.toml (2 hunks)
Files skipped from review due to trivial changes (9)
  • debugger/Cargo.toml
  • derive/Cargo.toml
  • generator/Cargo.toml
  • grammars/Cargo.toml
  • pest/Cargo.toml
  • pest/examples/parens.rs
  • pest/src/error.rs
  • pest/src/parser_state.rs
  • vm/Cargo.toml
Additional comments not posted (7)
meta/Cargo.toml (2)

4-4: LGTM!

The version update is approved.


25-25: LGTM!

The version update is approved.

meta/src/validator.rs (5)

229-230: LGTM!

The code changes are approved.


240-310: LGTM!

The new validate_tag_silent_rules function looks good:

  • It is conditionally compiled based on the grammar-extras feature flag.
  • It constructs a hash map of parser rules and their types for efficient lookups.
  • It recursively checks the parser expressions for tags on silent or built-in rules and generates appropriate error messages.

The implementation looks solid and serves the purpose of validating tags on silent and built-in rules effectively.


1873-1889: LGTM!

The new test case tag_on_silent_rule looks good:

  • It is conditionally compiled based on the grammar-extras feature flag.
  • It verifies that using a tag on a silent rule generates an appropriate error message.

The test case ensures the correct behavior of the new validation functionality.


1891-1906: LGTM!

The new test case tag_on_builtin_rule looks good:

  • It is conditionally compiled based on the grammar-extras feature flag.
  • It verifies that using a tag on a built-in rule generates an appropriate error message.

The test case ensures the correct behavior of the new validation functionality.


1908-1915: LGTM!

The new test case tag_on_normal_rule looks good:

  • It is conditionally compiled based on the grammar-extras feature flag.
  • It verifies that using a tag on a normal rule is allowed and does not generate any errors.

The test case ensures the correct behavior of the new validation functionality.

@tomtau tomtau merged commit da3fcfe into pest-parser:master Sep 6, 2024
9 checks passed
@tomtau tomtau deleted the validate-tags branch September 6, 2024 14:23
@coderabbitai coderabbitai bot mentioned this pull request Dec 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Tags do not apply to silent rules
1 participant