feat: fix command line help and add diff subcommand#14
Merged
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
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.
This pull request refactors the CLI for
odsbox-diffto use explicit subcommands (diff,collect,config) and updates the documentation and tests to match. The new CLI structure is more standard and discoverable, while maintaining backward compatibility with the previous implicit diff mode. Documentation now clearly recommends and demonstrates the new subcommand-based usage.CLI Refactor and Backward Compatibility:
diff.pyto use explicit subcommands (diff,collect,config) withargparsesubparsers, and updated help messages and dispatch logic for improved usability and discoverability. The implicit diff mode is still supported for backward compatibility. [1] [2] [3]Documentation Updates:
README.mdanddocs/usage.mdto recommend and document the new subcommand-based CLI usage, replacing references to the old implicit mode andcreate-configwithconfig, and clarifying backward compatibility. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11] [12] [13] [14]Testing Enhancements:
Internal Code Improvements:
_build_root_parserand_build_diff_parserfor clearer CLI argument parsing and separation of subcommand logic. [1] [2]These changes make the CLI more user-friendly and maintainable while ensuring existing workflows are not broken.