Repository navigation
Conversation
The per-command option lists in the README did not match the commands on main: - build, create and start listed -c, --config, which none of them declares (only dev declares it). - create listed -s, --server, which no longer exists, and missed -t, --template; its -n and -p descriptions also predated the plugin form. - editor missed -p, --port, and dev missed -e, --editor. - The config schema link pointed at config-schema.json on nanoforge-dev.github.io; the file is config.schema.json and its $id is on docs.nanoforge.eu. Checked against src/command/commands/*.command.ts: every command's README option set now equals its declared set. Closes NanoForge-dev#280
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.
Closes #280.
What changed
README-only fix. Each per-command option list now matches what the command declares in
src/command/commands/*.command.ts(checked at e95b881, the commit the issue audited):build,create,start: removed-c, --config— none of these commands declares it (onlydevdoes).create: removed-s, --server(no longer exists); added-t, --template; brought the-nand-pdescriptions up to the declared text (plugin name form, folder defaults).editor: added the missing-p, --port(default 5173).dev: added the missing-e, --editor, found by the same comparison.https://nanoforge-dev.github.io/docs/cli/config-schema.json; the file isconfig.schema.jsonand its$idishttps://docs.nanoforge.eu/docs/cli/config.schema.json(seedocs/config.schema.json). The link now points there.I corrected the lists in place rather than replacing them with links to
docs/docs/commands/, so the README stays self-contained; happy to switch to the link approach if you prefer it.Verification
I extracted every
.option(...)declaration fromsrc/command/commands/*.command.ts(including the multi-line ones increate) and compared the flag set of each README section against it programmatically: all 11 commands now match exactly, with no README-only or source-only flags. No code changed, so no tests were run.