@cryptotaxi247 / documentation-1
Code Commits Issues Pulls Sessions CI/CD
reggi/fix-transform-prettier
@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 310 lines 12.6 KB
Raw
1 ---
2 title: scripts
3 section: 7
4 description: How npm handles the "scripts" field
5 github_repo: npm/cli
6 github_branch: release/v8
7 github_path: docs/lib/content/using-npm/scripts.md
8 redirect_from:
9 - /cli-documentation/v8/misc/scripts
10 - /cli-documentation/v8/using-npm/scripts
11 - /cli/v8/misc/scripts
12 ---
13
14 ### Description
15
16 The `"scripts"` property of your `package.json` file supports a number of built-in scripts and their preset life cycle events as well as arbitrary scripts. These all can be executed by running `npm run-script <stage>` or `npm run <stage>` for short. _Pre_ and _post_ commands with matching names will be run for those as well (e.g. `premyscript`, `myscript`, `postmyscript`). Scripts from dependencies can be run with `npm explore <pkg> -- npm run <stage>`.
17
18 ### Pre & Post Scripts
19
20 To create "pre" or "post" scripts for any scripts defined in the `"scripts"` section of the `package.json`, simply create another script _with a matching name_ and add "pre" or "post" to the beginning of them.
21
22 ```json
23 {
24 "scripts": {
25 "precompress": "{{ executes BEFORE the `compress` script }}",
26 "compress": "{{ run command to compress files }}",
27 "postcompress": "{{ executes AFTER `compress` script }}"
28 }
29 }
30 ```
31
32 In this example `npm run compress` would execute these scripts as described.
33
34 ### Life Cycle Scripts
35
36 There are some special life cycle scripts that happen only in certain situations. These scripts happen in addition to the `pre<event>`, `post<event>`, and `<event>` scripts.
37
38 - `prepare`, `prepublish`, `prepublishOnly`, `prepack`, `postpack`, `dependencies`
39
40 **prepare** (since `npm@4.0.0`)
41
42 - Runs any time before the package is packed, i.e. during `npm publish` and `npm pack`
43 - Runs BEFORE the package is packed
44 - Runs BEFORE the package is published
45 - Runs on local `npm install` without any arguments
46 - Run AFTER `prepublish`, but BEFORE `prepublishOnly`
47
48 - NOTE: If a package being installed through git contains a `prepare` script, its `dependencies` and `devDependencies` will be installed, and the prepare script will be run, before the package is packaged and installed.
49
50 - As of `npm@7` these scripts run in the background. To see the output, run with: `--foreground-scripts`.
51
52 **prepublish** (DEPRECATED)
53
54 - Does not run during `npm publish`, but does run during `npm ci` and `npm install`. See below for more info.
55
56 **prepublishOnly**
57
58 - Runs BEFORE the package is prepared and packed, ONLY on `npm publish`.
59
60 **prepack**
61
62 - Runs BEFORE a tarball is packed (on "`npm pack`", "`npm publish`", and when installing a git dependencies).
63 - NOTE: "`npm run pack`" is NOT the same as "`npm pack`". "`npm run pack`" is an arbitrary user defined script name, where as, "`npm pack`" is a CLI defined command.
64
65 **postpack**
66
67 - Runs AFTER the tarball has been generated but before it is moved to its final destination (if at all, publish does not save the tarball locally)
68
69 **dependencies**
70
71 - Runs AFTER any operations that modify the `node_modules` directory IF changes occurred.
72 - Does NOT run in global mode
73
74 #### Prepare and Prepublish
75
76 **Deprecation Note: prepublish**
77
78 Since `npm@1.1.71`, the npm CLI has run the `prepublish` script for both `npm publish` and `npm install`, because it's a convenient way to prepare a package for use (some common use cases are described in the section below). It has also turned out to be, in practice, [very confusing](https://github.com/npm/npm/issues/10074). As of `npm@4.0.0`, a new event has been introduced, `prepare`, that preserves this existing behavior. A _new_ event, `prepublishOnly` has been added as a transitional strategy to allow users to avoid the confusing behavior of existing npm versions and only run on `npm publish` (for instance, running the tests one last time to ensure they're in good shape).
79
80 See [https://github.com/npm/npm/issues/10074](https://github.com/npm/npm/issues/10074) for a much lengthier justification, with further reading, for this change.
81
82 **Use Cases**
83
84 If you need to perform operations on your package before it is used, in a way that is not dependent on the operating system or architecture of the target system, use a `prepublish` script. This includes tasks such as:
85
86 - Compiling CoffeeScript source code into JavaScript.
87 - Creating minified versions of JavaScript source code.
88 - Fetching remote resources that your package will use.
89
90 The advantage of doing these things at `prepublish` time is that they can be done once, in a single place, thus reducing complexity and variability. Additionally, this means that:
91
92 - You can depend on `coffee-script` as a `devDependency`, and thus your users don't need to have it installed.
93 - You don't need to include minifiers in your package, reducing the size for your users.
94 - You don't need to rely on your users having `curl` or `wget` or other system tools on the target machines.
95
96 #### Dependencies
97
98 The `dependencies` script is run any time an `npm` command causes changes to the `node_modules` directory. It is run AFTER the changes have been applied and the `package.json` and `package-lock.json` files have been updated.
99
100 ### Life Cycle Operation Order
101
102 #### [`npm cache add`](/cli/v8/commands/npm-cache)
103
104 - `prepare`
105
106 #### [`npm ci`](/cli/v8/commands/npm-ci)
107
108 - `preinstall`
109 - `install`
110 - `postinstall`
111 - `prepublish`
112 - `preprepare`
113 - `prepare`
114 - `postprepare`
115
116 These all run after the actual installation of modules into `node_modules`, in order, with no internal actions happening in between
117
118 #### [`npm diff`](/cli/v8/commands/npm-diff)
119
120 - `prepare`
121
122 #### [`npm install`](/cli/v8/commands/npm-install)
123
124 These also run when you run `npm install -g <pkg-name>`
125
126 - `preinstall`
127 - `install`
128 - `postinstall`
129 - `prepublish`
130 - `preprepare`
131 - `prepare`
132 - `postprepare`
133
134 If there is a `binding.gyp` file in the root of your package and you haven't defined your own `install` or `preinstall` scripts, npm will default the `install` command to compile using node-gyp via `node-gyp rebuild`
135
136 These are run from the scripts of `<pkg-name>`
137
138 #### [`npm pack`](/cli/v8/commands/npm-pack)
139
140 - `prepack`
141 - `prepare`
142 - `postpack`
143
144 #### [`npm publish`](/cli/v8/commands/npm-publish)
145
146 - `prepublishOnly`
147 - `prepack`
148 - `prepare`
149 - `postpack`
150 - `publish`
151 - `postpublish`
152
153 `prepare` will not run during `--dry-run`
154
155 #### [`npm rebuild`](/cli/v8/commands/npm-rebuild)
156
157 - `preinstall`
158 - `install`
159 - `postinstall`
160 - `prepare`
161
162 `prepare` is only run if the current directory is a symlink (e.g. with linked packages)
163
164 #### [`npm restart`](/cli/v8/commands/npm-restart)
165
166 If there is a `restart` script defined, these events are run, otherwise `stop` and `start` are both run if present, including their `pre` and `post` iterations)
167
168 - `prerestart`
169 - `restart`
170 - `postrestart`
171
172 #### [`npm run <user defined>`](/cli/v8/commands/npm-run-script)
173
174 - `pre<user-defined>`
175 - `<user-defined>`
176 - `post<user-defined>`
177
178 #### [`npm start`](/cli/v8/commands/npm-start)
179
180 - `prestart`
181 - `start`
182 - `poststart`
183
184 If there is a `server.js` file in the root of your package, then npm will default the `start` command to `node server.js`. `prestart` and `poststart` will still run in this case.
185
186 #### [`npm stop`](/cli/v8/commands/npm-stop)
187
188 - `prestop`
189 - `stop`
190 - `poststop`
191
192 #### [`npm test`](/cli/v8/commands/npm-test)
193
194 - `pretest`
195 - `test`
196 - `posttest`
197
198 #### [`npm version`](/cli/v8/commands/npm-version)
199
200 - `preversion`
201 - `version`
202 - `postversion`
203
204 #### A Note on a lack of [`npm uninstall`](/cli/v8/commands/npm-uninstall) scripts
205
206 While npm v6 had `uninstall` lifecycle scripts, npm v7 does not. Removal of a package can happen for a wide variety of reasons, and there's no clear way to currently give the script enough context to be useful.
207
208 Reasons for a package removal include:
209
210 - a user directly uninstalled this package
211 - a user uninstalled a dependant package and so this dependency is being uninstalled
212 - a user uninstalled a dependant package but another package also depends on this version
213 - this version has been merged as a duplicate with another version
214 - etc.
215
216 Due to the lack of necessary context, `uninstall` lifecycle scripts are not implemented and will not function.
217
218 ### User
219
220 When npm is run as root, scripts are always run with the effective uid and gid of the working directory owner.
221
222 ### Environment
223
224 Package scripts run in an environment where many pieces of information are made available regarding the setup of npm and the current state of the process.
225
226 #### path
227
228 If you depend on modules that define executable scripts, like test suites, then those executables will be added to the `PATH` for executing the scripts. So, if your package.json has this:
229
230 ```json
231 {
232 "name": "foo",
233 "dependencies": {
234 "bar": "0.1.x"
235 },
236 "scripts": {
237 "start": "bar ./test"
238 }
239 }
240 ```
241
242 then you could run `npm start` to execute the `bar` script, which is exported into the `node_modules/.bin` directory on `npm install`.
243
244 #### package.json vars
245
246 The package.json fields are tacked onto the `npm_package_` prefix. So, for instance, if you had `{"name":"foo", "version":"1.2.5"}` in your package.json file, then your package scripts would have the `npm_package_name` environment variable set to "foo", and the `npm_package_version` set to "1.2.5". You can access these variables in your code with `process.env.npm_package_name` and `process.env.npm_package_version`, and so on for other fields.
247
248 See [`package.json`](/cli/v8/configuring-npm/package-json) for more on package configs.
249
250 #### current lifecycle event
251
252 Lastly, the `npm_lifecycle_event` environment variable is set to whichever stage of the cycle is being executed. So, you could have a single script used for different parts of the process which switches based on what's currently happening.
253
254 Objects are flattened following this format, so if you had `{"scripts":{"install":"foo.js"}}` in your package.json, then you'd see this in the script:
255
256 ```bash
257 process.env.npm_package_scripts_install === "foo.js"
258 ```
259
260 ### Examples
261
262 For example, if your package.json contains this:
263
264 ```json
265 {
266 "scripts": {
267 "install": "scripts/install.js",
268 "postinstall": "scripts/install.js",
269 "uninstall": "scripts/uninstall.js"
270 }
271 }
272 ```
273
274 then `scripts/install.js` will be called for the install and post-install stages of the lifecycle, and `scripts/uninstall.js` will be called when the package is uninstalled. Since `scripts/install.js` is running for two different phases, it would be wise in this case to look at the `npm_lifecycle_event` environment variable.
275
276 If you want to run a make command, you can do so. This works just fine:
277
278 ```json
279 {
280 "scripts": {
281 "preinstall": "./configure",
282 "install": "make && make install",
283 "test": "make test"
284 }
285 }
286 ```
287
288 ### Exiting
289
290 Scripts are run by passing the line as a script argument to `sh`.
291
292 If the script exits with a code other than 0, then this will abort the process.
293
294 Note that these script files don't have to be Node.js or even JavaScript programs. They just have to be some kind of executable file.
295
296 ### Best Practices
297
298 - Don't exit with a non-zero error code unless you _really_ mean it. Except for uninstall scripts, this will cause the npm action to fail, and potentially be rolled back. If the failure is minor or only will prevent some optional features, then it's better to just print a warning and exit successfully.
299 - Try not to use scripts to do what npm can do for you. Read through [`package.json`](/cli/v8/configuring-npm/package-json) to see all the things that you can specify and enable by simply describing your package appropriately. In general, this will lead to a more robust and consistent state.
300 - Inspect the env to determine where to put things. For instance, if the `npm_config_binroot` environment variable is set to `/home/user/bin`, then don't try to install executables into `/usr/local/bin`. The user probably set it up that way for a reason.
301 - Don't prefix your script commands with "sudo". If root permissions are required for some reason, then it'll fail with that error, and the user will sudo the npm command in question.
302 - Don't use `install`. Use a `.gyp` file for compilation, and `prepare` for anything else. You should almost never have to explicitly set a preinstall or install script. If you are doing this, please consider if there is another option. The only valid use of `install` or `preinstall` scripts is for compilation which must be done on the target architecture.
303 - Scripts are run from the root of the package folder, regardless of what the current working directory is when `npm` is invoked. If you want your script to use different behavior based on what subdirectory you're in, you can use the `INIT_CWD` environment variable, which holds the full path you were in when you ran `npm run`.
304
305 ### See Also
306
307 - [npm run-script](/cli/v8/commands/npm-run-script)
308 - [package.json](/cli/v8/configuring-npm/package-json)
309 - [npm developers](/cli/v8/using-npm/developers)
310 - [npm install](/cli/v8/commands/npm-install)