add bool flag in custom command which was ignored before

[pkbhowmick]

what

why

references

• DEV-2122

Summary by CodeRabbit

• New Features

  • Improved handling of command flags, allowing for more flexible storage of flag values.
  • Enhanced retrieval of boolean flag values.

• Bug Fixes

  • Updated error handling for flag retrieval to ensure proper logging and graceful exits.
  • Improved argument validation with clearer error messages for mismatched argument counts.

• Documentation

  • Enhanced help command triggered when no steps are defined in command configuration.

[coderabbitai]

📝 Walkthrough

📝 Walkthrough

Walkthrough

The changes in this pull request focus on enhancing the handling of command flags and improving type safety in the cmd/cmd_utils.go file. The flagsData variable's type has been updated to allow for more flexible storage of flag values, and logic for retrieving boolean flag values has been added. Additionally, error handling for flag retrieval and argument validation has been improved, ensuring clearer error messages and graceful exits when issues arise.

Changes

File	Change Summary
cmd/cmd_utils.go	- Updated flagsData type from map[string]string to map[string]any. - Added logic for retrieving boolean flag values. - Enhanced error handling for flag retrieval and argument validation in preCustomCommand function.

Assessment against linked issues

Objective	Addressed	Explanation
Implement bool flags without values (DEV-2122)	✅

Possibly related PRs

• improve custom command error message for missing arguments #752: This PR enhances error handling in the preCustomCommand function, similar to the main PR's improvements in argument validation and error messaging.
• handle invalid command error #766: This PR modifies the preCustomCommand function to improve error handling for invalid commands, which aligns with the main PR's focus on robust error handling in command processing.

Suggested labels

minor

Suggested reviewers

• osterman
• johncblandii
• gberenice
• aknysh

---

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
• Mastodon
• Reddit
• LinkedIn

🪧 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 or @auto-summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai or @auto-title anywhere in the PR title to generate the title automatically.

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.

[osterman]

Can you post screenshots demonstrating the behavior.

[pkbhowmick]

Can you post screenshots demonstrating the behavior.

This is hard to demo. I need a custom command with such bool flag. Can we skip this only for this PR?

[osterman]

No, I need to see this working before we merge. This is very easy to test.

Add a custom command to https://github.com/cloudposse/atmos/blob/main/examples/tests/atmos.yaml

A custom command can run any shell command, so just echo the value.

[osterman]

You can see some examples here: https://github.com/cloudposse/atmos/blob/main/examples/demo-custom-command/atmos.yaml

[osterman]

Documentation on custom commands is here: https://atmos.tools/core-concepts/custom-commands/

[pkbhowmick]

No, I need to see this working before we merge. This is very easy to test.

Add a custom command to main/examples/tests/atmos.yaml

A custom command can run any shell command, so just echo the value.

Got it! Thanks @osterman

Here is the result:

[aknysh]

thanks @pkbhowmick

[github-actions]

These changes were released in v1.113.0.