Skip to content

Commit 8a911da

Browse files
authored
docs(ls): removed design change pending section note (#7963)
Removed npm 8 design change pending section note section from the documentation for `npm ls` https://docs.npmjs.com/cli/v10/commands/npm-ls?v=true#note-design-changes-pending Closes npm/documentation#1365, #6773
1 parent cf52b8b commit 8a911da

File tree

1 file changed

+0
-28
lines changed

1 file changed

+0
-28
lines changed

docs/lib/content/commands/npm-ls.md

-28
Original file line numberDiff line numberDiff line change
@@ -39,34 +39,6 @@ dependencies, not the physical layout of your `node_modules` folder.
3939

4040
When run as `ll` or `la`, it shows extended information by default.
4141

42-
### Note: Design Changes Pending
43-
44-
The `npm ls` command's output and behavior made a _ton_ of sense when npm
45-
created a `node_modules` folder that naively nested every dependency. In
46-
such a case, the logical dependency graph and physical tree of packages on
47-
disk would be roughly identical.
48-
49-
With the advent of automatic install-time deduplication of dependencies in
50-
npm v3, the `ls` output was modified to display the logical dependency
51-
graph as a tree structure, since this was more useful to most users.
52-
However, without using `npm ls -l`, it became impossible to show _where_ a
53-
package was actually installed much of the time!
54-
55-
With the advent of automatic installation of `peerDependencies` in npm v7,
56-
this gets even more curious, as `peerDependencies` are logically
57-
"underneath" their dependents in the dependency graph, but are always
58-
physically at or above their location on disk.
59-
60-
Also, in the years since npm got an `ls` command (in version 0.0.2!),
61-
dependency graphs have gotten much larger as a general rule. Therefore, in
62-
order to avoid dumping an excessive amount of content to the terminal, `npm
63-
ls` now only shows the _top_ level dependencies, unless `--all` is
64-
provided.
65-
66-
A thorough re-examination of the use cases, intention, behavior, and output
67-
of this command, is currently underway. Expect significant changes to at
68-
least the default human-readable `npm ls` output in npm v8.
69-
7042
### Configuration
7143

7244
<!-- AUTOGENERATED CONFIG DESCRIPTIONS -->

0 commit comments

Comments
 (0)