npm-install-test.html 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400
  1. <html><head>
  2. <title>npm-install-test</title>
  3. <style>
  4. body {
  5. background-color: #ffffff;
  6. color: #24292e;
  7. margin: 0;
  8. line-height: 1.5;
  9. font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji";
  10. }
  11. #rainbar {
  12. height: 10px;
  13. background-image: linear-gradient(139deg, #fb8817, #ff4b01, #c12127, #e02aff);
  14. }
  15. a {
  16. text-decoration: none;
  17. color: #0366d6;
  18. }
  19. a:hover {
  20. text-decoration: underline;
  21. }
  22. pre {
  23. margin: 1em 0px;
  24. padding: 1em;
  25. border: solid 1px #e1e4e8;
  26. border-radius: 6px;
  27. display: block;
  28. overflow: auto;
  29. white-space: pre;
  30. background-color: #f6f8fa;
  31. color: #393a34;
  32. }
  33. code {
  34. font-family: SFMono-Regular, Consolas, "Liberation Mono", Menlo, Courier, monospace;
  35. font-size: 85%;
  36. padding: 0.2em 0.4em;
  37. background-color: #f6f8fa;
  38. color: #393a34;
  39. }
  40. pre > code {
  41. padding: 0;
  42. background-color: inherit;
  43. color: inherit;
  44. }
  45. h1, h2, h3 {
  46. font-weight: 600;
  47. }
  48. #logobar {
  49. background-color: #333333;
  50. margin: 0 auto;
  51. padding: 1em 4em;
  52. }
  53. #logobar .logo {
  54. float: left;
  55. }
  56. #logobar .title {
  57. font-weight: 600;
  58. color: #dddddd;
  59. float: left;
  60. margin: 5px 0 0 1em;
  61. }
  62. #logobar:after {
  63. content: "";
  64. display: block;
  65. clear: both;
  66. }
  67. #content {
  68. margin: 0 auto;
  69. padding: 0 4em;
  70. }
  71. #table_of_contents > h2 {
  72. font-size: 1.17em;
  73. }
  74. #table_of_contents ul:first-child {
  75. border: solid 1px #e1e4e8;
  76. border-radius: 6px;
  77. padding: 1em;
  78. background-color: #f6f8fa;
  79. color: #393a34;
  80. }
  81. #table_of_contents ul {
  82. list-style-type: none;
  83. padding-left: 1.5em;
  84. }
  85. #table_of_contents li {
  86. font-size: 0.9em;
  87. }
  88. #table_of_contents li a {
  89. color: #000000;
  90. }
  91. header.title {
  92. border-bottom: solid 1px #e1e4e8;
  93. }
  94. header.title > h1 {
  95. margin-bottom: 0.25em;
  96. }
  97. header.title > .description {
  98. display: block;
  99. margin-bottom: 0.5em;
  100. line-height: 1;
  101. }
  102. footer#edit {
  103. border-top: solid 1px #e1e4e8;
  104. margin: 3em 0 4em 0;
  105. padding-top: 2em;
  106. }
  107. </style>
  108. </head>
  109. <body>
  110. <div id="banner">
  111. <div id="rainbar"></div>
  112. <div id="logobar">
  113. <svg class="logo" role="img" height="32" width="32" viewBox="0 0 700 700">
  114. <polygon fill="#cb0000" points="0,700 700,700 700,0 0,0"></polygon>
  115. <polygon fill="#ffffff" points="150,550 350,550 350,250 450,250 450,550 550,550 550,150 150,150"></polygon>
  116. </svg>
  117. <div class="title">
  118. npm command-line interface
  119. </div>
  120. </div>
  121. </div>
  122. <section id="content">
  123. <header class="title">
  124. <h1 id="npm-install-test">npm-install-test</h1>
  125. <span class="description">Install package(s) and run tests</span>
  126. </header>
  127. <section id="table_of_contents">
  128. <h2 id="table-of-contents">Table of contents</h2>
  129. <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="#save"><code>save</code></a></li><li><a href="#save-exact"><code>save-exact</code></a></li><li><a href="#global"><code>global</code></a></li><li><a href="#global-style"><code>global-style</code></a></li><li><a href="#legacy-bundling"><code>legacy-bundling</code></a></li><li><a href="#strict-peer-deps"><code>strict-peer-deps</code></a></li><li><a href="#package-lock"><code>package-lock</code></a></li><li><a href="#omit"><code>omit</code></a></li><li><a href="#ignore-scripts"><code>ignore-scripts</code></a></li><li><a href="#audit"><code>audit</code></a></li><li><a href="#bin-links"><code>bin-links</code></a></li><li><a href="#fund"><code>fund</code></a></li><li><a href="#dry-run"><code>dry-run</code></a></li><li><a href="#workspace"><code>workspace</code></a></li><li><a href="#workspaces"><code>workspaces</code></a></li><li><a href="#include-workspace-root"><code>include-workspace-root</code></a></li></ul><li><a href="#see-also">See Also</a></li></ul></div>
  130. </section>
  131. <div id="_content"><h3 id="synopsis">Synopsis</h3>
  132. <pre lang="bash"><code>npm install-test (with no args, in package dir)
  133. npm install-test [&lt;@scope&gt;/]&lt;name&gt;
  134. npm install-test [&lt;@scope&gt;/]&lt;name&gt;@&lt;tag&gt;
  135. npm install-test [&lt;@scope&gt;/]&lt;name&gt;@&lt;version&gt;
  136. npm install-test [&lt;@scope&gt;/]&lt;name&gt;@&lt;version range&gt;
  137. npm install-test &lt;tarball file&gt;
  138. npm install-test &lt;tarball url&gt;
  139. npm install-test &lt;folder&gt;
  140. alias: npm it
  141. common options: [--save|--save-dev|--save-optional] [--save-exact] [--dry-run]
  142. </code></pre>
  143. <h3 id="description">Description</h3>
  144. <p>This command runs an <code>npm install</code> followed immediately by an <code>npm test</code>. It
  145. takes exactly the same arguments as <code>npm install</code>.</p>
  146. <h3 id="configuration">Configuration</h3>
  147. <!-- raw HTML omitted -->
  148. <!-- raw HTML omitted -->
  149. <!-- raw HTML omitted -->
  150. <h4 id="save"><code>save</code></h4>
  151. <ul>
  152. <li>Default: true</li>
  153. <li>Type: Boolean</li>
  154. </ul>
  155. <p>Save installed packages to a package.json file as dependencies.</p>
  156. <p>When used with the <code>npm rm</code> command, removes the dependency from
  157. package.json.</p>
  158. <!-- raw HTML omitted -->
  159. <!-- raw HTML omitted -->
  160. <h4 id="save-exact"><code>save-exact</code></h4>
  161. <ul>
  162. <li>Default: false</li>
  163. <li>Type: Boolean</li>
  164. </ul>
  165. <p>Dependencies saved to package.json will be configured with an exact version
  166. rather than using npm’s default semver range operator.</p>
  167. <!-- raw HTML omitted -->
  168. <!-- raw HTML omitted -->
  169. <h4 id="global"><code>global</code></h4>
  170. <ul>
  171. <li>Default: false</li>
  172. <li>Type: Boolean</li>
  173. </ul>
  174. <p>Operates in “global” mode, so that packages are installed into the <code>prefix</code>
  175. folder instead of the current working directory. See
  176. <a href="../configuring-npm/folders.html">folders</a> for more on the differences in behavior.</p>
  177. <ul>
  178. <li>packages are installed into the <code>{prefix}/lib/node_modules</code> folder, instead
  179. of the current working directory.</li>
  180. <li>bin files are linked to <code>{prefix}/bin</code></li>
  181. <li>man pages are linked to <code>{prefix}/share/man</code></li>
  182. </ul>
  183. <!-- raw HTML omitted -->
  184. <!-- raw HTML omitted -->
  185. <h4 id="global-style"><code>global-style</code></h4>
  186. <ul>
  187. <li>Default: false</li>
  188. <li>Type: Boolean</li>
  189. </ul>
  190. <p>Causes npm to install the package into your local <code>node_modules</code> folder with
  191. the same layout it uses with the global <code>node_modules</code> folder. Only your
  192. direct dependencies will show in <code>node_modules</code> and everything they depend
  193. on will be flattened in their <code>node_modules</code> folders. This obviously will
  194. eliminate some deduping. If used with <code>legacy-bundling</code>, <code>legacy-bundling</code>
  195. will be preferred.</p>
  196. <!-- raw HTML omitted -->
  197. <!-- raw HTML omitted -->
  198. <h4 id="legacy-bundling"><code>legacy-bundling</code></h4>
  199. <ul>
  200. <li>Default: false</li>
  201. <li>Type: Boolean</li>
  202. </ul>
  203. <p>Causes npm to install the package such that versions of npm prior to 1.4,
  204. such as the one included with node 0.8, can install the package. This
  205. eliminates all automatic deduping. If used with <code>global-style</code> this option
  206. will be preferred.</p>
  207. <!-- raw HTML omitted -->
  208. <!-- raw HTML omitted -->
  209. <h4 id="strict-peer-deps"><code>strict-peer-deps</code></h4>
  210. <ul>
  211. <li>Default: false</li>
  212. <li>Type: Boolean</li>
  213. </ul>
  214. <p>If set to <code>true</code>, and <code>--legacy-peer-deps</code> is not set, then <em>any</em>
  215. conflicting <code>peerDependencies</code> will be treated as an install failure, even
  216. if npm could reasonably guess the appropriate resolution based on non-peer
  217. dependency relationships.</p>
  218. <p>By default, conflicting <code>peerDependencies</code> deep in the dependency graph will
  219. be resolved using the nearest non-peer dependency specification, even if
  220. doing so will result in some packages receiving a peer dependency outside
  221. the range set in their package’s <code>peerDependencies</code> object.</p>
  222. <p>When such and override is performed, a warning is printed, explaining the
  223. conflict and the packages involved. If <code>--strict-peer-deps</code> is set, then
  224. this warning is treated as a failure.</p>
  225. <!-- raw HTML omitted -->
  226. <!-- raw HTML omitted -->
  227. <h4 id="package-lock"><code>package-lock</code></h4>
  228. <ul>
  229. <li>Default: true</li>
  230. <li>Type: Boolean</li>
  231. </ul>
  232. <p>If set to false, then ignore <code>package-lock.json</code> files when installing. This
  233. will also prevent <em>writing</em> <code>package-lock.json</code> if <code>save</code> is true.</p>
  234. <p>When package package-locks are disabled, automatic pruning of extraneous
  235. modules will also be disabled. To remove extraneous modules with
  236. package-locks disabled use <code>npm prune</code>.</p>
  237. <!-- raw HTML omitted -->
  238. <!-- raw HTML omitted -->
  239. <h4 id="omit"><code>omit</code></h4>
  240. <ul>
  241. <li>Default: ‘dev’ if the <code>NODE_ENV</code> environment variable is set to
  242. ‘production’, otherwise empty.</li>
  243. <li>Type: “dev”, “optional”, or “peer” (can be set multiple times)</li>
  244. </ul>
  245. <p>Dependency types to omit from the installation tree on disk.</p>
  246. <p>Note that these dependencies <em>are</em> still resolved and added to the
  247. <code>package-lock.json</code> or <code>npm-shrinkwrap.json</code> file. They are just not
  248. physically installed on disk.</p>
  249. <p>If a package type appears in both the <code>--include</code> and <code>--omit</code> lists, then
  250. it will be included.</p>
  251. <p>If the resulting omit list includes <code>'dev'</code>, then the <code>NODE_ENV</code> environment
  252. variable will be set to <code>'production'</code> for all lifecycle scripts.</p>
  253. <!-- raw HTML omitted -->
  254. <!-- raw HTML omitted -->
  255. <h4 id="ignore-scripts"><code>ignore-scripts</code></h4>
  256. <ul>
  257. <li>Default: false</li>
  258. <li>Type: Boolean</li>
  259. </ul>
  260. <p>If true, npm does not run scripts specified in package.json files.</p>
  261. <p>Note that commands explicitly intended to run a particular script, such as
  262. <code>npm start</code>, <code>npm stop</code>, <code>npm restart</code>, <code>npm test</code>, and <code>npm run-script</code>
  263. will still run their intended script if <code>ignore-scripts</code> is set, but they
  264. will <em>not</em> run any pre- or post-scripts.</p>
  265. <!-- raw HTML omitted -->
  266. <!-- raw HTML omitted -->
  267. <h4 id="audit"><code>audit</code></h4>
  268. <ul>
  269. <li>Default: true</li>
  270. <li>Type: Boolean</li>
  271. </ul>
  272. <p>When “true” submit audit reports alongside the current npm command to the
  273. default registry and all registries configured for scopes. See the
  274. documentation for <a href="../commands/npm-audit.html"><code>npm audit</code></a> for details on what is
  275. submitted.</p>
  276. <!-- raw HTML omitted -->
  277. <!-- raw HTML omitted -->
  278. <h4 id="bin-links"><code>bin-links</code></h4>
  279. <ul>
  280. <li>Default: true</li>
  281. <li>Type: Boolean</li>
  282. </ul>
  283. <p>Tells npm to create symlinks (or <code>.cmd</code> shims on Windows) for package
  284. executables.</p>
  285. <p>Set to false to have it not do this. This can be used to work around the
  286. fact that some file systems don’t support symlinks, even on ostensibly Unix
  287. systems.</p>
  288. <!-- raw HTML omitted -->
  289. <!-- raw HTML omitted -->
  290. <h4 id="fund"><code>fund</code></h4>
  291. <ul>
  292. <li>Default: true</li>
  293. <li>Type: Boolean</li>
  294. </ul>
  295. <p>When “true” displays the message at the end of each <code>npm install</code>
  296. acknowledging the number of dependencies looking for funding. See <a href="../commands/npm-fund.html"><code>npm fund</code></a> for details.</p>
  297. <!-- raw HTML omitted -->
  298. <!-- raw HTML omitted -->
  299. <h4 id="dry-run"><code>dry-run</code></h4>
  300. <ul>
  301. <li>Default: false</li>
  302. <li>Type: Boolean</li>
  303. </ul>
  304. <p>Indicates that you don’t want npm to make any changes and that it should
  305. only report what it would have done. This can be passed into any of the
  306. commands that modify your local installation, eg, <code>install</code>, <code>update</code>,
  307. <code>dedupe</code>, <code>uninstall</code>, as well as <code>pack</code> and <code>publish</code>.</p>
  308. <p>Note: This is NOT honored by other network related commands, eg <code>dist-tags</code>,
  309. <code>owner</code>, etc.</p>
  310. <!-- raw HTML omitted -->
  311. <!-- raw HTML omitted -->
  312. <h4 id="workspace"><code>workspace</code></h4>
  313. <ul>
  314. <li>Default:</li>
  315. <li>Type: String (can be set multiple times)</li>
  316. </ul>
  317. <p>Enable running a command in the context of the configured workspaces of the
  318. current project while filtering by running only the workspaces defined by
  319. this configuration option.</p>
  320. <p>Valid values for the <code>workspace</code> config are either:</p>
  321. <ul>
  322. <li>Workspace names</li>
  323. <li>Path to a workspace directory</li>
  324. <li>Path to a parent workspace directory (will result in selecting all
  325. workspaces within that folder)</li>
  326. </ul>
  327. <p>When set for the <code>npm init</code> command, this may be set to the folder of a
  328. workspace which does not yet exist, to create the folder and set it up as a
  329. brand new workspace within the project.</p>
  330. <p>This value is not exported to the environment for child processes.</p>
  331. <!-- raw HTML omitted -->
  332. <!-- raw HTML omitted -->
  333. <h4 id="workspaces"><code>workspaces</code></h4>
  334. <ul>
  335. <li>Default: null</li>
  336. <li>Type: null or Boolean</li>
  337. </ul>
  338. <p>Set to true to run the command in the context of <strong>all</strong> configured
  339. workspaces.</p>
  340. <p>Explicitly setting this to false will cause commands like <code>install</code> to
  341. ignore workspaces altogether. When not set explicitly:</p>
  342. <ul>
  343. <li>Commands that operate on the <code>node_modules</code> tree (install, update, etc.)
  344. will link workspaces into the <code>node_modules</code> folder. - Commands that do
  345. other things (test, exec, publish, etc.) will operate on the root project,
  346. <em>unless</em> one or more workspaces are specified in the <code>workspace</code> config.</li>
  347. </ul>
  348. <p>This value is not exported to the environment for child processes.</p>
  349. <!-- raw HTML omitted -->
  350. <!-- raw HTML omitted -->
  351. <h4 id="include-workspace-root"><code>include-workspace-root</code></h4>
  352. <ul>
  353. <li>Default: false</li>
  354. <li>Type: Boolean</li>
  355. </ul>
  356. <p>Include the workspace root when workspaces are enabled for a command.</p>
  357. <p>When false, specifying individual workspaces via the <code>workspace</code> config, or
  358. all workspaces via the <code>workspaces</code> flag, will cause npm to operate only on
  359. the specified workspaces, and not on the root project.</p>
  360. <!-- raw HTML omitted -->
  361. <!-- raw HTML omitted -->
  362. <!-- raw HTML omitted -->
  363. <h3 id="see-also">See Also</h3>
  364. <ul>
  365. <li><a href="../commands/npm-install.html">npm install</a></li>
  366. <li><a href="../commands/npm-install-ci-test.html">npm install-ci-test</a></li>
  367. <li><a href="../commands/npm-test.html">npm test</a></li>
  368. </ul>
  369. </div>
  370. <footer id="edit">
  371. <a href="https://github.com/npm/cli/edit/latest/docs/content/commands/npm-install-test.md">
  372. <svg role="img" viewBox="0 0 16 16" width="16" height="16" fill="currentcolor" style="vertical-align: text-bottom; margin-right: 0.3em;">
  373. <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>
  374. </svg>
  375. Edit this page on GitHub
  376. </a>
  377. </footer>
  378. </section>
  379. </body></html>