codekingpro/portable-devtools
114k
1<!DOCTYPE html><html><head>
2<meta charset="utf-8">
3<title>npm-install-ci-test</title>
4<style>
5body {
6 background-color: #ffffff;
7 color: #24292e;
8
9 margin: 0;
10
11 line-height: 1.5;
12
13 font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji";
14}
15#rainbar {
16 height: 10px;
17 background-image: linear-gradient(139deg, #fb8817, #ff4b01, #c12127, #e02aff);
18}
19
20a {
21 text-decoration: none;
22 color: #0366d6;
23}
24a:hover {
25 text-decoration: underline;
26}
27
28pre {
29 margin: 1em 0px;
30 padding: 1em;
31 border: solid 1px #e1e4e8;
32 border-radius: 6px;
33
34 display: block;
35 overflow: auto;
36
37 white-space: pre;
38
39 background-color: #f6f8fa;
40 color: #393a34;
41}
42code {
43 font-family: SFMono-Regular, Consolas, "Liberation Mono", Menlo, Courier, monospace;
44 font-size: 85%;
45 padding: 0.2em 0.4em;
46 background-color: #f6f8fa;
47 color: #393a34;
48}
49pre > code {
50 padding: 0;
51 background-color: inherit;
52 color: inherit;
53}
54h1, h2, h3 {
55 font-weight: 600;
56}
57
58#logobar {
59 background-color: #333333;
60 margin: 0 auto;
61 padding: 1em 4em;
62}
63#logobar .logo {
64 float: left;
65}
66#logobar .title {
67 font-weight: 600;
68 color: #dddddd;
69 float: left;
70 margin: 5px 0 0 1em;
71}
72#logobar:after {
73 content: "";
74 display: block;
75 clear: both;
76}
77
78#content {
79 margin: 0 auto;
80 padding: 0 4em;
81}
82
83#table_of_contents > h2 {
84 font-size: 1.17em;
85}
86#table_of_contents ul:first-child {
87 border: solid 1px #e1e4e8;
88 border-radius: 6px;
89 padding: 1em;
90 background-color: #f6f8fa;
91 color: #393a34;
92}
93#table_of_contents ul {
94 list-style-type: none;
95 padding-left: 1.5em;
96}
97#table_of_contents li {
98 font-size: 0.9em;
99}
100#table_of_contents li a {
101 color: #000000;
102}
103
104header.title {
105 border-bottom: solid 1px #e1e4e8;
106}
107header.title > h1 {
108 margin-bottom: 0.25em;
109}
110header.title > .description {
111 display: block;
112 margin-bottom: 0.5em;
113 line-height: 1;
114}
115
116header.title .version {
117 font-size: 0.8em;
118 color: #666666;
119}
120
121footer#edit {
122 border-top: solid 1px #e1e4e8;
123 margin: 3em 0 4em 0;
124 padding-top: 2em;
125}
126
127table {
128 width: 100%;
129 margin: 1em 0;
130 border-radius: 6px;
131 border: 1px solid #e1e4e8;
132 overflow: hidden;
133 border-collapse: separate;
134 border-spacing: 0;
135}
136
137table thead {
138 background-color: #f6f8fa;
139}
140
141table tbody {
142 background-color: #ffffff;
143}
144
145table th,
146table td {
147 padding: 0.75em;
148 text-align: left;
149 border-right: 1px solid #e1e4e8;
150 border-bottom: 1px solid #e1e4e8;
151}
152
153table th:last-child,
154table td:last-child {
155 border-right: none;
156}
157
158table tbody tr:last-child td {
159 border-bottom: none;
160}
161
162table th {
163 font-weight: 600;
164 background-color: #f6f8fa;
165}
166
167table code {
168 white-space: nowrap;
169}
170
171</style>
172</head>
173<body>
174<div id="banner">
175<div id="rainbar"></div>
176<div id="logobar">
177<svg class="logo" role="img" height="32" width="32" viewBox="0 0 700 700">
178<polygon fill="#cb0000" points="0,700 700,700 700,0 0,0"></polygon>
179<polygon fill="#ffffff" points="150,550 350,550 350,250 450,250 450,550 550,550 550,150 150,150"></polygon>
180</svg>
181<div class="title">
182npm command-line interface
183</div>
184</div>
185</div>
186
187<section id="content">
188<header class="title">
189<h1 id="----npm-install-ci-test----11130">
190 <span>npm-install-ci-test</span>
191 <span class="version">@11.13.0</span>
192</h1>
193<span class="description">Install a project with a clean slate and run tests</span>
194</header>
195
196<section id="table_of_contents">
197<h2 id="table-of-contents">Table of contents</h2>
198<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>
199</section>
200
201<div id="_content"><h3 id="synopsis">Synopsis</h3>
202<pre><code class="language-bash">npm install-ci-test
203
204aliases: cit, clean-install-test, sit
205</code></pre>
206<h3 id="description">Description</h3>
207<p>This command runs <code>npm ci</code> followed immediately by <code>npm test</code>.</p>
208<h3 id="configuration">Configuration</h3>
209<h4 id="install-strategy"><code>install-strategy</code></h4>
210<ul>
211<li>Default: "hoisted"</li>
212<li>Type: "hoisted", "nested", "shallow", or "linked"</li>
213</ul>
214<p>Sets the strategy for installing packages in node_modules. hoisted
215(default): Install non-duplicated in top-level, and duplicated as necessary
216within directory structure. nested: (formerly --legacy-bundling) install in
217place, no hoisting. shallow (formerly --global-style) only install direct
218deps at top-level. linked: (experimental) install in node_modules/.store,
219link in place, unhoisted.</p>
220<h4 id="legacy-bundling"><code>legacy-bundling</code></h4>
221<ul>
222<li>Default: false</li>
223<li>Type: Boolean</li>
224<li>DEPRECATED: This option has been deprecated in favor of
225<code>--install-strategy=nested</code></li>
226</ul>
227<p>Instead of hoisting package installs in <code>node_modules</code>, install packages in
228the same manner that they are depended on. This may cause very deep
229directory structures and duplicate package installs as there is no
230de-duplicating. Sets <code>--install-strategy=nested</code>.</p>
231<h4 id="global-style"><code>global-style</code></h4>
232<ul>
233<li>Default: false</li>
234<li>Type: Boolean</li>
235<li>DEPRECATED: This option has been deprecated in favor of
236<code>--install-strategy=shallow</code></li>
237</ul>
238<p>Only install direct dependencies in the top level <code>node_modules</code>, but hoist
239on deeper dependencies. Sets <code>--install-strategy=shallow</code>.</p>
240<h4 id="omit"><code>omit</code></h4>
241<ul>
242<li>Default: 'dev' if the <code>NODE_ENV</code> environment variable is set to
243'production'; otherwise, empty.</li>
244<li>Type: "dev", "optional", or "peer" (can be set multiple times)</li>
245</ul>
246<p>Dependency types to omit from the installation tree on disk.</p>
247<p>Note that these dependencies <em>are</em> still resolved and added to the
248<code>package-lock.json</code> or <code>npm-shrinkwrap.json</code> file. They are just not
249physically installed on disk.</p>
250<p>If a package type appears in both the <code>--include</code> and <code>--omit</code> lists, then
251it will be included.</p>
252<p>If the resulting omit list includes <code>'dev'</code>, then the <code>NODE_ENV</code> environment
253variable will be set to <code>'production'</code> for all lifecycle scripts.</p>
254<h4 id="include"><code>include</code></h4>
255<ul>
256<li>Default:</li>
257<li>Type: "prod", "dev", "optional", or "peer" (can be set multiple times)</li>
258</ul>
259<p>Option that allows for defining which types of dependencies to install.</p>
260<p>This is the inverse of <code>--omit=<type></code>.</p>
261<p>Dependency types specified in <code>--include</code> will not be omitted, regardless of
262the order in which omit/include are specified on the command-line.</p>
263<h4 id="strict-peer-deps"><code>strict-peer-deps</code></h4>
264<ul>
265<li>Default: false</li>
266<li>Type: Boolean</li>
267</ul>
268<p>If set to <code>true</code>, and <code>--legacy-peer-deps</code> is not set, then <em>any</em>
269conflicting <code>peerDependencies</code> will be treated as an install failure, even
270if npm could reasonably guess the appropriate resolution based on non-peer
271dependency relationships.</p>
272<p>By default, conflicting <code>peerDependencies</code> deep in the dependency graph will
273be resolved using the nearest non-peer dependency specification, even if
274doing so will result in some packages receiving a peer dependency outside
275the range set in their package's <code>peerDependencies</code> object.</p>
276<p>When such an override is performed, a warning is printed, explaining the
277conflict and the packages involved. If <code>--strict-peer-deps</code> is set, then
278this warning is treated as a failure.</p>
279<h4 id="foreground-scripts"><code>foreground-scripts</code></h4>
280<ul>
281<li>Default: <code>false</code> unless when using <code>npm pack</code> or <code>npm publish</code> where it
282defaults to <code>true</code></li>
283<li>Type: Boolean</li>
284</ul>
285<p>Run all build scripts (ie, <code>preinstall</code>, <code>install</code>, and <code>postinstall</code>)
286scripts for installed packages in the foreground process, sharing standard
287input, output, and error with the main npm process.</p>
288<p>Note that this will generally make installs run slower, and be much noisier,
289but can be useful for debugging.</p>
290<h4 id="ignore-scripts"><code>ignore-scripts</code></h4>
291<ul>
292<li>Default: false</li>
293<li>Type: Boolean</li>
294</ul>
295<p>If true, npm does not run scripts specified in package.json files.</p>
296<p>Note that commands explicitly intended to run a particular script, such as
297<code>npm start</code>, <code>npm stop</code>, <code>npm restart</code>, <code>npm test</code>, and <code>npm run</code> will still
298run their intended script if <code>ignore-scripts</code> is set, but they will <em>not</em>
299run any pre- or post-scripts.</p>
300<h4 id="allow-git"><code>allow-git</code></h4>
301<ul>
302<li>Default: "all"</li>
303<li>Type: "all", "none", or "root"</li>
304</ul>
305<p>Limits the ability for npm to fetch dependencies from git references. That
306is, dependencies that point to a git repo instead of a version or semver
307range. Please note that this could leave your tree incomplete and some
308packages may not function as intended or designed.</p>
309<p><code>all</code> allows any git dependencies to be fetched and installed. <code>none</code>
310prevents any git dependencies from being fetched and installed. <code>root</code> only
311allows git dependencies defined in your project's package.json to be fetched
312installed. Also allows git dependencies to be fetched for other commands
313like <code>npm view</code></p>
314<h4 id="audit"><code>audit</code></h4>
315<ul>
316<li>Default: true</li>
317<li>Type: Boolean</li>
318</ul>
319<p>When "true" submit audit reports alongside the current npm command to the
320default registry and all registries configured for scopes. See the
321documentation for <a href="../commands/npm-audit.html"><code>npm audit</code></a> for details on what is
322submitted.</p>
323<h4 id="bin-links"><code>bin-links</code></h4>
324<ul>
325<li>Default: true</li>
326<li>Type: Boolean</li>
327</ul>
328<p>Tells npm to create symlinks (or <code>.cmd</code> shims on Windows) for package
329executables.</p>
330<p>Set to false to have it not do this. This can be used to work around the
331fact that some file systems don't support symlinks, even on ostensibly Unix
332systems.</p>
333<h4 id="fund"><code>fund</code></h4>
334<ul>
335<li>Default: true</li>
336<li>Type: Boolean</li>
337</ul>
338<p>When "true" displays the message at the end of each <code>npm install</code>
339acknowledging the number of dependencies looking for funding. See <a href="../commands/npm-fund.html"><code>npm fund</code></a> for details.</p>
340<h4 id="dry-run"><code>dry-run</code></h4>
341<ul>
342<li>Default: false</li>
343<li>Type: Boolean</li>
344</ul>
345<p>Indicates that you don't want npm to make any changes and that it should
346only report what it would have done. This can be passed into any of the
347commands that modify your local installation, eg, <code>install</code>, <code>update</code>,
348<code>dedupe</code>, <code>uninstall</code>, as well as <code>pack</code> and <code>publish</code>.</p>
349<p>Note: This is NOT honored by other network related commands, eg <code>dist-tags</code>,
350<code>owner</code>, etc.</p>
351<h4 id="workspace"><code>workspace</code></h4>
352<ul>
353<li>Default:</li>
354<li>Type: String (can be set multiple times)</li>
355</ul>
356<p>Enable running a command in the context of the configured workspaces of the
357current project while filtering by running only the workspaces defined by
358this configuration option.</p>
359<p>Valid values for the <code>workspace</code> config are either:</p>
360<ul>
361<li>Workspace names</li>
362<li>Path to a workspace directory</li>
363<li>Path to a parent workspace directory (will result in selecting all
364workspaces within that folder)</li>
365</ul>
366<p>When set for the <code>npm init</code> command, this may be set to the folder of a
367workspace which does not yet exist, to create the folder and set it up as a
368brand new workspace within the project.</p>
369<p>This value is not exported to the environment for child processes.</p>
370<h4 id="workspaces"><code>workspaces</code></h4>
371<ul>
372<li>Default: null</li>
373<li>Type: null or Boolean</li>
374</ul>
375<p>Set to true to run the command in the context of <strong>all</strong> configured
376workspaces.</p>
377<p>Explicitly setting this to false will cause commands like <code>install</code> to
378ignore workspaces altogether. When not set explicitly:</p>
379<ul>
380<li>Commands that operate on the <code>node_modules</code> tree (install, update, etc.)
381will link workspaces into the <code>node_modules</code> folder. - Commands that do
382other things (test, exec, publish, etc.) will operate on the root project,
383<em>unless</em> one or more workspaces are specified in the <code>workspace</code> config.</li>
384</ul>
385<p>This value is not exported to the environment for child processes.</p>
386<h4 id="include-workspace-root"><code>include-workspace-root</code></h4>
387<ul>
388<li>Default: false</li>
389<li>Type: Boolean</li>
390</ul>
391<p>Include the workspace root when workspaces are enabled for a command.</p>
392<p>When false, specifying individual workspaces via the <code>workspace</code> config, or
393all workspaces via the <code>workspaces</code> flag, will cause npm to operate only on
394the specified workspaces, and not on the root project.</p>
395<p>This value is not exported to the environment for child processes.</p>
396<h4 id="install-links"><code>install-links</code></h4>
397<ul>
398<li>Default: false</li>
399<li>Type: Boolean</li>
400</ul>
401<p>When set file: protocol dependencies will be packed and installed as regular
402dependencies instead of creating a symlink. This option has no effect on
403workspaces.</p>
404<h3 id="see-also">See Also</h3>
405<ul>
406<li><a href="../commands/npm-install-test.html">npm install-test</a></li>
407<li><a href="../commands/npm-ci.html">npm ci</a></li>
408<li><a href="../commands/npm-test.html">npm test</a></li>
409</ul></div>
410
411<footer id="edit">
412<a href="https://github.com/npm/cli/edit/latest/docs/lib/content/commands/npm-install-ci-test.md">
413<svg role="img" viewBox="0 0 16 16" width="16" height="16" fill="currentcolor" style="vertical-align: text-bottom; margin-right: 0.3em;">
414<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>
415</svg>
416Edit this page on GitHub
417</a>
418</footer>
419</section>
420
421
422
423</body></html>