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

chore: move alternate_metavariable_kinds around #314

Merged
merged 1 commit into from
May 6, 2024

Conversation

arendjr
Copy link
Contributor

@arendjr arendjr commented May 6, 2024

This is a tiny PR to make sure alternate_metavariable_kinds() is no longer exposed as a method on the Language trait. The main motivation is that the return value of the method is a string kind of TreeSitter nodes.

Fortunately this functionality is only used for JS-like languages, so it was easily moved to become an implementation detail implemented in the js_like_is_metavariable function.

Summary by CodeRabbit

  • Refactor
    • Simplified metavariable checks across various programming language implementations to improve consistency and performance.
  • Bug Fixes
    • Adjusted logic in metavariable identification to prevent incorrect flagging, enhancing accuracy in code analysis tools.
  • New Features
    • Introduced a unified approach for identifying metavariables in JavaScript-like languages, supporting more robust language processing capabilities.

@arendjr arendjr requested a review from a team as a code owner May 6, 2024 13:36
Copy link
Contributor

coderabbitai bot commented May 6, 2024

Walkthrough

Walkthrough

The updates across various files in the crates/language repository focus on simplifying and unifying the way metavariables are handled in JavaScript-like languages. The key change is the removal of alternate_metavariable_kinds across multiple language implementations, centralizing the logic into a new function js_like_is_metavariable. This function now uniformly handles metavariable checks, enhancing maintainability and consistency across TypeScript, JavaScript, and TSX.

Changes

File Path Summary of Changes
.../grit-util/src/language.rs Removed alternate_metavariable_kinds from the Language trait.
.../language/src/{javascript, tsx, typescript}.rs Refactored is_metavariable to use new js_like_is_metavariable function. Removed alternate_metavariable_kinds.
.../language/src/js_like.rs Added js_like_is_metavariable function to centralize metavariable checking.
.../language/src/language.rs Simplified is_metavariable_node in MarzanoLanguage trait.
.../language/src/target_language.rs Integrated logic of alternate_metavariable_kinds into metavariable_prefix in macro.

Recent Review Details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits Files that changed from the base of the PR and between 306d7ca and b96dcba.
Files selected for processing (7)
  • crates/grit-util/src/language.rs (1 hunks)
  • crates/language/src/javascript.rs (2 hunks)
  • crates/language/src/js_like.rs (1 hunks)
  • crates/language/src/language.rs (1 hunks)
  • crates/language/src/target_language.rs (1 hunks)
  • crates/language/src/tsx.rs (3 hunks)
  • crates/language/src/typescript.rs (3 hunks)
Additional comments not posted (7)
crates/grit-util/src/language.rs (1)

Line range hint 1-1: Removal of alternate_metavariable_kinds from Language trait aligns with the PR's objectives of better encapsulation.

crates/language/src/typescript.rs (1)

109-113: Updated is_metavariable to use js_like_is_metavariable enhances maintainability by centralizing metavariable logic.

crates/language/src/javascript.rs (1)

113-113: Use of js_like_is_metavariable in is_metavariable method correctly handles JavaScript-specific metavariable kinds.

crates/language/src/js_like.rs (1)

94-105: The js_like_is_metavariable function is well-implemented, providing a comprehensive approach to identifying metavariables in JS-like languages.

crates/language/src/tsx.rs (1)

113-117: Use of js_like_is_metavariable in is_metavariable method correctly handles TSX-specific metavariable kinds.

crates/language/src/language.rs (1)

345-345: Ensure the new implementation of is_metavariable_node correctly checks for metavariables.

This change simplifies the method by directly checking if the node is named and matches the metavariable sort, aligning with the PR's goal to streamline metavariable handling.

crates/language/src/target_language.rs (1)

Line range hint 1-1: No specific changes detected in target_language.rs related to PR objectives.

This file appears to be unchanged in the context of the PR objectives. Ensure any necessary updates are made if they are indirectly affected by changes in other files.


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.

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 a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @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.

@morgante morgante merged commit 3772e3c into getgrit:main May 6, 2024
6 checks passed
This was referenced May 14, 2024
@github-actions github-actions bot mentioned this pull request May 29, 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.

2 participants