-
Notifications
You must be signed in to change notification settings - Fork 3.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: document
dependencies
script (#5095)
- Loading branch information
Showing
1 changed file
with
9 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -39,7 +39,7 @@ 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. | ||
|
||
* `prepare`, `prepublish`, `prepublishOnly`, `prepack`, `postpack` | ||
* `prepare`, `prepublish`, `prepublishOnly`, `prepack`, `postpack`, `dependencies` | ||
|
||
**prepare** (since `[email protected]`) | ||
* Runs any time before the package is packed, i.e. during `npm publish` | ||
|
@@ -71,6 +71,10 @@ situations. These scripts happen in addition to the `pre<event>`, `post<event>`, | |
**postpack** | ||
* 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** | ||
* Runs AFTER any operations that modify the `node_modules` directory IF changes occurred. | ||
* Does NOT run in global mode | ||
|
||
#### Prepare and Prepublish | ||
|
||
**Deprecation Note: prepublish** | ||
|
@@ -96,6 +100,10 @@ The advantage of doing these things at `prepublish` time is that they can be don | |
* 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 cache add`](/commands/npm-cache) | ||
|