chore: sanitize newlines in flags table default and type values#9393
Merged
Conversation
The generateFlagsTable function was not stripping newlines from defaultVal and typeVal, causing multi-line values (like --access's defaultDescription) to break markdown table rows. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
reggi
changed the title
owlstronaut
approved these changes
May 26, 2026
reggi
added a commit
that referenced
this pull request
May 26, 2026
Backport of #9393 to release/v11. The `generateFlagsTable` function in `docs/lib/index.js` sanitizes `description` for newlines but not `defaultVal` or `typeVal`. Multi-line `defaultDescription` values (like `--access`) break the markdown table rendering. Adds `.replace(/\n/g, ' ').trim()` to both `defaultVal` and `typeVal`, matching the existing sanitization on `desc`. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
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
2 participants
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.
Problem
The
generateFlagsTablefunction indocs/lib/index.jssanitizesdescriptionfor newlines but does not do the same fordefaultValortypeVal. Some config definitions (like--access) have multi-linedefaultDescriptionvalues, which breaks the markdown table — all subsequent columns/rows get collapsed into a single garbled line.This is visible on the live docs: https://docs.npmjs.com/cli/v11/commands/npm-stage
Fix
Added
.replace(/\n/g, ' ').trim()to bothdefaultValandtypeValingenerateFlagsTable, matching the existing sanitization already applied todesc.