Repository navigation
refactor(cli)!: coherent flag names and grouped help (v0.4.0) - #37
Merged
Merged
Conversation
"all" meant two different things on the command line: --all (every pass) and the --*-cves-all detail flags (every item within the CVE pass). And the "show me more" flags were four unrelated idioms (-v, --license-paths, and two --*-cves-all), most of them human-view-only, with no stated rule. Split the two meanings and name the detail family consistently: --component-cves-all -> --component-cves-full --kernel-cves-all -> --kernel-cves-full "all" now means only "all passes"; "full" means "all detail within a pass." Add --full as one switch for maximum human detail (verbose + license-paths + both -cves-full). No aliases for the old names: this is a breaking change, hence the major-ish bump to 0.4.0. Regroup --help into PASSES / OUTPUT / CVE MIRROR / OTHER, and state once that JSON (-j) is always complete so the detail flags only expand the human view. Drop the trailing "Pipeline:"/"Docs:" footer lines. Document that -C writes sbom.cdx.json and sbom.spdx.json alongside mithril-report.json. Add the previously-undocumented --verbose entry to the man page. Renames flow through the code comments, the in-output "run --X" hints (json.cpp, human.cpp), the man page, README, docs/cve-join.md, and the test_cve / test_kernelfeed integration tests. Full suite green.
Merged
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.
Why
Two coherence problems on the command line:
-A/--allruns every pass, while--component-cves-all/--kernel-cves-alllist every item within the CVEpass. Same word, unrelated scopes.
-v,--license-paths,--component-cves-all,--kernel-cves-all), most of them human-view-only,with no stated rule for what JSON does.
What changed (breaking → 0.4.0)
Split the two meanings and name the detail family consistently on "full":
--component-cves-all--component-cves-full--kernel-cves-all--kernel-cves-full"all" now means only all passes; "full" means all detail within a pass. No
aliases are kept for the old names, so this is a breaking change and the version
bumps to
0.4.0.--full: one switch for maximum human detail (--verbose+--license-paths+ both--*-cves-full).--helpis regrouped into PASSES / OUTPUT / CVE MIRROR / OTHER, and statesonce that
-j/--jsonis always complete, so the detail flags only expand thehuman view.
Pipeline:/Docs:footer lines are removed from--help.-C/--outdirhelp now notes it writessbom.cdx.jsonandsbom.spdx.jsonnext to
mithril-report.json.--verboseentry and the--fullentry.The renames flow through code comments, the in-output "run --X" hints, the man
page, README,
docs/cve-join.md, and thetest_cve/test_kernelfeedintegration tests.
Testing
kconfig, kconfig_recovery, cve, kernelfeed), including the renamed flags.
Builds on the CVE-mirror-prompt PR; merge that first (this PR's base retargets
to master automatically on merge).