fix(cli): Refactor CLI help and model flag names - #367
Open
misonijnik wants to merge 7 commits into
Open
Conversation
House style: no semicolons in prose. Semicolon-joined sentences in the Long descriptions, flag help, the dry-run status line, and comments are split into separate sentences, and '; defaults to X' flag suffixes become '(defaults to X)'. The mirrored line in docs/usage.md is updated to match.
The four spots predate this branch (the external-methods paragraph, the summary section intro, and the global --color bullet). Rewritten as separate sentences to match the no-semicolon prose rule.
…ll metacharacters Registering a renamed flag and its deprecated alias as two stock pflag StringArrayVar flags bound to one slice made the alias's first value replace whatever the new spelling had already collected, silently dropping models from the analysis. The two spellings now share an appending value type, so mixed invocations accumulate in command-line order. Applies to --passthrough-models and --java-models on scan and the test-run commands. shellQuote quoted only whitespace and quote characters, so a suggested re-run containing a glob or a variable was mangled by the shell on paste. It now quotes anything outside the shlex-style inert set.
Every command's Long text now follows ASD-STE100 style: short sentences, one instruction per sentence, active voice, and simple words. Every command has an Examples section, and each Examples section ends with recipes that show complete use cases as command sequences, from the first scan on a new machine to the rule-test edit loop. The summary, prune, and reachability Shorts are simplified to match, and the docs tables that quote them are synced.
The help rewrite mentioned Go in the root and pull help, and the docs mentioned go.mod, the go-ssa-server, and the Go toolchain. Go support lands in its own branch. That branch states it, in its own words.
misonijnik
force-pushed
the
misonijnik/cli-improvements
branch
from
August 25, 2026 12:28
99dc02d to
3bcd07b
Compare
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.
No description provided.