[Chore]: Update documentation for System.CommandLine 2.0.0-beta5 changes #21
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
This PR updates all internal documentation and code comments to reflect the System.CommandLine 2.0.0-beta5 API patterns as part of the final cleanup step in the System.CommandLine upgrade effort.
Changes Made
📦 Package Reference Update
System.CommandLine
package reference from2.0.0-beta4.22272.1
to2.0.0-beta5.25306.1
📝 Code Documentation Updates
SetupCommand
method documentation to reference beta5 API patternsProgram.cs
comments to document new mutable collections API usage🔄 API Pattern Documentation
Updated inline comments throughout the codebase to document the key API changes:
IsRequired = true
Required = true
AddOption()
Options.Add()
AddCommand()
Subcommands.Add()
SetHandler(typed params)
SetAction(ParseResult)
ArgumentHelpName
HelpName
🛠️ Files Modified
Program.cs
- Updated command registration documentationCommandHandlers/
directory:InitProjectCommandHandler.cs
DataDictionaryCommandHandler.cs
ExtractModelCommandHandler.cs
EnrichModelCommandHandler.cs
ExportModelCommandHandler.cs
QueryModelCommandHandler.cs
ShowObjectCommandHandler.cs
CommandHandler.cs
(base class)ICommandHandler.cs
(interface)GenAIDBExplorer.Console.csproj
(package reference)Validation
✅ 54 references to beta5 patterns documented throughout the codebase
✅ 0 references to beta4 patterns remaining
✅ All command handlers consistently updated
✅ No breaking changes to external CLI interface
✅ End-user facing documentation unchanged (commands work the same)
Impact
This ensures long-term maintainability by providing clear guidance on the System.CommandLine 2.0.0-beta5 API patterns for developers working on the command-line interface code.
Fixes #20.
💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.