docs: clarify os/cpu/libc accept string or array - #10047
Open
SatvikMishra08 wants to merge 1 commit into
Open
SatvikMishra08 wants to merge 1 commit into
SatvikMishra08 wants to merge 1 commit into
Conversation
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.
Summary
Clarifies that
os,cpu, andlibcinpackage.jsoneach accept a string or an array of strings, matching npm's runtime behavior innpm-install-checks(checkListcoerces a string to a one-element array).Previously the
libcexample used bare strings whileos/cpushowed only arrays, with no note that both shapes are valid — which has confused authors and downstream tools (see #10002).Changes:
libcsection examples withos/cpu(array form + string shorthand)Verified against
node_modules/npm-install-checks/lib/index.jscheckListon currentlatest. No maintainer comments on the still-Needs-Triage issue.Fixes #10002
Test plan