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

Generate cobra's v2 bash completions #141

Merged
merged 1 commit into from
Apr 8, 2024
Merged

Generate cobra's v2 bash completions #141

merged 1 commit into from
Apr 8, 2024

Conversation

scop
Copy link
Contributor

@scop scop commented Apr 8, 2024

Inhibiting descriptions for consistency with fish completions.

Ref https://github.com/spf13/cobra/blob/main/site/content/completions/_index.md#bash-completion-v2

Summary by CodeRabbit

  • Refactor
    • Updated shell completion generation to use the latest version for improved command-line experience.

Copy link
Contributor

coderabbitai bot commented Apr 8, 2024

Walkthrough

The recent update enhances the command-line interface (CLI) completion functionality by transitioning from the older GenBashCompletion function to the more advanced GenBashCompletionV2. This change, implemented across two key files, introduces an additional argument to improve how bash completions are generated, ensuring a more efficient and tailored user experience when interacting with the CLI.

Changes

Files Change Summary
cmd/completion.go Updated GenBashCompletion to GenBashCompletionV2 with an extra false argument.
internal/.../completion.go Enhanced to use GenBashCompletionV2 for makeBashCompletionFileIfNeeded & hasSameBashCompletionContent.

🐇✨
In the burrow of code, under the moon's soft glow,
A change was made, swift and low.
Bash completions, now spry and keen,
With GenBashCompletionV2, they gleam.
Oh, how the command lines sing,
For the efficiency these changes bring.
🌟🌿

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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Review Status

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 3742bde and cffcce5.
Files selected for processing (2)
  • cmd/completion.go (1 hunks)
  • internal/completion/completion.go (2 hunks)
Additional comments not posted (3)
cmd/completion.go (1)

28-28: The update to GenBashCompletionV2 aligns with the PR's objectives. Please ensure the false argument is used as intended according to Cobra's documentation.

internal/completion/completion.go (2)

39-39: Update to GenBashCompletionV2 is consistent with the PR's objectives. Ensure robust error handling and correct usage of the false argument.


170-170: The update to GenBashCompletionV2 for content comparison is appropriate. Verify the comparison logic's effectiveness with the new completion version.

@nao1215
Copy link
Owner

nao1215 commented Apr 8, 2024

Wow, thanks for the PR!

@nao1215 nao1215 merged commit e42c39f into nao1215:main Apr 8, 2024
11 checks passed
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