Skip to content

docs: clarify validation rules for the funding field - #10222

Open
ysknsid25 wants to merge 1 commit into
npm:latestfrom
ysknsid25:docs/funding-field
Open

ysknsid25 wants to merge 1 commit into
npm:latestfrom
ysknsid25:docs/funding-field

Conversation

@ysknsid25

Copy link
Copy Markdown

Why

The funding section of the package.json docs only shows examples (a string, an object with type and url, and an array of them).
It does not explain:

  • what values type accepts
  • what values url accepts (e.g. is mailto: allowed?)
  • how an array with multiple entries is handled

What

I read the code and documented the actual behavior:

I also fixed an incorrect statement: with multiple URLs, npm fund <pkg> does not visit the first one but asks for --which (fund.js#L187-L204).

Signed-off-by: ysknsid25 <kengo071225@gmail.com>
@ysknsid25
ysknsid25 requested a review from a team as a code owner November 4, 2026 13:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant