Add cliguard to Contract Testing Tools - #139
Open
Bryandero98 wants to merge 1 commit into
Open
Conversation
cliguard applies the same contract-testing idea this section already covers for network APIs (Pact, WireMock, JsonSchema) to CLI surfaces: it snapshots a CLI's commands/flags/defaults from the framework's own object model, classifies changes as breaking/additive/patch, and fails CI on an unintentional breaking change. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
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
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.
cliguard applies the contract-testing idea this section already covers for network APIs (Pact, WireMock, JsonSchema) to CLI surfaces instead: it snapshots a CLI's commands/flags/defaults by introspecting the framework's own object model (never by parsing
--helptext), classifies any change as breaking/additive/patch, and fails CI on an unintentional breaking change - with a GitHub Action that comments the diff directly on a PR. Framework adapters for Commander, CAC, Yargs (Node) and Click (Python). MIT-licensed, free, on npm and GitHub.🤖 Generated with Claude Code