gritql
gritql copied to clipboard
refactor!: drop `DEFAULT_FILE_NAME`
This rids us of the magic DEFAULT_FILE_NAME constant. Places where the absence of a file name should be considered have their types changed from String to Option<PathBuf>.
Be careful merging this PR. Consumers should be updated accordingly.
Summary by CodeRabbit
-
New Features
- Enhanced error log formatting to include more contextual information based on file presence.
-
Bug Fixes
- Improved path resolution logic in various compiler functions to handle file paths more accurately.
-
Refactor
- Updated various modules to use
PathandOption<Path>types for file handling, replacing default file name constants for increased flexibility and clarity.
- Updated various modules to use
-
Documentation
- Removed outdated constants and updated function signatures to reflect new implementations in error handling and file path management.
-
Chores
- Removed unused imports and constants across multiple modules to streamline codebase and improve maintenance.
Walkthrough
Walkthrough
The updates across various modules primarily focus on refining file handling and error logging mechanisms. Key changes include the elimination of default file names in favor of optional paths, enhancing flexibility and accuracy in file-related operations. Additionally, there's a shift towards more modern and concise syntax in map insertions and function parameter types, streamlining the codebase and improving maintainability.
Changes
| File(s) | Summary |
|---|---|
.../result_formatting.rs, .../analysis_logs.rs |
Adjusted error logging and file handling, removing default names and using optional paths. |
.../analysis.rs, .../built_in_functions.rs, .../paths.rs, .../pattern_compiler/... |
Updated function parameters and internal logic to handle paths more flexibly and accurately. |
.../constants.rs, grit-pattern-matcher/src/constants.rs |
Removed the DEFAULT_FILE_NAME constant, introduced MAX_FILE_SIZE. |
.../pattern_compiler/..., .../variables.rs, grit-pattern-matcher/src/pattern/variable.rs |
Enhanced handling of file paths in variable and pattern compilation contexts, shifting from fixed strings to optional path structures. |
.../language.rs, .../grit_parser.rs |
Modified error handling functions to accommodate optional path parameters, improving error specificity. |
Recent Review Details
Configuration used: .coderabbit.yaml Review profile: CHILL
Commits
Files that changed from the base of the PR and between d38f5c6575d5774d4508bdc4aea099280e139ad7 and b694c5ee030d361d1fa291b3879ff48bb5fc4ec7.Files selected for processing (4)
- crates/core/src/built_in_functions.rs (2 hunks)
- crates/core/src/pattern_compiler/builder.rs (6 hunks)
- crates/core/src/pattern_compiler/compiler.rs (8 hunks)
- crates/language/src/language.rs (1 hunks)
Files skipped from review as they are similar to previous changes (3)
- crates/core/src/built_in_functions.rs
- crates/core/src/pattern_compiler/compiler.rs
- crates/language/src/language.rs
Additional comments not posted (3)
crates/core/src/pattern_compiler/builder.rs (3)
Line range hint
93-118: Changes in thestartmethod align with the PR's objectives to handle file paths more flexibly.
204-204: Setting thefilefield toNonein theCompilationContextis consistent with the PR's objectives to eliminate default file handling.
266-266: Setting thefilefield toNonein theCompilationContextused in thematches_callbackmethod supports the PR's objectives to eliminate default file handling.
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?
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
@coderabbitaiin 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
@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 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 pauseto pause the reviews on a PR.@coderabbitai resumeto resume the paused reviews.@coderabbitai reviewto trigger a review. This is useful when automatic reviews are disabled for the repository.@coderabbitai resolveresolve all the CodeRabbit review comments.@coderabbitai helpto 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.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.
I think this is going to break the studio in the web app, where we rely on this constant to represent the pattern file.
Yeah we'll need to do some internal adjustment before landing this, to look for an anonymous pattern file.