Add default value display to CLI help text#131
Draft
Copilot wants to merge 2 commits into
Draft
Conversation
Co-authored-by: Goo78 <163220761+Goo78@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Fix typos in JSDoc documentation
Add default value display to CLI help text
Feb 15, 2026
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.
CLI help text now displays default values for flags, eliminating the need to consult source code or documentation for default behavior.
Changes
Help text generation (
packages/jsdoc-cli/lib/help.js): Appends default values to flag descriptions with priority fordefaultDescriptionoverdefaultproperty. Objects are JSON-serialized; other values useString()conversion. Null check prevents stringifying non-object defaults.Test coverage (
packages/jsdoc-cli/test/specs/lib/engine.js): Added tests verifying default values display correctly, custom descriptions take precedence, and flags without defaults remain unchanged.Example output
Handles edge cases:
0,false,"",null, and complex objects via JSON serialization.Original prompt
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.