docs: document the plain output format and yaml/md aliases - #202
Open
rajarshidattapy wants to merge 1 commit into
Open
docs: document the plain output format and yaml/md aliases#202rajarshidattapy wants to merge 1 commit into
rajarshidattapy wants to merge 1 commit into
Conversation
Contributor
🟢 No documentation gap found — medium confidenceThe automated review found no documentation gap in the supplied changes. This review is advisory and does not block merging. |
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.
Description
Fixes #201
The Output Formats section of
docs/cli-reference.mdxlisted five formats —table,json,yaml,md,csv— but eight are supported (src/command-surface.ts:5):This adds
-f plainto the example block and one sentence covering whatplaindoes and the two aliases.plainwas the notable omission. It is dispatched atsrc/output.ts:50and appears in both help strings —src/command-surface.ts:72builds the-fhelp fromOUTPUT_FORMATS.join(', '), andsrc/command-presentation.ts:91spells out "table, plain, json, yaml, md, csv" — andskills/webcmd-usage/SKILL.mddocuments it for agents. The published reference was the only place it was missing, so it was invisible to anyone reading the docs rather than running--help.Behaviour documented, taken from
formatPlain(src/output.ts:123-146):key: valuelines instead of a tablesrc/output.ts:137-144response,content,markdown,text, orvaluesrc/output.ts:127-134ymlis an alias foryaml,markdownformdsrc/output.ts:51-55Related issue: Closes #201
One thing intentionally left undocumented
-fis not validated.OUTPUT_FORMATSis used only to build help text, never to check the supplied value, so an unrecognised format falls through thedefault:case informatOutput(src/output.ts:56) and silently renders a table —-f jsonnproduces table output with no error.I left that out of the docs because it reads as a defect rather than intended behaviour, and writing it down would bless it. Happy to open a separate issue for it if that is useful. If
-fgains validation later, the alias sentence added here stays correct and a rejection note becomes worth adding alongside it.Type of Change
Checklist
Notes on the checklist:
.mdxfile; no code, tests, or generated artifacts are touched. Each claim was verified againstsrc/rather than by running the suite.src/docs-sync-review.tslistsdocs/cli-reference.mdxas a watched path only, which is why the drift went unnoticed.Adapter Notes
Not applicable — no adapter is added or modified in this PR.
CliErrorsubclasses instead of rawErrorScreenshots / Output
One file, +3: