Skip to content

fix(ls): fix descriptions in --long human output #8903

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

Open
jbrobst wants to merge 2 commits into
base: latest
Choose a base branch
from
+33 −1
Open

fix(ls): fix descriptions in --long human output #8903

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d6d0b3e
fix(ls): load actual tree for --long descriptions
jbrobst Jan 14, 2026
b62e180
fix(ls): avoid description for missing nodes
jbrobst Jan 14, 2026
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
3 changes: 2 additions & 1 deletion lib/commands/ls.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,7 @@ class LS extends ArboristWorkspaceCmd {
...this.npm.flatOptions,
legacyPeerDeps: false,
path,
forceActual: long && !json && !parseable && !packageLockOnly,
})
const tree = await this.initTree({ arb, args, packageLockOnly })

Expand Down Expand Up @@ -339,7 +340,7 @@ const getHumanOutputItem = (node, { args, chalk, global, long }) => {
) +
(isGitNode(node) ? ` (${node.resolved})` : '') +
(node.isLink ? ` -> ${relativePrefix}${targetLocation}` : '') +
(long ? `\n${node.package.description || ''}` : '')
(long && !node[_missing] ? `\n${node.package.description || ''}` : '')

return augmentItemWithIncludeMetadata(node, { label, nodes: [] })
}
Expand Down
26 changes: 26 additions & 0 deletions tap-snapshots/test/lib/commands/ls.js.test.cjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,32 @@ Array [
]
`

exports[`test/lib/commands/ls.js TAP ignore missing optional deps --long human output > ls --long result 1`] = `
[email protected]
| {CWD}/prefix
|
+-- UNMET OPTIONAL DEPENDENCY optional-missing@1
+-- [email protected]
|
+-- [email protected] invalid: "1" from the root project
|
+-- UNMET DEPENDENCY peer-missing@1
+-- [email protected]
|
+-- UNMET OPTIONAL DEPENDENCY peer-optional-missing@1
+-- [email protected] extraneous
|
+-- [email protected] invalid: "1" from the root project extraneous
|
+-- [email protected] invalid: "1" from the root project
|
+-- UNMET DEPENDENCY prod-missing@1
+-- [email protected]
|
\`-- [email protected] invalid: "1" from the root project

`

exports[`test/lib/commands/ls.js TAP ignore missing optional deps --parseable > ls --parseable result 1`] = `
{CWD}/prefix
{CWD}/prefix/node_modules/optional-ok
Expand Down
5 changes: 5 additions & 0 deletions test/lib/commands/ls.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2663,6 +2663,11 @@ t.test('ignore missing optional deps', async t => {
const result = await mock(t)
t.matchSnapshot(result, 'ls result')
})

t.test('--long human output', async t => {
const result = await mock(t, { long: true })
t.matchSnapshot(result, 'ls --long result')
})
})

t.test('ls --json', async t => {
Expand Down