scripts(7) scripts(7)
NAME
scripts - How npm handles the "scripts" field
Description
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>.
Pre & Post Scripts
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.
{
"scripts": {
"precompress": "{{ executes BEFORE the `compress` script }}",
"compress": "{{ run command to compress files }}",
"postcompress": "{{ executes AFTER `compress` script }}"
}
}
In this example npm run compress would execute these scripts as
described.
Life Cycle Scripts
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.
o prepare, prepublish, prepublishOnly, prepack, postpack,
dependencies
prepare (since npm@4.0.0)
o Runs BEFORE the package is packed, i.e. during npm publish and npm
pack
o Runs on local npm install without any arguments
o Runs AFTER prepublish, but BEFORE prepublishOnly
o 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.
o As of npm@7 these scripts run in the background. To see the output,
run with: --foreground-scripts.
prepublish (DEPRECATED)
o Does not run during npm publish, but does run during npm ci and npm
install. See below for more info.
prepublishOnly
o Runs BEFORE the package is prepared and packed, ONLY on npm
publish.
prepack
o Runs BEFORE a tarball is packed (on "npm pack", "npm publish", and
when installing a git dependency).
o 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.
postpack
o 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)
dependencies
o Runs AFTER any operations that modify the node_modules directory IF
changes occurred.
o Does NOT run in global mode
Prepare and Prepublish
Deprecation Note: prepublish
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).
See <https://github.com/npm/npm/issues/10074> for a much lengthier
justification, with further reading, for this change.
Use Cases
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:
o Compiling CoffeeScript source code into JavaScript.
o Creating minified versions of JavaScript source code.
o Fetching remote resources that your package will use.
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:
o You can depend on coffee-script as a devDependency, and thus your
users don't need to have it installed.
o You don't need to include minifiers in your package, reducing the
size for your users.
o You don't need to rely on your users having curl or wget or other
system tools on the target machines.
Dependencies
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.
Life Cycle Operation Order
npm help
o prepare
npm help ci
o preinstall
o install
o postinstall
o prepublish
o preprepare
o prepare
o postprepare
These all run after the actual installation of modules into
node_modules, in order, with no internal actions happening in between
npm help diff
o prepare
npm help install
These also run when you run npm install -g <pkg-name>
o preinstall
o install
o postinstall
o prepublish
o preprepare
o prepare
o postprepare
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
These are run from the scripts of <pkg-name>
npm help pack
o prepack
o prepare
o postpack
npm help publish
o prepublishOnly
o prepack
o prepare
o postpack
o publish
o postpublish
npm help rebuild
o preinstall
o install
o postinstall
o prepare
prepare is only run if the current directory is a symlink (e.g. with
linked packages)
npm help restart
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)
o prerestart
o restart
o postrestart
npm run <user defined> </commands/npm-run-script>
o pre<user-defined>
o <user-defined>
o post<user-defined>
npm help start
o prestart
o start
o poststart
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.
npm help stop
o prestop
o stop
o poststop
npm help test
o pretest
o test
o posttest
npm help version
o preversion
o version
o postversion
A Note on a lack of npm help uninstall scripts
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.
Reasons for a package removal include:
o a user directly uninstalled this package
o a user uninstalled a dependant package and so this dependency is
being uninstalled
o a user uninstalled a dependant package but another package also
depends on this version
o this version has been merged as a duplicate with another version
o etc.
Due to the lack of necessary context, uninstall lifecycle scripts are
not implemented and will not function.
User
When npm is run as root, scripts are always run with the effective uid
and gid of the working directory owner.
Environment
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.
path
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:
{
"name" : "foo",
"dependencies" : {
"bar" : "0.1.x"
},
"scripts": {
"start" : "bar ./test"
}
}
then you could run npm start to execute the bar script, which is
exported into the node_modules/.bin directory on npm install.
package.json vars
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.
See package.json </configuring-npm/package-json> for more on package
configs.
current lifecycle event
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.
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:
process.env.npm_package_scripts_install === "foo.js"
Examples
For example, if your package.json contains this:
{
"scripts" : {
"install" : "scripts/install.js",
"postinstall" : "scripts/install.js"
}
}
then scripts/install.js will be called for the install and post-install
stages of the lifecycle. 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.
If you want to run a make command, you can do so. This works just fine:
{
"scripts" : {
"preinstall" : "./configure",
"install" : "make && make install",
"test" : "make test"
}
}
Exiting
Scripts are run by passing the line as a script argument to sh.
If the script exits with a code other than 0, then this will abort the
process.
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.
Best Practices
o Don't exit with a non-zero error code unless you really mean it. If
the failure is minor or only will prevent some optional features,
then it's better to just print a warning and exit successfully.
o Try not to use scripts to do what npm can do for you. Read through
package.json </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.
o 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.
o 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.
o 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.
o 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.
See Also
o npm help run-script
o package.json </configuring-npm/package-json>
o npm help developers
o npm help install
February 2024 scripts(7)
npm 10.5.0 - Generated Thu Feb 29 07:27:24 CST 2024