Skip to content

docs(arborist): describe yarn and pnpm lockfile support - #10110

Open
ump45nose wants to merge 1 commit into
npm:latestfrom
ump45nose:contrib/docs-arborist-doesnt-mention-pnpm-7765
Open

ump45nose wants to merge 1 commit into
npm:latestfrom
ump45nose:contrib/docs-arborist-doesnt-mention-pnpm-7765

Conversation

@ump45nose

Copy link
Copy Markdown

Documents Arborist's lockfile support: a "SUPPORTED LOCKFILES" section in workspaces/arborist/README.md and a new workspaces/arborist/docs/lockfiles.md (package-lock.json is primary; yarn v1 yarn.lock is read/written as a metadata source with caveats; pnpm-lock.yaml is not supported).

Status / please decide: #7765 is still labeled Needs Triage. The description is based on reading lib/shrinkwrap.js / lib/yarn-lock.js and the test/fixtures/pnpm fixture; please correct anything that does not match intended behavior. Fixes #7765 if accepted.

No tests run (docs only).

AI assistance disclosure: this change was prepared with the help of an AI coding agent (Grok Bot). The account owner has not reviewed every line in detail; please treat it accordingly.

The arborist package description mentioned `yarn.lock` once, inside a
usage code comment, and did not mention pnpm at all, so the level of
support Arborist has for other package managers was unclear.

Add a `SUPPORTED LOCKFILES` section to the arborist README summarizing
the level of support, and a new
`workspaces/arborist/docs/lockfiles.md` page with the details:
`yarn.lock` is read and written but only as a metadata source, and
`pnpm-lock.yaml` is not handled at all.

Closes: npm#7765
@ump45nose
ump45nose requested a review from a team as a code owner October 10, 2026 09:20
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.

[DOCS] arborist doesnt mention pnpm and yarn support

1 participant