Skip to content

chore: Update references for arborist to cli #8599

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Sep 26, 2025
Merged

chore: Update references for arborist to cli #8599

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f78c48d
chore: arborist image moved to cli
jsoref Sep 26, 2025
2945374
chore: arborist issues moved to cli
jsoref Sep 26, 2025
98da93d
chore: update arborist references
jsoref Sep 26, 2025
103c555
chore: update arborist options reference
jsoref Sep 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion workspaces/arborist/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

Inspect and manage `node_modules` trees.

![a tree with the word ARBORIST superimposed on it](https://raw.githubusercontent.com/npm/arborist/main/docs/logo.svg?sanitize=true)
![a tree with the word ARBORIST superimposed on it](https://raw.githubusercontent.com/npm/cli/latest/workspaces/arborist/docs/logo.svg?sanitize=true)
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There's arguably some value in using a stale reference in that anyone who keeps a copy of the stale reference doesn't have to worry about the linked content changing. Whereas if this change is applied and someone later wants to reorganize the folder structure, it will break any copies of this updated reference.

That said, in theory it makes more sense to link to the current logo than the one from n years ago...


There's more documentation [in the docs
folder](https://github.com/npm/cli/tree/latest/workspaces/arborist/docs).
Expand Down
4 changes: 2 additions & 2 deletions workspaces/arborist/test/arborist/build-ideal-tree.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3324,7 +3324,7 @@ t.test('competing peerSets resolve in both root and workspace', async t => {

const [rootWarnings = [], wsWarnings = []] = warnings
// TODO: these warn for now but shouldnt
// https://github.com/npm/arborist/issues/347
// https://github.com/npm/cli/issues/4270
t.comment('FIXME')
t.match(rootWarnings, ['warn', 'ERESOLVE', 'overriding peer dependency', {
code: 'ERESOLVE',
Expand Down Expand Up @@ -3385,7 +3385,7 @@ t.test('competing peerSets resolve in both root and workspace', async t => {
t.equal(wsD.version, '1.0.0', 'workspace d version')

// TODO: these should not be undefined
// https://github.com/npm/arborist/issues/348
// https://github.com/npm/cli/issues/4269
t.comment('FIXME')
t.equal((wsTargetC || {}).version, undefined, 'workspace target c version')
t.equal((wsTargetD || {}).version, undefined, 'workspace target d version')
Expand Down
2 changes: 1 addition & 1 deletion workspaces/libnpmexec/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ await libexec({
- `runPath`: Location to where to execute the script **String**, defaults to `.`
- `scriptShell`: Default shell to be used **String**, defaults to `sh` on POSIX systems, `process.env.ComSpec` OR `cmd` on Windows
- `yes`: Should skip download confirmation prompt when fetching missing packages from the registry? **Boolean**
- `registry`, `cache`, and more options that are forwarded to [@npmcli/arborist](https://github.com/npm/arborist/) and [pacote](https://github.com/npm/pacote/#options) **Object**
- `registry`, `cache`, and more options that are forwarded to [@npmcli/arborist](https://github.com/npm/cli/blob/latest/workspaces/arborist/README.md) and [pacote](https://github.com/npm/pacote/#options) **Object**

## LICENSE

Expand Down
4 changes: 2 additions & 2 deletions workspaces/libnpmfund/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,14 +75,14 @@ things such as printing a `6 packages are looking for funding` msg.
- `workspaces`: `Array<String>` List of workspaces names to filter for,
the result will only include a subset of the resulting tree that includes
only the nodes that are children of the listed workspaces names.
- `path`, `registry` and more [Arborist](https://github.com/npm/arborist/) options.
- `path`, `registry` and more [Arborist options](https://github.com/npm/cli/blob/latest/workspaces/arborist/README.md#usage).

##### <a name="fund.readTree"></a> `> fund.readTree(tree, [opts]) -> Promise<Object>`

Reads **funding** info from a given install tree and returns a tree object
that only contains packages in which funding info is defined.

- `tree`: An [`arborist`](https://github.com/npm/arborist) tree to be used, e.g:
- `tree`: An [`arborist`](https://github.com/npm/cli/blob/latest/workspaces/arborist/README.md) tree to be used, e.g:

```js
const Arborist = require('@npmcli/arborist')
Expand Down
Loading