docs: backfill CLI reference with missing commands - #244
Open
iamlasse wants to merge 2 commits into
Open
Conversation
Add internal/commits with pure Normalize/validate functions enforcing the project's Conventional Commits rules (known type set, lowercase type, lowercase subject, 72-char subject limit, whitespace trimming, and 72-column body wrapping). Wire it into the CLI as 'nightshift commit normalize' (positional, --file, and stdin sources; --check to validate only), ship a commit-msg git hook under scripts/, and document the format and installation in docs/commit-messages.md. Nightshift-Task: commit-normalize Nightshift-Ref: https://github.com/marcus/nightshift
Document previously missing commands: config (get/set/validate), init, install/uninstall, report, busfactor, commit normalize, plus flags for preview, task, budget, status, logs, stats, and daemon subcommands. All flags and defaults sourced from the cobra definitions in cmd/nightshift/commands/. Corrected the Global Flags table (--provider and --timeout are per-command flags, not global). Links to existing website pages and repo guides instead of duplicating content. Nightshift-Task: docs-backfill Nightshift-Ref: https://github.com/marcus/nightshift
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.
Summary
The CLI reference documented only 10 of the CLI's commands. This backfills the rest, with every flag and default sourced from the cobra definitions in
cmd/nightshift/commands/— nothing invented.Newly documented:
config(+get/set/validate),init,install/uninstall— new Configuration Commands sectionreport,busfactor,commit normalize,doctor— new Maintenance Commands section with flag tables and examplesdaemon start/stop/status,status,logs,stats— previously just names in the core table; now have usage examples and flag tablesAlso:
preview,task, andbudgetsubcommands (snapshot,history,calibrate)--providerand--timeoutare per-command flags, not global; the only global flags are--verboseand--versiondocs/guides/provider-calibration.md,docs/bus-factor.md,docs/commit-messages.md) instead of duplicating contentDocs-only change.
go build ./...and the Docusaurus website build both pass.Nightshift-Task: docs-backfill
Nightshift-Ref: https://github.com/marcus/nightshift
Automated by nightshift