@cryptotaxi247 / documentation-1
Code Commits Issues Pulls Sessions CI/CD
patch-1
@reggi/path-to-regexp dependabot/npm_and_yarn/main/copy-to-clipboard-4.0.2 dependabot/npm_and_yarn/main/eslint-10.4.0 dependabot/npm_and_yarn/main/npmcli/eslint-config-7.0.0 dependabot/npm_and_yarn/main/proc-log-7.0.0 dependabot/npm_and_yarn/npm_and_yarn-826852524d dependabot/npm_and_yarn/npm_and_yarn-ab9a7f4bc2 deprecate-totp-2fa dhei/classic-tokens gat-bypass-2fa-docs jpg619/fix-accessibility-content-flow jpg619/version-bump-tar-2 kartykp/gat-bypass-2fa-docs kartykp/upgrade-path-to-regex main maitxn/version-bump-tar patch-1 reggi/cache-based-on-version reggi/dev-engines reggi/fix-transform-prettier reggi/overrides update-search-sensitivity
mdx 271 lines 10.2 KB
Raw
1 ---
2 title: npm-install-test
3 section: 1
4 description: Install package(s) and run tests
5 github_repo: npm/cli
6 github_branch: release/v10
7 github_path: docs/lib/content/commands/npm-install-test.md
8 redirect_from:
9 - /cli-documentation/v10/cli-commands/install-test
10 - /cli-documentation/v10/cli-commands/npm-install-test
11 - /cli-documentation/v10/commands/install-test
12 - /cli-documentation/v10/commands/npm-install-test
13 - /cli-documentation/v10/install-test
14 - /cli-documentation/v10/npm-install-test
15 - /cli/v10/cli-commands/install-test
16 - /cli/v10/cli-commands/npm-install-test
17 - /cli/v10/commands/install-test
18 - /cli/v10/install-test
19 - /cli/v10/npm-install-test
20 ---
21
22 ### Synopsis
23
24 ```bash
25 npm install-test [<package-spec> ...]
26
27 alias: it
28 ```
29
30 ### Description
31
32 This command runs an `npm install` followed immediately by an `npm test`. It takes exactly the same arguments as `npm install`.
33
34 ### Configuration
35
36 #### `save`
37
38 - Default: `true` unless when using `npm update` where it defaults to `false`
39 - Type: Boolean
40
41 Save installed packages to a `package.json` file as dependencies.
42
43 When used with the `npm rm` command, removes the dependency from `package.json`.
44
45 Will also prevent writing to `package-lock.json` if set to `false`.
46
47 #### `save-exact`
48
49 - Default: false
50 - Type: Boolean
51
52 Dependencies saved to package.json will be configured with an exact version rather than using npm's default semver range operator.
53
54 #### `global`
55
56 - Default: false
57 - Type: Boolean
58
59 Operates in "global" mode, so that packages are installed into the `prefix` folder instead of the current working directory. See [folders](/cli/v10/configuring-npm/folders) for more on the differences in behavior.
60
61 - packages are installed into the `{prefix}/lib/node_modules` folder, instead of the current working directory.
62 - bin files are linked to `{prefix}/bin`
63 - man pages are linked to `{prefix}/share/man`
64
65 #### `install-strategy`
66
67 - Default: "hoisted"
68 - Type: "hoisted", "nested", "shallow", or "linked"
69
70 Sets the strategy for installing packages in node_modules. hoisted (default): Install non-duplicated in top-level, and duplicated as necessary within directory structure. nested: (formerly --legacy-bundling) install in place, no hoisting. shallow (formerly --global-style) only install direct deps at top-level. linked: (experimental) install in node_modules/.store, link in place, unhoisted.
71
72 #### `legacy-bundling`
73
74 - Default: false
75 - Type: Boolean
76 - DEPRECATED: This option has been deprecated in favor of `--install-strategy=nested`
77
78 Instead of hoisting package installs in `node_modules`, install packages in the same manner that they are depended on. This may cause very deep directory structures and duplicate package installs as there is no de-duplicating. Sets `--install-strategy=nested`.
79
80 #### `global-style`
81
82 - Default: false
83 - Type: Boolean
84 - DEPRECATED: This option has been deprecated in favor of `--install-strategy=shallow`
85
86 Only install direct dependencies in the top level `node_modules`, but hoist on deeper dependencies. Sets `--install-strategy=shallow`.
87
88 #### `omit`
89
90 - Default: 'dev' if the `NODE_ENV` environment variable is set to 'production', otherwise empty.
91 - Type: "dev", "optional", or "peer" (can be set multiple times)
92
93 Dependency types to omit from the installation tree on disk.
94
95 Note that these dependencies _are_ still resolved and added to the `package-lock.json` or `npm-shrinkwrap.json` file. They are just not physically installed on disk.
96
97 If a package type appears in both the `--include` and `--omit` lists, then it will be included.
98
99 If the resulting omit list includes `'dev'`, then the `NODE_ENV` environment variable will be set to `'production'` for all lifecycle scripts.
100
101 #### `include`
102
103 - Default:
104 - Type: "prod", "dev", "optional", or "peer" (can be set multiple times)
105
106 Option that allows for defining which types of dependencies to install.
107
108 This is the inverse of `--omit=<type>`.
109
110 Dependency types specified in `--include` will not be omitted, regardless of the order in which omit/include are specified on the command-line.
111
112 #### `strict-peer-deps`
113
114 - Default: false
115 - Type: Boolean
116
117 If set to `true`, and `--legacy-peer-deps` is not set, then _any_ conflicting `peerDependencies` will be treated as an install failure, even if npm could reasonably guess the appropriate resolution based on non-peer dependency relationships.
118
119 By default, conflicting `peerDependencies` deep in the dependency graph will be resolved using the nearest non-peer dependency specification, even if doing so will result in some packages receiving a peer dependency outside the range set in their package's `peerDependencies` object.
120
121 When such an override is performed, a warning is printed, explaining the conflict and the packages involved. If `--strict-peer-deps` is set, then this warning is treated as a failure.
122
123 #### `prefer-dedupe`
124
125 - Default: false
126 - Type: Boolean
127
128 Prefer to deduplicate packages if possible, rather than choosing a newer version of a dependency.
129
130 #### `package-lock`
131
132 - Default: true
133 - Type: Boolean
134
135 If set to false, then ignore `package-lock.json` files when installing. This will also prevent _writing_ `package-lock.json` if `save` is true.
136
137 #### `package-lock-only`
138
139 - Default: false
140 - Type: Boolean
141
142 If set to true, the current operation will only use the `package-lock.json`, ignoring `node_modules`.
143
144 For `update` this means only the `package-lock.json` will be updated, instead of checking `node_modules` and downloading dependencies.
145
146 For `list` this means the output will be based on the tree described by the `package-lock.json`, rather than the contents of `node_modules`.
147
148 #### `foreground-scripts`
149
150 - Default: `false` unless when using `npm pack` or `npm publish` where it defaults to `true`
151 - Type: Boolean
152
153 Run all build scripts (ie, `preinstall`, `install`, and `postinstall`) scripts for installed packages in the foreground process, sharing standard input, output, and error with the main npm process.
154
155 Note that this will generally make installs run slower, and be much noisier, but can be useful for debugging.
156
157 #### `ignore-scripts`
158
159 - Default: false
160 - Type: Boolean
161
162 If true, npm does not run scripts specified in package.json files.
163
164 Note that commands explicitly intended to run a particular script, such as `npm start`, `npm stop`, `npm restart`, `npm test`, and `npm run-script` will still run their intended script if `ignore-scripts` is set, but they will _not_ run any pre- or post-scripts.
165
166 #### `audit`
167
168 - Default: true
169 - Type: Boolean
170
171 When "true" submit audit reports alongside the current npm command to the default registry and all registries configured for scopes. See the documentation for [`npm audit`](/cli/v10/commands/npm-audit) for details on what is submitted.
172
173 #### `bin-links`
174
175 - Default: true
176 - Type: Boolean
177
178 Tells npm to create symlinks (or `.cmd` shims on Windows) for package executables.
179
180 Set to false to have it not do this. This can be used to work around the fact that some file systems don't support symlinks, even on ostensibly Unix systems.
181
182 #### `fund`
183
184 - Default: true
185 - Type: Boolean
186
187 When "true" displays the message at the end of each `npm install` acknowledging the number of dependencies looking for funding. See [`npm fund`](/cli/v10/commands/npm-fund) for details.
188
189 #### `dry-run`
190
191 - Default: false
192 - Type: Boolean
193
194 Indicates that you don't want npm to make any changes and that it should only report what it would have done. This can be passed into any of the commands that modify your local installation, eg, `install`, `update`, `dedupe`, `uninstall`, as well as `pack` and `publish`.
195
196 Note: This is NOT honored by other network related commands, eg `dist-tags`, `owner`, etc.
197
198 #### `cpu`
199
200 - Default: null
201 - Type: null or String
202
203 Override CPU architecture of native modules to install. Acceptable values are same as `cpu` field of package.json, which comes from `process.arch`.
204
205 #### `os`
206
207 - Default: null
208 - Type: null or String
209
210 Override OS of native modules to install. Acceptable values are same as `os` field of package.json, which comes from `process.platform`.
211
212 #### `libc`
213
214 - Default: null
215 - Type: null or String
216
217 Override libc of native modules to install. Acceptable values are same as `libc` field of package.json
218
219 #### `workspace`
220
221 - Default:
222 - Type: String (can be set multiple times)
223
224 Enable running a command in the context of the configured workspaces of the current project while filtering by running only the workspaces defined by this configuration option.
225
226 Valid values for the `workspace` config are either:
227
228 - Workspace names
229 - Path to a workspace directory
230 - Path to a parent workspace directory (will result in selecting all workspaces within that folder)
231
232 When set for the `npm init` command, this may be set to the folder of a workspace which does not yet exist, to create the folder and set it up as a brand new workspace within the project.
233
234 This value is not exported to the environment for child processes.
235
236 #### `workspaces`
237
238 - Default: null
239 - Type: null or Boolean
240
241 Set to true to run the command in the context of **all** configured workspaces.
242
243 Explicitly setting this to false will cause commands like `install` to ignore workspaces altogether. When not set explicitly:
244
245 - Commands that operate on the `node_modules` tree (install, update, etc.) will link workspaces into the `node_modules` folder. - Commands that do other things (test, exec, publish, etc.) will operate on the root project, _unless_ one or more workspaces are specified in the `workspace` config.
246
247 This value is not exported to the environment for child processes.
248
249 #### `include-workspace-root`
250
251 - Default: false
252 - Type: Boolean
253
254 Include the workspace root when workspaces are enabled for a command.
255
256 When false, specifying individual workspaces via the `workspace` config, or all workspaces via the `workspaces` flag, will cause npm to operate only on the specified workspaces, and not on the root project.
257
258 This value is not exported to the environment for child processes.
259
260 #### `install-links`
261
262 - Default: false
263 - Type: Boolean
264
265 When set file: protocol dependencies will be packed and installed as regular dependencies instead of creating a symlink. This option has no effect on workspaces.
266
267 ### See Also
268
269 - [npm install](/cli/v10/commands/npm-install)
270 - [npm install-ci-test](/cli/v10/commands/npm-install-ci-test)
271 - [npm test](/cli/v10/commands/npm-test)