search

magicant / yash-rs

Reimplementation of yash, an extended POSIX shell
64 stars 3 forks source link

Improve parameter expansion error message #385

Closed magicant closed 2 months ago

magicant commented 2 months ago

Summary by CodeRabbit

coderabbitai[bot] commented 2 months ago

Walkthrough

The changes primarily involve improving error handling and message clarity across multiple modules of the yash project. Key updates include expanding ErrorCause and Error structures for more detailed error messages, refining error handling for unset variables and parameters, and updating CHANGELOG and README files to reflect these changes. Some modifications were also made to handle errors related to built-in commands and parameter expansion more effectively.

Changes

File(s) Change Summary
check-release.sh Modified to check for the release date in multiple CHANGELOG files instead of just one.
yash-cli/CHANGELOG-bin.md, yash-cli/CHANGELOG-lib.md Updated changelogs to document changes specific to the shell binary and the library crate.
yash-cli/README.md Updated links to point to separate changelog files for the shell binary and the library crate.
yash-builtin/src/typeset.rs Added a new field vacancy to the AssignReadOnlyError trait implementation.
yash-semantics/CHANGELOG.md Documented extensions to error types and methods for better error messages.
yash-semantics/src/expansion.rs Modified ErrorCause enum to include the parameter name in error messages. Deprecated related_location method.
yash-semantics/src/expansion/initial/arith.rs Added name field to UnsetVariable struct and adjusted related error handling. Updated tests accordingly.
yash-semantics/src/expansion/initial/param.rs Refined error cause creation to capture parameter names. Updated tests to reflect these changes.
yash-semantics/src/expansion/initial/param/switch.rs Enhanced error handling logic and assignment functionality by adding name and vacancy fields.
yash-semantics/src/assign.rs Added vacancy field to perform_assignment function and included related assertions in tests.
yash-semantics/src/command/compound_command/for_loop.rs Added vacancy field in the execute function for improved error handling.

Sequence Diagram(s)

Possibly related issues

Poem

In the code where errors bloom, We’ve added fields to clear the gloom. Names and messages now make sense, No more confusion or pretense. Bugs are squashed, and logs are neat, With these changes, we’ll never miss a beat! 🐇✨

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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
magicant commented 2 months ago

@coderabbitai summary

coderabbitai[bot] commented 2 months ago
Actions performed Summary regeneration triggered.