npm-install-ci-test.html 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423
  1. <!DOCTYPE html><html><head>
  2. <meta charset="utf-8">
  3. <title>npm-install-ci-test</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-install-ci-test----11120">
  166. <span>npm-install-ci-test</span>
  167. <span class="version">@11.12.0</span>
  168. </h1>
  169. <span class="description">Install a project with a clean slate and run tests</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="#install-strategy"><code>install-strategy</code></a></li><li><a href="#legacy-bundling"><code>legacy-bundling</code></a></li><li><a href="#global-style"><code>global-style</code></a></li><li><a href="#omit"><code>omit</code></a></li><li><a href="#include"><code>include</code></a></li><li><a href="#strict-peer-deps"><code>strict-peer-deps</code></a></li><li><a href="#foreground-scripts"><code>foreground-scripts</code></a></li><li><a href="#ignore-scripts"><code>ignore-scripts</code></a></li><li><a href="#allow-git"><code>allow-git</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><li><a href="#install-links"><code>install-links</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 install-ci-test
  177. aliases: cit, clean-install-test, sit
  178. </code></pre>
  179. <h3 id="description">Description</h3>
  180. <p>This command runs <code>npm ci</code> followed immediately by <code>npm test</code>.</p>
  181. <h3 id="configuration">Configuration</h3>
  182. <h4 id="install-strategy"><code>install-strategy</code></h4>
  183. <ul>
  184. <li>Default: "hoisted"</li>
  185. <li>Type: "hoisted", "nested", "shallow", or "linked"</li>
  186. </ul>
  187. <p>Sets the strategy for installing packages in node_modules. hoisted
  188. (default): Install non-duplicated in top-level, and duplicated as necessary
  189. within directory structure. nested: (formerly --legacy-bundling) install in
  190. place, no hoisting. shallow (formerly --global-style) only install direct
  191. deps at top-level. linked: (experimental) install in node_modules/.store,
  192. link in place, unhoisted.</p>
  193. <h4 id="legacy-bundling"><code>legacy-bundling</code></h4>
  194. <ul>
  195. <li>Default: false</li>
  196. <li>Type: Boolean</li>
  197. <li>DEPRECATED: This option has been deprecated in favor of
  198. <code>--install-strategy=nested</code></li>
  199. </ul>
  200. <p>Instead of hoisting package installs in <code>node_modules</code>, install packages in
  201. the same manner that they are depended on. This may cause very deep
  202. directory structures and duplicate package installs as there is no
  203. de-duplicating. Sets <code>--install-strategy=nested</code>.</p>
  204. <h4 id="global-style"><code>global-style</code></h4>
  205. <ul>
  206. <li>Default: false</li>
  207. <li>Type: Boolean</li>
  208. <li>DEPRECATED: This option has been deprecated in favor of
  209. <code>--install-strategy=shallow</code></li>
  210. </ul>
  211. <p>Only install direct dependencies in the top level <code>node_modules</code>, but hoist
  212. on deeper dependencies. Sets <code>--install-strategy=shallow</code>.</p>
  213. <h4 id="omit"><code>omit</code></h4>
  214. <ul>
  215. <li>Default: 'dev' if the <code>NODE_ENV</code> environment variable is set to
  216. 'production'; otherwise, empty.</li>
  217. <li>Type: "dev", "optional", or "peer" (can be set multiple times)</li>
  218. </ul>
  219. <p>Dependency types to omit from the installation tree on disk.</p>
  220. <p>Note that these dependencies <em>are</em> still resolved and added to the
  221. <code>package-lock.json</code> or <code>npm-shrinkwrap.json</code> file. They are just not
  222. physically installed on disk.</p>
  223. <p>If a package type appears in both the <code>--include</code> and <code>--omit</code> lists, then
  224. it will be included.</p>
  225. <p>If the resulting omit list includes <code>'dev'</code>, then the <code>NODE_ENV</code> environment
  226. variable will be set to <code>'production'</code> for all lifecycle scripts.</p>
  227. <h4 id="include"><code>include</code></h4>
  228. <ul>
  229. <li>Default:</li>
  230. <li>Type: "prod", "dev", "optional", or "peer" (can be set multiple times)</li>
  231. </ul>
  232. <p>Option that allows for defining which types of dependencies to install.</p>
  233. <p>This is the inverse of <code>--omit=&lt;type&gt;</code>.</p>
  234. <p>Dependency types specified in <code>--include</code> will not be omitted, regardless of
  235. the order in which omit/include are specified on the command-line.</p>
  236. <h4 id="strict-peer-deps"><code>strict-peer-deps</code></h4>
  237. <ul>
  238. <li>Default: false</li>
  239. <li>Type: Boolean</li>
  240. </ul>
  241. <p>If set to <code>true</code>, and <code>--legacy-peer-deps</code> is not set, then <em>any</em>
  242. conflicting <code>peerDependencies</code> will be treated as an install failure, even
  243. if npm could reasonably guess the appropriate resolution based on non-peer
  244. dependency relationships.</p>
  245. <p>By default, conflicting <code>peerDependencies</code> deep in the dependency graph will
  246. be resolved using the nearest non-peer dependency specification, even if
  247. doing so will result in some packages receiving a peer dependency outside
  248. the range set in their package's <code>peerDependencies</code> object.</p>
  249. <p>When such an override is performed, a warning is printed, explaining the
  250. conflict and the packages involved. If <code>--strict-peer-deps</code> is set, then
  251. this warning is treated as a failure.</p>
  252. <h4 id="foreground-scripts"><code>foreground-scripts</code></h4>
  253. <ul>
  254. <li>Default: <code>false</code> unless when using <code>npm pack</code> or <code>npm publish</code> where it
  255. defaults to <code>true</code></li>
  256. <li>Type: Boolean</li>
  257. </ul>
  258. <p>Run all build scripts (ie, <code>preinstall</code>, <code>install</code>, and <code>postinstall</code>)
  259. scripts for installed packages in the foreground process, sharing standard
  260. input, output, and error with the main npm process.</p>
  261. <p>Note that this will generally make installs run slower, and be much noisier,
  262. but can be useful for debugging.</p>
  263. <h4 id="ignore-scripts"><code>ignore-scripts</code></h4>
  264. <ul>
  265. <li>Default: false</li>
  266. <li>Type: Boolean</li>
  267. </ul>
  268. <p>If true, npm does not run scripts specified in package.json files.</p>
  269. <p>Note that commands explicitly intended to run a particular script, such as
  270. <code>npm start</code>, <code>npm stop</code>, <code>npm restart</code>, <code>npm test</code>, and <code>npm run</code> will still
  271. run their intended script if <code>ignore-scripts</code> is set, but they will <em>not</em>
  272. run any pre- or post-scripts.</p>
  273. <h4 id="allow-git"><code>allow-git</code></h4>
  274. <ul>
  275. <li>Default: "all"</li>
  276. <li>Type: "all", "none", or "root"</li>
  277. </ul>
  278. <p>Limits the ability for npm to fetch dependencies from git references. That
  279. is, dependencies that point to a git repo instead of a version or semver
  280. range. Please note that this could leave your tree incomplete and some
  281. packages may not function as intended or designed.</p>
  282. <p><code>all</code> allows any git dependencies to be fetched and installed. <code>none</code>
  283. prevents any git dependencies from being fetched and installed. <code>root</code> only
  284. allows git dependencies defined in your project's package.json to be fetched
  285. installed. Also allows git dependencies to be fetched for other commands
  286. like <code>npm view</code></p>
  287. <h4 id="audit"><code>audit</code></h4>
  288. <ul>
  289. <li>Default: true</li>
  290. <li>Type: Boolean</li>
  291. </ul>
  292. <p>When "true" submit audit reports alongside the current npm command to the
  293. default registry and all registries configured for scopes. See the
  294. documentation for <a href="../commands/npm-audit.html"><code>npm audit</code></a> for details on what is
  295. submitted.</p>
  296. <h4 id="bin-links"><code>bin-links</code></h4>
  297. <ul>
  298. <li>Default: true</li>
  299. <li>Type: Boolean</li>
  300. </ul>
  301. <p>Tells npm to create symlinks (or <code>.cmd</code> shims on Windows) for package
  302. executables.</p>
  303. <p>Set to false to have it not do this. This can be used to work around the
  304. fact that some file systems don't support symlinks, even on ostensibly Unix
  305. systems.</p>
  306. <h4 id="fund"><code>fund</code></h4>
  307. <ul>
  308. <li>Default: true</li>
  309. <li>Type: Boolean</li>
  310. </ul>
  311. <p>When "true" displays the message at the end of each <code>npm install</code>
  312. acknowledging the number of dependencies looking for funding. See <a href="../commands/npm-fund.html"><code>npm fund</code></a> for details.</p>
  313. <h4 id="dry-run"><code>dry-run</code></h4>
  314. <ul>
  315. <li>Default: false</li>
  316. <li>Type: Boolean</li>
  317. </ul>
  318. <p>Indicates that you don't want npm to make any changes and that it should
  319. only report what it would have done. This can be passed into any of the
  320. commands that modify your local installation, eg, <code>install</code>, <code>update</code>,
  321. <code>dedupe</code>, <code>uninstall</code>, as well as <code>pack</code> and <code>publish</code>.</p>
  322. <p>Note: This is NOT honored by other network related commands, eg <code>dist-tags</code>,
  323. <code>owner</code>, etc.</p>
  324. <h4 id="workspace"><code>workspace</code></h4>
  325. <ul>
  326. <li>Default:</li>
  327. <li>Type: String (can be set multiple times)</li>
  328. </ul>
  329. <p>Enable running a command in the context of the configured workspaces of the
  330. current project while filtering by running only the workspaces defined by
  331. this configuration option.</p>
  332. <p>Valid values for the <code>workspace</code> config are either:</p>
  333. <ul>
  334. <li>Workspace names</li>
  335. <li>Path to a workspace directory</li>
  336. <li>Path to a parent workspace directory (will result in selecting all
  337. workspaces within that folder)</li>
  338. </ul>
  339. <p>When set for the <code>npm init</code> command, this may be set to the folder of a
  340. workspace which does not yet exist, to create the folder and set it up as a
  341. brand new workspace within the project.</p>
  342. <p>This value is not exported to the environment for child processes.</p>
  343. <h4 id="workspaces"><code>workspaces</code></h4>
  344. <ul>
  345. <li>Default: null</li>
  346. <li>Type: null or Boolean</li>
  347. </ul>
  348. <p>Set to true to run the command in the context of <strong>all</strong> configured
  349. workspaces.</p>
  350. <p>Explicitly setting this to false will cause commands like <code>install</code> to
  351. ignore workspaces altogether. When not set explicitly:</p>
  352. <ul>
  353. <li>Commands that operate on the <code>node_modules</code> tree (install, update, etc.)
  354. will link workspaces into the <code>node_modules</code> folder. - Commands that do
  355. other things (test, exec, publish, etc.) will operate on the root project,
  356. <em>unless</em> one or more workspaces are specified in the <code>workspace</code> config.</li>
  357. </ul>
  358. <p>This value is not exported to the environment for child processes.</p>
  359. <h4 id="include-workspace-root"><code>include-workspace-root</code></h4>
  360. <ul>
  361. <li>Default: false</li>
  362. <li>Type: Boolean</li>
  363. </ul>
  364. <p>Include the workspace root when workspaces are enabled for a command.</p>
  365. <p>When false, specifying individual workspaces via the <code>workspace</code> config, or
  366. all workspaces via the <code>workspaces</code> flag, will cause npm to operate only on
  367. the specified workspaces, and not on the root project.</p>
  368. <p>This value is not exported to the environment for child processes.</p>
  369. <h4 id="install-links"><code>install-links</code></h4>
  370. <ul>
  371. <li>Default: false</li>
  372. <li>Type: Boolean</li>
  373. </ul>
  374. <p>When set file: protocol dependencies will be packed and installed as regular
  375. dependencies instead of creating a symlink. This option has no effect on
  376. workspaces.</p>
  377. <h3 id="see-also">See Also</h3>
  378. <ul>
  379. <li><a href="../commands/npm-install-test.html">npm install-test</a></li>
  380. <li><a href="../commands/npm-ci.html">npm ci</a></li>
  381. <li><a href="../commands/npm-test.html">npm test</a></li>
  382. </ul></div>
  383. <footer id="edit">
  384. <a href="https://github.com/npm/cli/edit/latest/docs/lib/content/commands/npm-install-ci-test.md">
  385. <svg role="img" viewBox="0 0 16 16" width="16" height="16" fill="currentcolor" style="vertical-align: text-bottom; margin-right: 0.3em;">
  386. <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>
  387. </svg>
  388. Edit this page on GitHub
  389. </a>
  390. </footer>
  391. </section>
  392. </body></html>