feat: add completions command for bash, zsh, fish, and llm #21
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add `imsg completions <shell>` command that generates shell completion scripts dynamically from registered commands. Supports bash, zsh, fish, and an "llm" format for AI assistant context. - CompletionMetadata.swift holds command/option metadata for generation - CompletionsCommand.swift implements generators for each shell format - Consistency test verifies metadata stays in sync with CommandRouter - Service choices derive from MessageService.allCases (not hardcoded)
Adds comprehensive docstrings to CompletionMetadata and CompletionsCommand to satisfy CodeRabbit's documentation coverage requirement.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
imsg completions <shell>command generating shell completion scriptsCompletionMetadatastructure with consistency tests to prevent driftDesign Notes
This introduces a parallel metadata structure (
CompletionMetadata) rather than extending Commander's types because:OptionDefinitiondoesn't support value hints (file, rowid, timestamp) or enumerated choices needed for rich shell completioncompletionMetadataContainsAllCommands) verifies command names stay in sync withCommandRouterIf maintainers prefer, we'd be happy to extend Commander's base types instead - just let us know.
Test plan
swift buildpassesswift testpasses (97 tests, including 12 new completion tests)imsg completions bash- generates valid bash-completion scriptimsg completions zsh- generates valid zsh completion scriptimsg completions fish- generates valid fish completion scriptimsg completions llm- generates markdown CLI referenceimsg completionsandimsg completions powershellproduce friendly error messages