1NPM-INSTALL-TEST(1) NPM-INSTALL-TEST(1)
2
6 npm-install-test - Install package(s) and run tests
7 Synopsis
9 npm install-test (with no args, in package dir)
10 npm install-test [<@scope>/]<name>
11 npm install-test [<@scope>/]<name>@<tag>
12 npm install-test [<@scope>/]<name>@<version>
13 npm install-test [<@scope>/]<name>@<version range>
14 npm install-test <tarball file>
15 npm install-test <tarball url>
16 npm install-test <folder>
17 alias: npm it
19 common options: [--save|--save-dev|--save-optional] [--save-exact] [--dry-run]
20 Description
22 This command runs an npm install followed immediately by an npm test.
23 It takes exactly the same arguments as npm install.
24 Configuration
26 <!-- AUTOGENERATED CONFIG DESCRIPTIONS START --> <!-- automatically
27 generated, do not edit manually --> <!-- see lib/utils/config/defini‐
28 tions.js -->
29 save
31 • Default: true
32 • Type: Boolean
34 Save installed packages to a package.json file as dependencies.
37 When used with the npm rm command, removes the dependency from pack‐
39 age.json. <!-- automatically generated, do not edit manually --> <!--
40 see lib/utils/config/definitions.js -->
41 save-exact
44 • Default: false
45 • Type: Boolean
47 Dependencies saved to package.json will be configured with an exact
50 version rather than using npm's default semver range operator. <!--
51 automatically generated, do not edit manually --> <!-- see
52 lib/utils/config/definitions.js -->
53 global
56 • Default: false
57 • Type: Boolean
59 Operates in "global" mode, so that packages are installed into the pre‐
62 fix folder instead of the current working directory. See npm help fold‐
63 ers for more on the differences in behavior.
64 • packages are installed into the {prefix}/lib/node_modules folder, in‐
66 stead of the current working directory.
67 • bin files are linked to {prefix}/bin
69 • man pages are linked to {prefix}/share/man
71 <!-- automatically generated, do not edit manually --> <!-- see
73 lib/utils/config/definitions.js -->
74 global-style
77 • Default: false
78 • Type: Boolean
80 Causes npm to install the package into your local node_modules folder
83 with the same layout it uses with the global node_modules folder. Only
84 your direct dependencies will show in node_modules and everything they
85 depend on will be flattened in their node_modules folders. This obvi‐
86 ously will eliminate some deduping. If used with legacy-bundling,
87 legacy-bundling will be preferred. <!-- automatically generated, do
88 not edit manually --> <!-- see lib/utils/config/definitions.js -->
89 legacy-bundling
92 • Default: false
93 • Type: Boolean
95 Causes npm to install the package such that versions of npm prior to
98 1.4, such as the one included with node 0.8, can install the package.
99 This eliminates all automatic deduping. If used with global-style this
100 option will be preferred. <!-- automatically generated, do not edit
101 manually --> <!-- see lib/utils/config/definitions.js -->
102 strict-peer-deps
105 • Default: false
106 • Type: Boolean
108 If set to true, and --legacy-peer-deps is not set, then any conflicting
111 peerDependencies will be treated as an install failure, even if npm
112 could reasonably guess the appropriate resolution based on non-peer de‐
113 pendency relationships.
114 By default, conflicting peerDependencies deep in the dependency graph
116 will be resolved using the nearest non-peer dependency specification,
117 even if doing so will result in some packages receiving a peer depen‐
118 dency outside the range set in their package's peerDependencies object.
119 When such and override is performed, a warning is printed, explaining
121 the conflict and the packages involved. If --strict-peer-deps is set,
122 then this warning is treated as a failure. <!-- automatically gener‐
123 ated, do not edit manually --> <!-- see lib/utils/config/definitions.js
124 -->
125 package-lock
128 • Default: true
129 • Type: Boolean
131 If set to false, then ignore package-lock.json files when installing.
134 This will also prevent writing package-lock.json if save is true.
135 When package package-locks are disabled, automatic pruning of extrane‐
137 ous modules will also be disabled. To remove extraneous modules with
138 package-locks disabled use npm prune. <!-- automatically generated, do
139 not edit manually --> <!-- see lib/utils/config/definitions.js -->
140 omit
143 • Default: 'dev' if the NODE_ENV environment variable is set to 'pro‐
144 duction', otherwise empty.
145 • Type: "dev", "optional", or "peer" (can be set multiple times)
147 Dependency types to omit from the installation tree on disk.
150 Note that these dependencies are still resolved and added to the pack‐
152 age-lock.json or npm-shrinkwrap.json file. They are just not physically
153 installed on disk.
154 If a package type appears in both the --include and --omit lists, then
156 it will be included.
157 If the resulting omit list includes 'dev', then the NODE_ENV environ‐
159 ment variable will be set to 'production' for all lifecycle scripts.
160 <!-- automatically generated, do not edit manually --> <!-- see
161 lib/utils/config/definitions.js -->
162 ignore-scripts
165 • Default: false
166 • Type: Boolean
168 If true, npm does not run scripts specified in package.json files.
171 Note that commands explicitly intended to run a particular script, such
173 as npm start, npm stop, npm restart, npm test, and npm run-script will
174 still run their intended script if ignore-scripts is set, but they will
175 not run any pre- or post-scripts. <!-- automatically generated, do not
176 edit manually --> <!-- see lib/utils/config/definitions.js -->
177 audit
180 • Default: true
181 • Type: Boolean
183 When "true" submit audit reports alongside the current npm command to
186 the default registry and all registries configured for scopes. See the
187 documentation for npm help audit for details on what is submitted.
188 <!-- automatically generated, do not edit manually --> <!-- see
189 lib/utils/config/definitions.js -->
190 bin-links
193 • Default: true
194 • Type: Boolean
196 Tells npm to create symlinks (or .cmd shims on Windows) for package ex‐
199 ecutables.
200 Set to false to have it not do this. This can be used to work around
202 the fact that some file systems don't support symlinks, even on osten‐
203 sibly Unix systems. <!-- automatically generated, do not edit manually
204 --> <!-- see lib/utils/config/definitions.js -->
205 fund
208 • Default: true
209 • Type: Boolean
211 When "true" displays the message at the end of each npm install ac‐
214 knowledging the number of dependencies looking for funding. See npm
215 help npm fund for details. <!-- automatically generated, do not edit
216 manually --> <!-- see lib/utils/config/definitions.js -->
217 dry-run
220 • Default: false
221 • Type: Boolean
223 Indicates that you don't want npm to make any changes and that it
226 should only report what it would have done. This can be passed into any
227 of the commands that modify your local installation, eg, install, up‐
228 date, dedupe, uninstall, as well as pack and publish.
229 Note: This is NOT honored by other network related commands, eg
231 dist-tags, owner, etc. <!-- automatically generated, do not edit manu‐
232 ally --> <!-- see lib/utils/config/definitions.js -->
233 workspace
236 • Default:
237 • Type: String (can be set multiple times)
239 Enable running a command in the context of the configured workspaces of
242 the current project while filtering by running only the workspaces de‐
243 fined by this configuration option.
244 Valid values for the workspace config are either:
246 • Workspace names
248 • Path to a workspace directory
250 • Path to a parent workspace directory (will result in selecting all
252 workspaces within that folder)
253 When set for the npm init command, this may be set to the folder of a
256 workspace which does not yet exist, to create the folder and set it up
257 as a brand new workspace within the project.
258 This value is not exported to the environment for child processes.
260 <!-- automatically generated, do not edit manually --> <!-- see
261 lib/utils/config/definitions.js -->
262 workspaces
265 • Default: null
266 • Type: null or Boolean
268 Set to true to run the command in the context of all configured
271 workspaces.
272 Explicitly setting this to false will cause commands like install to
274 ignore workspaces altogether. When not set explicitly:
275 • Commands that operate on the node_modules tree (install, update,
277 etc.) will link workspaces into the node_modules folder. - Commands
278 that do other things (test, exec, publish, etc.) will operate on the
279 root project, unless one or more workspaces are specified in the
280 workspace config.
281 This value is not exported to the environment for child processes.
284 <!-- automatically generated, do not edit manually --> <!-- see
285 lib/utils/config/definitions.js -->
286 include-workspace-root
289 • Default: false
290 • Type: Boolean
292 Include the workspace root when workspaces are enabled for a command.
295 When false, specifying individual workspaces via the workspace config,
297 or all workspaces via the workspaces flag, will cause npm to operate
298 only on the specified workspaces, and not on the root project. <!--
299 automatically generated, do not edit manually --> <!-- see
300 lib/utils/config/definitions.js -->
301 <!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
303 See Also
306 • npm help install
307 • npm help install-ci-test
309 • npm help test
311 January 2022 NPM-INSTALL-TEST(1)