npm-explain.html 7.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291
  1. <!DOCTYPE html><html><head>
  2. <meta charset="utf-8">
  3. <title>npm-explain</title>
  4. <style>
  5. body {
  6. background-color: #ffffff;
  7. color: #24292e;
  8. margin: 0;
  9. line-height: 1.5;
  10. font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji";
  11. }
  12. #rainbar {
  13. height: 10px;
  14. background-image: linear-gradient(139deg, #fb8817, #ff4b01, #c12127, #e02aff);
  15. }
  16. a {
  17. text-decoration: none;
  18. color: #0366d6;
  19. }
  20. a:hover {
  21. text-decoration: underline;
  22. }
  23. pre {
  24. margin: 1em 0px;
  25. padding: 1em;
  26. border: solid 1px #e1e4e8;
  27. border-radius: 6px;
  28. display: block;
  29. overflow: auto;
  30. white-space: pre;
  31. background-color: #f6f8fa;
  32. color: #393a34;
  33. }
  34. code {
  35. font-family: SFMono-Regular, Consolas, "Liberation Mono", Menlo, Courier, monospace;
  36. font-size: 85%;
  37. padding: 0.2em 0.4em;
  38. background-color: #f6f8fa;
  39. color: #393a34;
  40. }
  41. pre > code {
  42. padding: 0;
  43. background-color: inherit;
  44. color: inherit;
  45. }
  46. h1, h2, h3 {
  47. font-weight: 600;
  48. }
  49. #logobar {
  50. background-color: #333333;
  51. margin: 0 auto;
  52. padding: 1em 4em;
  53. }
  54. #logobar .logo {
  55. float: left;
  56. }
  57. #logobar .title {
  58. font-weight: 600;
  59. color: #dddddd;
  60. float: left;
  61. margin: 5px 0 0 1em;
  62. }
  63. #logobar:after {
  64. content: "";
  65. display: block;
  66. clear: both;
  67. }
  68. #content {
  69. margin: 0 auto;
  70. padding: 0 4em;
  71. }
  72. #table_of_contents > h2 {
  73. font-size: 1.17em;
  74. }
  75. #table_of_contents ul:first-child {
  76. border: solid 1px #e1e4e8;
  77. border-radius: 6px;
  78. padding: 1em;
  79. background-color: #f6f8fa;
  80. color: #393a34;
  81. }
  82. #table_of_contents ul {
  83. list-style-type: none;
  84. padding-left: 1.5em;
  85. }
  86. #table_of_contents li {
  87. font-size: 0.9em;
  88. }
  89. #table_of_contents li a {
  90. color: #000000;
  91. }
  92. header.title {
  93. border-bottom: solid 1px #e1e4e8;
  94. }
  95. header.title > h1 {
  96. margin-bottom: 0.25em;
  97. }
  98. header.title > .description {
  99. display: block;
  100. margin-bottom: 0.5em;
  101. line-height: 1;
  102. }
  103. header.title .version {
  104. font-size: 0.8em;
  105. color: #666666;
  106. }
  107. footer#edit {
  108. border-top: solid 1px #e1e4e8;
  109. margin: 3em 0 4em 0;
  110. padding-top: 2em;
  111. }
  112. table {
  113. width: 100%;
  114. margin: 1em 0;
  115. border-radius: 6px;
  116. border: 1px solid #e1e4e8;
  117. overflow: hidden;
  118. border-collapse: separate;
  119. border-spacing: 0;
  120. }
  121. table thead {
  122. background-color: #f6f8fa;
  123. }
  124. table tbody {
  125. background-color: #ffffff;
  126. }
  127. table th,
  128. table td {
  129. padding: 0.75em;
  130. text-align: left;
  131. border-right: 1px solid #e1e4e8;
  132. border-bottom: 1px solid #e1e4e8;
  133. }
  134. table th:last-child,
  135. table td:last-child {
  136. border-right: none;
  137. }
  138. table tbody tr:last-child td {
  139. border-bottom: none;
  140. }
  141. table th {
  142. font-weight: 600;
  143. background-color: #f6f8fa;
  144. }
  145. table code {
  146. white-space: nowrap;
  147. }
  148. </style>
  149. </head>
  150. <body>
  151. <div id="banner">
  152. <div id="rainbar"></div>
  153. <div id="logobar">
  154. <svg class="logo" role="img" height="32" width="32" viewBox="0 0 700 700">
  155. <polygon fill="#cb0000" points="0,700 700,700 700,0 0,0"></polygon>
  156. <polygon fill="#ffffff" points="150,550 350,550 350,250 450,250 450,550 550,550 550,150 150,150"></polygon>
  157. </svg>
  158. <div class="title">
  159. npm command-line interface
  160. </div>
  161. </div>
  162. </div>
  163. <section id="content">
  164. <header class="title">
  165. <h1 id="----npm-explain----11120">
  166. <span>npm-explain</span>
  167. <span class="version">@11.12.0</span>
  168. </h1>
  169. <span class="description">Explain installed packages</span>
  170. </header>
  171. <section id="table_of_contents">
  172. <h2 id="table-of-contents">Table of contents</h2>
  173. <div id="_table_of_contents"><ul><li><a href="#synopsis">Synopsis</a></li><li><a href="#description">Description</a></li><li><a href="#configuration">Configuration</a></li><ul><li><a href="#json"><code>json</code></a></li><li><a href="#workspace"><code>workspace</code></a></li></ul><li><a href="#see-also">See Also</a></li></ul></div>
  174. </section>
  175. <div id="_content"><h3 id="synopsis">Synopsis</h3>
  176. <pre><code class="language-bash">npm explain &lt;package-spec&gt;
  177. alias: why
  178. </code></pre>
  179. <h3 id="description">Description</h3>
  180. <p>This command will print the chain of dependencies causing a given package to be installed in the current project.</p>
  181. <p>If one or more package specs are provided, then only packages matching one of the specifiers will have their relationships explained.</p>
  182. <p>The package spec can also refer to a folder within <code>./node_modules</code></p>
  183. <p>For example, running <code>npm explain glob</code> within npm's source tree will show:</p>
  184. <pre><code class="language-bash">glob@7.1.6
  185. node_modules/glob
  186. glob@"^7.1.4" from the root project
  187. glob@7.1.1 dev
  188. node_modules/tacks/node_modules/glob
  189. glob@"^7.0.5" from rimraf@2.6.2
  190. node_modules/tacks/node_modules/rimraf
  191. rimraf@"^2.6.2" from tacks@1.3.0
  192. node_modules/tacks
  193. dev tacks@"^1.3.0" from the root project
  194. </code></pre>
  195. <p>To explain just the package residing at a specific folder, pass that as the argument to the command.
  196. This can be useful when trying to figure out exactly why a given dependency is being duplicated to satisfy conflicting version requirements within the project.</p>
  197. <pre><code class="language-bash">$ npm explain node_modules/nyc/node_modules/find-up
  198. find-up@3.0.0 dev
  199. node_modules/nyc/node_modules/find-up
  200. find-up@"^3.0.0" from nyc@14.1.1
  201. node_modules/nyc
  202. nyc@"^14.1.1" from tap@14.10.8
  203. node_modules/tap
  204. dev tap@"^14.10.8" from the root project
  205. </code></pre>
  206. <h3 id="configuration">Configuration</h3>
  207. <h4 id="json"><code>json</code></h4>
  208. <ul>
  209. <li>Default: false</li>
  210. <li>Type: Boolean</li>
  211. </ul>
  212. <p>Whether or not to output JSON data, rather than the normal output.</p>
  213. <ul>
  214. <li>In <code>npm pkg set</code> it enables parsing set values with JSON.parse() before
  215. saving them to your <code>package.json</code>.</li>
  216. </ul>
  217. <p>Not supported by all npm commands.</p>
  218. <h4 id="workspace"><code>workspace</code></h4>
  219. <ul>
  220. <li>Default:</li>
  221. <li>Type: String (can be set multiple times)</li>
  222. </ul>
  223. <p>Enable running a command in the context of the configured workspaces of the
  224. current project while filtering by running only the workspaces defined by
  225. this configuration option.</p>
  226. <p>Valid values for the <code>workspace</code> config are either:</p>
  227. <ul>
  228. <li>Workspace names</li>
  229. <li>Path to a workspace directory</li>
  230. <li>Path to a parent workspace directory (will result in selecting all
  231. workspaces within that folder)</li>
  232. </ul>
  233. <p>When set for the <code>npm init</code> command, this may be set to the folder of a
  234. workspace which does not yet exist, to create the folder and set it up as a
  235. brand new workspace within the project.</p>
  236. <p>This value is not exported to the environment for child processes.</p>
  237. <h3 id="see-also">See Also</h3>
  238. <ul>
  239. <li><a href="../using-npm/package-spec.html">package spec</a></li>
  240. <li><a href="../commands/npm-config.html">npm config</a></li>
  241. <li><a href="../configuring-npm/npmrc.html">npmrc</a></li>
  242. <li><a href="../configuring-npm/folders.html">npm folders</a></li>
  243. <li><a href="../commands/npm-ls.html">npm ls</a></li>
  244. <li><a href="../commands/npm-install.html">npm install</a></li>
  245. <li><a href="../commands/npm-link.html">npm link</a></li>
  246. <li><a href="../commands/npm-prune.html">npm prune</a></li>
  247. <li><a href="../commands/npm-outdated.html">npm outdated</a></li>
  248. <li><a href="../commands/npm-update.html">npm update</a></li>
  249. </ul></div>
  250. <footer id="edit">
  251. <a href="https://github.com/npm/cli/edit/latest/docs/lib/content/commands/npm-explain.md">
  252. <svg role="img" viewBox="0 0 16 16" width="16" height="16" fill="currentcolor" style="vertical-align: text-bottom; margin-right: 0.3em;">
  253. <path fill-rule="evenodd" d="M11.013 1.427a1.75 1.75 0 012.474 0l1.086 1.086a1.75 1.75 0 010 2.474l-8.61 8.61c-.21.21-.47.364-.756.445l-3.251.93a.75.75 0 01-.927-.928l.929-3.25a1.75 1.75 0 01.445-.758l8.61-8.61zm1.414 1.06a.25.25 0 00-.354 0L10.811 3.75l1.439 1.44 1.263-1.263a.25.25 0 000-.354l-1.086-1.086zM11.189 6.25L9.75 4.81l-6.286 6.287a.25.25 0 00-.064.108l-.558 1.953 1.953-.558a.249.249 0 00.108-.064l6.286-6.286z"></path>
  254. </svg>
  255. Edit this page on GitHub
  256. </a>
  257. </footer>
  258. </section>
  259. </body></html>