-
Notifications
You must be signed in to change notification settings - Fork 30k
Commit
PR-URL: #31977 Reviewed-By: Ruben Bridgewater <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Shelley Vohr <[email protected]> Reviewed-By: Beth Griggs <[email protected]> Reviewed-By: Michael Dawson <[email protected]>
- Loading branch information
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -682,3 +682,9 @@ Zhenya Vinogradov <[email protected]> | |
Rafael Hengles <[email protected]> | ||
Jan-Philip Gehrcke <[email protected]> | ||
Caleb Sacks <[email protected]> | ||
Kyle Getz <[email protected]> | ||
Sean Healy <[email protected]> | ||
Netanel Gilad <[email protected]> | ||
Dave Nicolson <[email protected]> | ||
Ajay Narain Mathur <[email protected]> | ||
Vitaliy Markitanov <[email protected]> |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,41 @@ | ||
## 6.14.1 (2020-02-26) | ||
|
||
* [`303e5c11e`](https://github.com/npm/cli/commit/303e5c11e7db34cf014107aecd2e81c821bfde8d) | ||
`[email protected]` | ||
Fixes a regression where scp-style git urls are passed to the WhatWG URL | ||
parser, which does not handle them properly. | ||
([@isaacs](https://github.com/isaacs)) | ||
|
||
## 6.14.0 (2020-02-25) | ||
|
||
### FEATURES | ||
* [`30f170877`](https://github.com/npm/cli/commit/30f170877954acd036cb234a581e4eb155049b82) [#731](https://github.com/npm/cli/pull/731) add support for multiple funding sources ([@ljharb](https://github.com/ljharb) & [@ruyadorno](hhttps://github.com/ruyadorno/)) | ||
|
||
### BUG FIXES | ||
* [`55916b130`](https://github.com/npm/cli/commit/55916b130ef52984584678f2cc17c15c1f031cb5) [#508](https://github.com/npm/cli/pull/508) fix: check `npm.config` before accessing its members ([@kaiyoma](https://github.com/kaiyoma)) | ||
* [`7d0cd65b2`](https://github.com/npm/cli/commit/7d0cd65b23c0986b631b9b54d87bbe74902cc023) [#733](https://github.com/npm/cli/pull/733) fix: access grant with unscoped packages ([@netanelgilad](https://github.com/netanelgilad)) | ||
* [`28c3d40d6`](https://github.com/npm/cli/commit/28c3d40d65eef63f9d6ccb60b99ac57f5057a46e), [`0769c5b20`](https://github.com/npm/cli/commit/30f170877954acd036cb234a581e4eb155049b82) [#945](https://github.com/npm/cli/pull/945), [#697](https://github.com/npm/cli/pull/697) fix: allow new major versions of node to be automatically considered "supported" ([@isaacs](https://github.com/isaacs), [@ljharb](https://github.com/ljharb)) | ||
|
||
### DEPENDENCIES | ||
* [`6f39e93`](https://github.com/npm/hosted-git-info/commit/6f39e93bae9162663af6f15a9d10bce675dd5de3) `[email protected]` ([@darcyclarke](https://github.com/darcyclarke)) | ||
* fix: passwords & usernames are escaped properly in git deps ([@stevenhilder](https://github.com/stevenhilder)) | ||
* [`f14b594ee`](https://github.com/npm/cli/commit/f14b594ee9dbfc98ed0b65c65d904782db4f31ad) `[email protected]` ([@isaacs](https://github.com/isaacs)) | ||
* [`77044150b`](https://github.com/npm/cli/commit/77044150b763d67d997f9ff108219132ea922678) `[email protected]` ([@isaacs](https://github.com/isaacs)) | ||
* [`1d112461a`](https://github.com/npm/cli/commit/1d112461ad8dc99e5ff7fabb5177e8c2f89a9755) `[email protected]` ([@isaacs](https://github.com/isaacs)) | ||
* [`ba8b4fe`](https://github.com/npm/npm-registry-fetch/commit/ba8b4fe60eb6cdf9b39012560aec596eda8ce924) fix: always bypass cache when ?write=true | ||
* [`a47fed760`](https://github.com/npm/cli/commit/a47fed7603a6ed31dcc314c0c573805f05a96830) `[email protected]` | ||
* [`3bbf2d6`](https://github.com/nodejs/readable-stream/commit/3bbf2d6feb45b03f4e46a2ae8251601ad2262121) fix: babel's "loose mode" class transform enbrittles BufferList ([@ljharb](https://github.com/ljharb)) | ||
|
||
### DOCUMENTATION | ||
* [`284c1c055`](https://github.com/npm/cli/commit/284c1c055a28c4b334496101799acefe3c54ceb3), [`fbb5f0e50`](https://github.com/npm/cli/commit/fbb5f0e50e54425119fa3f03c5de93e4cb6bfda7) [#729](https://github.com/npm/cli/pull/729) update lifecycle hooks docs | ||
([@seanhealy](https://github.com/seanhealy), [@mikemimik](https://github.com/mikemimik)) | ||
* [`1c272832d`](https://github.com/npm/cli/commit/1c272832d048300e409882313305c416dc6f21a2) [#787](https://github.com/npm/cli/pull/787) fix: trademarks typo ([@dnicolson](https://github.com/dnicolson)) | ||
* [`f6ff41776`](https://github.com/npm/cli/commit/f6ff417767d52418cc8c9e7b9731ede2c3916d2e) [#936](https://github.com/npm/cli/pull/936) fix: postinstall example ([@ajaymathur](https://github.com/ajaymathur)) | ||
* [`373224b16`](https://github.com/npm/cli/commit/373224b16e019b7b63d8f0b4c5d4adb7e5cb80dd) [#939](https://github.com/npm/cli/pull/939) fix: bad links in publish docs ([@vit100](https://github.com/vit100)) | ||
|
||
### MISCELLANEOUS | ||
* [`85c79636d`](https://github.com/npm/cli/commit/85c79636df31bac586c0e380c4852ee155a7723c) [#736](https://github.com/npm/cli/pull/736) add script to update dist-tags ([@mikemimik](https://github.com/mikemimik)) | ||
|
||
## 6.13.7 (2020-01-28) | ||
|
||
### BUG FIXES | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -105,7 +105,7 @@ If you see bad behavior like this, please report it to <[email protected]> right | |
away. **You are never expected to resolve abusive behavior on your own. We are | ||
here to help.** | ||
|
||
### Trademarkss | ||
### Trademarks | ||
|
||
If you think another npm publisher is infringing your trademark, such as by | ||
using a confusingly similar package name, email <[email protected]> with a link to | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -10,90 +10,64 @@ description: How npm handles the "scripts" field | |
|
||
### Description | ||
|
||
npm supports the "scripts" property of the package.json file, for the | ||
following scripts: | ||
|
||
* **prepublish** (_as of npm@5, `prepublish` is deprecated. Use `prepare` for build steps and `prepublishOnly` for upload-only._): | ||
Run BEFORE the package is packed and published, as well as on local `npm | ||
install` without any arguments. (See below) | ||
* **prepare**: | ||
Run both BEFORE the package is packed and published, on local `npm | ||
install` without any arguments, and when installing git dependencies (See | ||
below). This is run AFTER `prepublish`, but BEFORE `prepublishOnly`. | ||
* **prepublishOnly**: | ||
Run BEFORE the package is prepared and packed, ONLY on `npm publish`. (See | ||
below.) | ||
* **prepack**: | ||
run BEFORE a tarball is packed (on `npm pack`, `npm publish`, and when | ||
installing git dependencies) | ||
* **postpack**: | ||
Run AFTER the tarball has been generated and moved to its final destination. | ||
* **publish**, **postpublish**: | ||
Run AFTER the package is published. | ||
* **preinstall**: | ||
Run BEFORE the package is installed | ||
* **install**, **postinstall**: | ||
Run AFTER the package is installed. | ||
* **preuninstall**, **uninstall**: | ||
Run BEFORE the package is uninstalled. | ||
* **postuninstall**: | ||
Run AFTER the package is uninstalled. | ||
* **preversion**: | ||
Run BEFORE bumping the package version. | ||
* **version**: | ||
Run AFTER bumping the package version, but BEFORE commit. | ||
* **postversion**: | ||
Run AFTER bumping the package version, and AFTER commit. | ||
* **pretest**, **test**, **posttest**: | ||
Run by the `npm test` command. | ||
* **prestop**, **stop**, **poststop**: | ||
Run by the `npm stop` command. | ||
* **prestart**, **start**, **poststart**: | ||
Run by the `npm start` command. | ||
* **prerestart**, **restart**, **postrestart**: | ||
Run by the `npm restart` command. Note: `npm restart` will run the | ||
stop and start scripts if no `restart` script is provided. | ||
* **preshrinkwrap**, **shrinkwrap**, **postshrinkwrap**: | ||
Run by the `npm shrinkwrap` command. | ||
|
||
Additionally, arbitrary scripts can be executed by running `npm | ||
run-script <stage>`. *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>`. | ||
|
||
#### Prepublish and Prepare | ||
|
||
#### Deprecation Note | ||
|
||
Since `[email protected]`, 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 `[email protected]`, 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: | ||
The `"scripts"` property of 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. | ||
|
||
```json | ||
{ | ||
"scripts": { | ||
"precompress": "{{ executes BEFORE the `compress` script }}", | ||
"compress": "{{ run command to compress files }}", | ||
"postcompress": "{{ executes AFTER `compress` script }}" | ||
} | ||
} | ||
``` | ||
|
||
### Life Cycle Scripts | ||
|
||
There are some special life cycle scripts that happen only in certain situations. These scripts happen in addtion to the "pre" and "post" script. | ||
* `prepare`, `prepublish`, `prepublishOnly`, `prepack`, `postpack` | ||
|
||
**prepare** (since `[email protected]`) | ||
* Runs BEFORE the package is packed | ||
* Runs BEFORE the package is published | ||
* Runs on local `npm install` without any arguments | ||
* Run AFTER `prepublish`, but BEFORE `prepublishOnly` | ||
* 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. | ||
|
||
**prepublish** (DEPRECATED) | ||
* Same as `prepare` | ||
|
||
**prepublishOnly** | ||
* Runs BEFORE the package is prepared and packed, ONLY on `npm publish`. | ||
|
||
**prepack** | ||
* Runs BEFORE a tarball is packed (on "`npm pack`", "`npm publish`", and when installing a git dependencies). | ||
* 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** | ||
* Runs AFTER the tarball has been generated and moved to its final destination. | ||
|
||
#### Prepare and Prepublish | ||
|
||
**Deprecation Note: prepublish** | ||
|
||
Since `[email protected]`, 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 `[email protected]`, 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: | ||
|
||
* Compiling CoffeeScript source code into JavaScript. | ||
* Creating minified versions of JavaScript source code. | ||
* 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: | ||
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: | ||
|
||
* You can depend on `coffee-script` as a `devDependency`, and thus | ||
your users don't need to have it installed. | ||
|
@@ -102,8 +76,41 @@ Additionally, this means that: | |
* You don't need to rely on your users having `curl` or `wget` or | ||
other system tools on the target machines. | ||
|
||
### Default Values | ||
### Life Cycle Operation Order | ||
|
||
#### [`npm publish`](/cli-commands/npm-publish) | ||
|
||
* `prepublishOnly` | ||
* `prepare` | ||
* `prepublish` | ||
* `publish` | ||
* `postpublish` | ||
|
||
#### [`npm pack`](/cli-commands/npm-pack) | ||
|
||
* `prepack` | ||
* `postpack` | ||
|
||
#### [`npm install`](/cli-commands/npm-install) | ||
|
||
* `preinstall` | ||
* `install` | ||
* `postinstall` | ||
|
||
Also triggers | ||
|
||
* `prepublish` (when on local) | ||
* `prepare` (when on local) | ||
|
||
#### [`npm start`](/cli-commands/npm-start) | ||
|
||
`npm run start` has an `npm start` shorthand. | ||
|
||
* `prestart` | ||
* `start` | ||
* `poststart` | ||
|
||
### Default Values | ||
npm will default some script values based on package contents. | ||
|
||
* `"start": "node server.js"`: | ||
|
@@ -208,7 +215,7 @@ For example, if your package.json contains this: | |
```json | ||
{ "scripts" : | ||
{ "install" : "scripts/install.js" | ||
, "postinstall" : "scripts/install.js" | ||
, "postinstall" : "scripts/postinstall.js" | ||
, "uninstall" : "scripts/uninstall.js" | ||
} | ||
} | ||
|
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.