Shell completions #545
Merged
Shell completions #545
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
Implements intelligent shell completion support via [suggest] directive. Uses full parsing pipeline to provide context-aware suggestions. Features: - Context-aware suggestions based on ParseResult - Enum value completion - AllowedValues completion - Partial value filtering - Parse error handling - Hidden option exclusion - Middleware option visibility (--help always suggested) Implementation: - SuggestDirectiveMiddleware in CommandDotNet.Completions namespace - MiddlewareSteps.Suggest runs before Help - UseSuggestDirective() extension method Testing: - 14 comprehensive tests (100% passing) - All 965 existing tests pass (no regressions) Documentation: - docs/OtherFeatures/suggest.md with examples - Added to features.md - Registered in mkdocs.yml This provides the foundation for shell integration. Next: __complete command to generate shell scripts.
Add CompletionCommand class that apps can include to provide shell completion script generation for bash, zsh, fish, and PowerShell. Each shell subcommand outputs a ready-to-use completion script and includes installation instructions in its help text. Key changes: - New CompletionCommand with Bash, Zsh, Fish, and Powershell subcommands - New ShellCompletionScripts utility for generating shell-specific scripts - Move UsageAppName from AppSettings.Help to AppSettings.Execution to support completion scripts and other execution contexts beyond help text - Add ExecutionAppSettings to centralize execution-related configuration - Maintain backwards compatibility for AppSettings.Help.UsageAppName - Comprehensive test coverage for completion command output and help text - Update documentation to reflect recommended UsageAppName location The completion scripts integrate with the [suggest] directive to provide dynamic command, option, and argument completion based on the current command context.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
Provide shell completions and a completion command to generate scripts for Bash, Zsh, Fish, and Powershell
Related Issue
Fixes #(issue number)
Type of Change
Testing
Automated
New Tests Added
Test Results
all passing
Manual Testing Performed
tested bash and zsh completion scripts
Documentation
Breaking Changes
N/A
Checklist
Screenshots (if applicable)
see tests
Additional Context
Reviewer Notes