improve custom command error message for missing arguments by pkbhowmick · Pull Request #752 · cloudposse/atmos

pkbhowmick · 2024-10-30T07:30:04Z

what

improved custom command error message for missing arguments including the name of argument for better user's understanding.

why

If a custom command expects an argument, it should say so with the arguments name.

Current:

After fix:

references

DEV-2324

Summary by CodeRabbit

New Features
- Enhanced error messages for invalid argument counts in command processing, providing clearer guidance on required arguments.
Bug Fixes
- Improved error handling for empty argument names, ensuring better logging and visibility of issues.

Signed-off-by: Pulak Kanti Bhowmick <pkbhowmick007@gmail.com>

coderabbitai · 2024-10-30T07:30:12Z

📝 Walkthrough

Walkthrough

The changes in this pull request focus on improving error handling and command processing logic within the cmd/cmd_utils.go file. A new import for the errors package is included to facilitate the creation of more descriptive error messages, particularly in the preCustomCommand function, which now provides clearer feedback on invalid argument counts. Other functions maintain their existing structures but ensure consistent command context during execution. Overall, the modifications aim to enhance user experience through better error reporting while preserving the integrity of command processing.

Changes

File Path	Change Summary
cmd/cmd_utils.go	- Added import for `errors` package. - Enhanced error handling in `preCustomCommand` for invalid argument counts. - Function signature updated for `preCustomCommand`. - Other functions retain structure and logic.

Possibly related PRs

Fix: condition to display help interactive menu #724: The changes in this PR involve modifications to command handling and error message display, which are closely related to the enhancements in error handling and command processing logic in the main PR.

Suggested labels

minor

Suggested reviewers

osterman

Poem

In the meadow where commands play,
Errors now clearer, come what may.
With messages bright, we hop and cheer,
Processing smoothly, no need to fear!
A rabbit's delight, in code we trust,
Enhancements abound, in changes we must! 🐇✨

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>, please review it.
- 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @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.

pkbhowmick · 2024-10-30T07:31:43Z

@coderabbitai review

coderabbitai · 2024-10-30T07:31:50Z

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

coderabbitai

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE

📥 Commits

Files that changed from the base of the PR and between 682d6e5 and 873b1ca.

📒 Files selected for processing (1)

cmd/cmd_utils.go (2 hunks)

🔇 Additional comments (1)

cmd/cmd_utils.go (1)

5-5: LGTM: Clean import addition

The addition of the errors package import is appropriate for the enhanced error handling implementation.

cmd/cmd_utils.go

Signed-off-by: Pulak Kanti Bhowmick <pkbhowmick007@gmail.com>

coderabbitai

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE

📥 Commits

Files that changed from the base of the PR and between 873b1ca and 2ee66a9.

📒 Files selected for processing (1)

cmd/cmd_utils.go (2 hunks)

🔇 Additional comments (1)

cmd/cmd_utils.go (1)

5-5: LGTM: Import addition is appropriate

The addition of the errors package import is necessary for the enhanced error handling implementation.

cmd/cmd_utils.go

Signed-off-by: Pulak Kanti Bhowmick <pkbhowmick007@gmail.com>

coderabbitai

Actionable comments posted: 2

📜 Review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE

📥 Commits

Reviewing files that changed from the base of the PR and between 2ee66a9 and b07f7a5.

📒 Files selected for processing (1)

cmd/cmd_utils.go (2 hunks)

🔇 Additional comments (1)

cmd/cmd_utils.go (1)

5-5: LGTM!

The addition of the errors package import is appropriate for the enhanced error handling implementation.

cmd/cmd_utils.go

aknysh

thanks @pkbhowmick

github-actions · 2024-10-31T21:11:24Z

These changes were released in v1.99.0.

update custom command error message for missing arguments

57058b3

Signed-off-by: Pulak Kanti Bhowmick <pkbhowmick007@gmail.com>

Merge branch 'main' into pulak/DEV-2329

873b1ca

pkbhowmick changed the title ~~update custom command error message for missing arguments~~ improve custom command error message for missing arguments Oct 30, 2024

coderabbitai bot reviewed Oct 30, 2024

View reviewed changes

cmd/cmd_utils.go Outdated Show resolved Hide resolved

use string builder

2ee66a9

Signed-off-by: Pulak Kanti Bhowmick <pkbhowmick007@gmail.com>

pkbhowmick marked this pull request as ready for review October 30, 2024 08:20

pkbhowmick requested review from a team as code owners October 30, 2024 08:20

pkbhowmick requested review from gberenice, johncblandii and osterman October 30, 2024 08:20

coderabbitai bot reviewed Oct 30, 2024

View reviewed changes

cmd/cmd_utils.go Show resolved Hide resolved

aknysh added the no-release Do not create a new release (wait for additional code changes) label Oct 30, 2024

aknysh and others added 3 commits October 30, 2024 09:00

Merge branch 'main' into pulak/DEV-2329

a07e660

Merge branch 'main' into pulak/DEV-2329

f8b2ad3

change format as per review

b07f7a5

Signed-off-by: Pulak Kanti Bhowmick <pkbhowmick007@gmail.com>

coderabbitai bot reviewed Oct 30, 2024

View reviewed changes

cmd/cmd_utils.go Show resolved Hide resolved

cmd/cmd_utils.go Show resolved Hide resolved

aknysh approved these changes Oct 31, 2024

View reviewed changes

aknysh merged commit 1f135ad into main Oct 31, 2024

aknysh deleted the pulak/DEV-2329 branch October 31, 2024 00:40

This was referenced Nov 3, 2024

Add support to load config values and secrets from external sources #762

Closed

detect cycle in cli custom commands #765

Closed

handle invalid command error #766

Merged

Show failed command after atmos workflow failure #767

Merged

coderabbitai bot mentioned this pull request Nov 24, 2024

add bool flag in custom command which was ignored before #807

Merged

coderabbitai bot mentioned this pull request Dec 24, 2024

Fix invalid command should not show terraform help #889

Closed

coderabbitai bot mentioned this pull request Jan 1, 2025

Support Default Values for Arguments in Custom Commands #905

Merged

This was referenced Feb 6, 2025

Improve Atmos help #959

Merged

Support Trailing Args for Custom Commands #1046

Merged

Uh oh!

Conversation

pkbhowmick commented Oct 30, 2024 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

what

why

references

Summary by CodeRabbit

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Oct 30, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Possibly related PRs

Suggested labels

Suggested reviewers

Poem

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

pkbhowmick commented Oct 30, 2024

Uh oh!

coderabbitai bot commented Oct 30, 2024

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

aknysh left a comment

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Oct 31, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

pkbhowmick commented Oct 30, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Oct 30, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)