[DOCS] npm scripts update by mikemimik · Pull Request #729 · npm/cli

mikemimik · 2020-01-27T21:08:00Z

What / Why

This is a continuation of the work that @seanhealy has done. The docs were changed to gatsby with a new styling and the markdown was not rendering correctly. I've simply updated some of the formatting and condensed some sections of information together.

References

docs: Taking a crack at updating the scripts docs. #89

@seanhealy

- A continuation of @seanhealy's work PR-URL: #729 Credit: @mikemimikClose: #729 Reviewed-by: @mikemimik

ljharb · 2020-01-27T22:52:49Z

-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>`.


it might be worth noting that although "test" can be user-defined/overridden, "install" can't be (and probably others, like "publish" etc)?

That's a great point, same with pack. I'll add a "caveats" section. Does that sound right?

Rather than a caveats section I think what I mean is that we have some shorthands for scripts.
npm run test -> npm test
npm run start -> npm start
npm run build -> npm build
npm run restart -> npm restart
I can't think of any others, can you @ljharb ?

Shorthands that can be overridden for user scripts would also include version, but I can't think of any others.
It'd be great to exhaustively list BOTH sets - ie, one list of "shorthand commands that run user scripts when present" and "shorthand commands that ignore user scripts even if present" (noting that they all invoke pre/post scripts)

ljharb · 2020-01-27T22:53:26Z

+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**


it would be helpful to indicate the npm version in which each of these scripts was added inline (not just in the paragraph below, and also including prepack/postpack?)

I think that's a great idea, that context is missing from this update. prepack and postpack are included in the list. Did you mean add the version context to those two script names as well?

Seems only the version information about prepare was there before. I've included it in here now :D

yes, i have no idea when prepack/postpack/pack was added :-p

@seanhealy

- A continuation of @seanhealy's work

npm-deploy-user · 2020-01-28T00:16:31Z

	angular-quickstart			app-large			app-medium			ember-quickstart			react-app
	prev	current	status	prev	current	status	prev	current	status	prev	current	status	prev	current	status
initial install	41s	39.5s	✅	39.5s	35.5s	✅	34.5s	33.2s	✅	28.1s	25.7s	✅	33.5s	30.4s	✅
repeat install	9.6s	8.2s	✅	8.6s	7.7s	✅	8.3s	7.7s	✅	7.7s	6.6s	✅	9.1s	7.7s	✅
with warm cache	32.3s	28.3s	✅	33.8s	30.5s	✅	31.3s	26.3s	✅	23.4s	20.7s	✅	29.1s	26.9s	✅
with node_modules	9.2s	8.2s	✅	8.6s	7.3s	✅	9s	7.7s	✅	7.8s	6.8s	✅	9.4s	7.8s	✅
with lockfile	32.6s	26.6s	✅	31s	29.8s	✅	29s	25.3s	✅	21.7s	19.3s	✅	27.4s	24.8s	✅
with warm cache and node_modules	9.3s	8.6s	✅	7.9s	7.2s	✅	8.4s	8.1s	✅	7.6s	7.4s	✅	9.2s	8s	✅
with warm cache and lockfile	24.7s	22.5s	✅	26.3s	24.6s	✅	24.3s	22.2s	✅	17.8s	15.2s	✅	21.3s	19.5s	✅
with node_modules and lockfile	10.1s	8.3s	✅	9.8s	7.6s	✅	8.6s	8.1s	✅	7.8s	6.8s	✅	9.7s	8.5s	✅

mikemimik · 2020-01-28T16:59:28Z

Note: will be moving this from Sprint 2 -> Sprint 3 and rolled into the next release.

@seanhealy

- A continuation of @seanhealy's work PR-URL: #729 Credit: @mikemimikClose: #729 Reviewed-by: @mikemimik

claudiahdz · 2020-01-29T20:06:12Z

+
+### 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.


Typo in 'addtion'.

claudiahdz · 2020-01-29T20:22:30Z

Can we also improve wording on the "Default Values" section? Just to make it clearer users don't have to explicitly declare a start script in the case of having a sever.js file, for example.

darcyclarke · 2020-02-11T21:56:34Z

Closed out by @mikemimik in #729

mikemimik · 2020-01-27T21:08:00Z

What / Why

This is a continuation of the work that @seanhealy has done. The docs were changed to gatsby with a new styling and the markdown was not rendering correctly. I've simply updated some of the formatting and condensed some sections of information together.

References

docs: Taking a crack at updating the scripts docs. #89

@seanhealy

- A continuation of @seanhealy's work PR-URL: #729 Credit: @mikemimikClose: #729 Reviewed-by: @mikemimik

ljharb · 2020-01-27T22:52:49Z

-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>`.


it might be worth noting that although "test" can be user-defined/overridden, "install" can't be (and probably others, like "publish" etc)?

That's a great point, same with pack. I'll add a "caveats" section. Does that sound right?

Rather than a caveats section I think what I mean is that we have some shorthands for scripts.
npm run test -> npm test
npm run start -> npm start
npm run build -> npm build
npm run restart -> npm restart
I can't think of any others, can you @ljharb ?

Shorthands that can be overridden for user scripts would also include version, but I can't think of any others.
It'd be great to exhaustively list BOTH sets - ie, one list of "shorthand commands that run user scripts when present" and "shorthand commands that ignore user scripts even if present" (noting that they all invoke pre/post scripts)

ljharb · 2020-01-27T22:53:26Z

+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**


it would be helpful to indicate the npm version in which each of these scripts was added inline (not just in the paragraph below, and also including prepack/postpack?)

I think that's a great idea, that context is missing from this update. prepack and postpack are included in the list. Did you mean add the version context to those two script names as well?

Seems only the version information about prepare was there before. I've included it in here now :D

yes, i have no idea when prepack/postpack/pack was added :-p

@seanhealy

- A continuation of @seanhealy's work

npm-deploy-user · 2020-01-28T00:16:31Z

	angular-quickstart			app-large			app-medium			ember-quickstart			react-app
	prev	current	status	prev	current	status	prev	current	status	prev	current	status	prev	current	status
initial install	41s	39.5s	✅	39.5s	35.5s	✅	34.5s	33.2s	✅	28.1s	25.7s	✅	33.5s	30.4s	✅
repeat install	9.6s	8.2s	✅	8.6s	7.7s	✅	8.3s	7.7s	✅	7.7s	6.6s	✅	9.1s	7.7s	✅
with warm cache	32.3s	28.3s	✅	33.8s	30.5s	✅	31.3s	26.3s	✅	23.4s	20.7s	✅	29.1s	26.9s	✅
with node_modules	9.2s	8.2s	✅	8.6s	7.3s	✅	9s	7.7s	✅	7.8s	6.8s	✅	9.4s	7.8s	✅
with lockfile	32.6s	26.6s	✅	31s	29.8s	✅	29s	25.3s	✅	21.7s	19.3s	✅	27.4s	24.8s	✅
with warm cache and node_modules	9.3s	8.6s	✅	7.9s	7.2s	✅	8.4s	8.1s	✅	7.6s	7.4s	✅	9.2s	8s	✅
with warm cache and lockfile	24.7s	22.5s	✅	26.3s	24.6s	✅	24.3s	22.2s	✅	17.8s	15.2s	✅	21.3s	19.5s	✅
with node_modules and lockfile	10.1s	8.3s	✅	9.8s	7.6s	✅	8.6s	8.1s	✅	7.8s	6.8s	✅	9.7s	8.5s	✅

mikemimik · 2020-01-28T16:59:28Z

Note: will be moving this from Sprint 2 -> Sprint 3 and rolled into the next release.

@seanhealy

- A continuation of @seanhealy's work PR-URL: #729 Credit: @mikemimikClose: #729 Reviewed-by: @mikemimik

claudiahdz · 2020-01-29T20:06:12Z

+
+### 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.


Typo in 'addtion'.

claudiahdz · 2020-01-29T20:22:30Z

Can we also improve wording on the "Default Values" section? Just to make it clearer users don't have to explicitly declare a start script in the case of having a sever.js file, for example.

darcyclarke · 2020-02-11T21:56:34Z

Closed out by @mikemimik in #729

mikemimik · 2020-01-27T21:08:00Z

What / Why

This is a continuation of the work that @seanhealy has done. The docs were changed to gatsby with a new styling and the markdown was not rendering correctly. I've simply updated some of the formatting and condensed some sections of information together.

References

docs: Taking a crack at updating the scripts docs. #89

@seanhealy

- A continuation of @seanhealy's work PR-URL: #729 Credit: @mikemimikClose: #729 Reviewed-by: @mikemimik

ljharb · 2020-01-27T22:52:49Z

-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>`.


it might be worth noting that although "test" can be user-defined/overridden, "install" can't be (and probably others, like "publish" etc)?

That's a great point, same with pack. I'll add a "caveats" section. Does that sound right?

Rather than a caveats section I think what I mean is that we have some shorthands for scripts.
npm run test -> npm test
npm run start -> npm start
npm run build -> npm build
npm run restart -> npm restart
I can't think of any others, can you @ljharb ?

Shorthands that can be overridden for user scripts would also include version, but I can't think of any others.
It'd be great to exhaustively list BOTH sets - ie, one list of "shorthand commands that run user scripts when present" and "shorthand commands that ignore user scripts even if present" (noting that they all invoke pre/post scripts)

ljharb · 2020-01-27T22:53:26Z

+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**


it would be helpful to indicate the npm version in which each of these scripts was added inline (not just in the paragraph below, and also including prepack/postpack?)

I think that's a great idea, that context is missing from this update. prepack and postpack are included in the list. Did you mean add the version context to those two script names as well?

Seems only the version information about prepare was there before. I've included it in here now :D

yes, i have no idea when prepack/postpack/pack was added :-p

@seanhealy

- A continuation of @seanhealy's work

npm-deploy-user · 2020-01-28T00:16:31Z

	angular-quickstart			app-large			app-medium			ember-quickstart			react-app
	prev	current	status	prev	current	status	prev	current	status	prev	current	status	prev	current	status
initial install	41s	39.5s	✅	39.5s	35.5s	✅	34.5s	33.2s	✅	28.1s	25.7s	✅	33.5s	30.4s	✅
repeat install	9.6s	8.2s	✅	8.6s	7.7s	✅	8.3s	7.7s	✅	7.7s	6.6s	✅	9.1s	7.7s	✅
with warm cache	32.3s	28.3s	✅	33.8s	30.5s	✅	31.3s	26.3s	✅	23.4s	20.7s	✅	29.1s	26.9s	✅
with node_modules	9.2s	8.2s	✅	8.6s	7.3s	✅	9s	7.7s	✅	7.8s	6.8s	✅	9.4s	7.8s	✅
with lockfile	32.6s	26.6s	✅	31s	29.8s	✅	29s	25.3s	✅	21.7s	19.3s	✅	27.4s	24.8s	✅
with warm cache and node_modules	9.3s	8.6s	✅	7.9s	7.2s	✅	8.4s	8.1s	✅	7.6s	7.4s	✅	9.2s	8s	✅
with warm cache and lockfile	24.7s	22.5s	✅	26.3s	24.6s	✅	24.3s	22.2s	✅	17.8s	15.2s	✅	21.3s	19.5s	✅
with node_modules and lockfile	10.1s	8.3s	✅	9.8s	7.6s	✅	8.6s	8.1s	✅	7.8s	6.8s	✅	9.7s	8.5s	✅

mikemimik · 2020-01-28T16:59:28Z

Note: will be moving this from Sprint 2 -> Sprint 3 and rolled into the next release.

@seanhealy

- A continuation of @seanhealy's work PR-URL: #729 Credit: @mikemimikClose: #729 Reviewed-by: @mikemimik

claudiahdz · 2020-01-29T20:06:12Z

+
+### 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.


Typo in 'addtion'.

claudiahdz · 2020-01-29T20:22:30Z

Can we also improve wording on the "Default Values" section? Just to make it clearer users don't have to explicitly declare a start script in the case of having a sever.js file, for example.

darcyclarke · 2020-02-11T21:56:34Z

Closed out by @mikemimik in #729

mikemimik · 2020-01-27T21:08:00Z

What / Why

This is a continuation of the work that @seanhealy has done. The docs were changed to gatsby with a new styling and the markdown was not rendering correctly. I've simply updated some of the formatting and condensed some sections of information together.

References

docs: Taking a crack at updating the scripts docs. #89

@seanhealy

- A continuation of @seanhealy's work PR-URL: #729 Credit: @mikemimikClose: #729 Reviewed-by: @mikemimik

ljharb · 2020-01-27T22:52:49Z

-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>`.


it might be worth noting that although "test" can be user-defined/overridden, "install" can't be (and probably others, like "publish" etc)?

That's a great point, same with pack. I'll add a "caveats" section. Does that sound right?

Rather than a caveats section I think what I mean is that we have some shorthands for scripts.
npm run test -> npm test
npm run start -> npm start
npm run build -> npm build
npm run restart -> npm restart
I can't think of any others, can you @ljharb ?

Shorthands that can be overridden for user scripts would also include version, but I can't think of any others.
It'd be great to exhaustively list BOTH sets - ie, one list of "shorthand commands that run user scripts when present" and "shorthand commands that ignore user scripts even if present" (noting that they all invoke pre/post scripts)

ljharb · 2020-01-27T22:53:26Z

+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**


it would be helpful to indicate the npm version in which each of these scripts was added inline (not just in the paragraph below, and also including prepack/postpack?)

I think that's a great idea, that context is missing from this update. prepack and postpack are included in the list. Did you mean add the version context to those two script names as well?

Seems only the version information about prepare was there before. I've included it in here now :D

yes, i have no idea when prepack/postpack/pack was added :-p

@seanhealy

- A continuation of @seanhealy's work

npm-deploy-user · 2020-01-28T00:16:31Z

	angular-quickstart			app-large			app-medium			ember-quickstart			react-app
	prev	current	status	prev	current	status	prev	current	status	prev	current	status	prev	current	status
initial install	41s	39.5s	✅	39.5s	35.5s	✅	34.5s	33.2s	✅	28.1s	25.7s	✅	33.5s	30.4s	✅
repeat install	9.6s	8.2s	✅	8.6s	7.7s	✅	8.3s	7.7s	✅	7.7s	6.6s	✅	9.1s	7.7s	✅
with warm cache	32.3s	28.3s	✅	33.8s	30.5s	✅	31.3s	26.3s	✅	23.4s	20.7s	✅	29.1s	26.9s	✅
with node_modules	9.2s	8.2s	✅	8.6s	7.3s	✅	9s	7.7s	✅	7.8s	6.8s	✅	9.4s	7.8s	✅
with lockfile	32.6s	26.6s	✅	31s	29.8s	✅	29s	25.3s	✅	21.7s	19.3s	✅	27.4s	24.8s	✅
with warm cache and node_modules	9.3s	8.6s	✅	7.9s	7.2s	✅	8.4s	8.1s	✅	7.6s	7.4s	✅	9.2s	8s	✅
with warm cache and lockfile	24.7s	22.5s	✅	26.3s	24.6s	✅	24.3s	22.2s	✅	17.8s	15.2s	✅	21.3s	19.5s	✅
with node_modules and lockfile	10.1s	8.3s	✅	9.8s	7.6s	✅	8.6s	8.1s	✅	7.8s	6.8s	✅	9.7s	8.5s	✅

mikemimik · 2020-01-28T16:59:28Z

Note: will be moving this from Sprint 2 -> Sprint 3 and rolled into the next release.

@seanhealy

- A continuation of @seanhealy's work PR-URL: #729 Credit: @mikemimikClose: #729 Reviewed-by: @mikemimik

claudiahdz · 2020-01-29T20:06:12Z

+
+### 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.


Typo in 'addtion'.

claudiahdz · 2020-01-29T20:22:30Z

Can we also improve wording on the "Default Values" section? Just to make it clearer users don't have to explicitly declare a start script in the case of having a sever.js file, for example.

darcyclarke · 2020-02-11T21:56:34Z

Closed out by @mikemimik in #729

mikemimik · 2020-01-27T21:08:00Z

What / Why

This is a continuation of the work that @seanhealy has done. The docs were changed to gatsby with a new styling and the markdown was not rendering correctly. I've simply updated some of the formatting and condensed some sections of information together.

References

docs: Taking a crack at updating the scripts docs. #89

@seanhealy

- A continuation of @seanhealy's work PR-URL: #729 Credit: @mikemimikClose: #729 Reviewed-by: @mikemimik

ljharb · 2020-01-27T22:52:49Z

-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>`.


it might be worth noting that although "test" can be user-defined/overridden, "install" can't be (and probably others, like "publish" etc)?

That's a great point, same with pack. I'll add a "caveats" section. Does that sound right?

Rather than a caveats section I think what I mean is that we have some shorthands for scripts.
npm run test -> npm test
npm run start -> npm start
npm run build -> npm build
npm run restart -> npm restart
I can't think of any others, can you @ljharb ?

Shorthands that can be overridden for user scripts would also include version, but I can't think of any others.
It'd be great to exhaustively list BOTH sets - ie, one list of "shorthand commands that run user scripts when present" and "shorthand commands that ignore user scripts even if present" (noting that they all invoke pre/post scripts)

ljharb · 2020-01-27T22:53:26Z

+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**


it would be helpful to indicate the npm version in which each of these scripts was added inline (not just in the paragraph below, and also including prepack/postpack?)

I think that's a great idea, that context is missing from this update. prepack and postpack are included in the list. Did you mean add the version context to those two script names as well?

Seems only the version information about prepare was there before. I've included it in here now :D

yes, i have no idea when prepack/postpack/pack was added :-p

@seanhealy

- A continuation of @seanhealy's work

npm-deploy-user · 2020-01-28T00:16:31Z

	angular-quickstart			app-large			app-medium			ember-quickstart			react-app
	prev	current	status	prev	current	status	prev	current	status	prev	current	status	prev	current	status
initial install	41s	39.5s	✅	39.5s	35.5s	✅	34.5s	33.2s	✅	28.1s	25.7s	✅	33.5s	30.4s	✅
repeat install	9.6s	8.2s	✅	8.6s	7.7s	✅	8.3s	7.7s	✅	7.7s	6.6s	✅	9.1s	7.7s	✅
with warm cache	32.3s	28.3s	✅	33.8s	30.5s	✅	31.3s	26.3s	✅	23.4s	20.7s	✅	29.1s	26.9s	✅
with node_modules	9.2s	8.2s	✅	8.6s	7.3s	✅	9s	7.7s	✅	7.8s	6.8s	✅	9.4s	7.8s	✅
with lockfile	32.6s	26.6s	✅	31s	29.8s	✅	29s	25.3s	✅	21.7s	19.3s	✅	27.4s	24.8s	✅
with warm cache and node_modules	9.3s	8.6s	✅	7.9s	7.2s	✅	8.4s	8.1s	✅	7.6s	7.4s	✅	9.2s	8s	✅
with warm cache and lockfile	24.7s	22.5s	✅	26.3s	24.6s	✅	24.3s	22.2s	✅	17.8s	15.2s	✅	21.3s	19.5s	✅
with node_modules and lockfile	10.1s	8.3s	✅	9.8s	7.6s	✅	8.6s	8.1s	✅	7.8s	6.8s	✅	9.7s	8.5s	✅

mikemimik · 2020-01-28T16:59:28Z

Note: will be moving this from Sprint 2 -> Sprint 3 and rolled into the next release.

@seanhealy

- A continuation of @seanhealy's work PR-URL: #729 Credit: @mikemimikClose: #729 Reviewed-by: @mikemimik

claudiahdz · 2020-01-29T20:06:12Z

+
+### 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.


Typo in 'addtion'.

claudiahdz · 2020-01-29T20:22:30Z

Can we also improve wording on the "Default Values" section? Just to make it clearer users don't have to explicitly declare a start script in the case of having a sever.js file, for example.

darcyclarke · 2020-02-11T21:56:34Z

Closed out by @mikemimik in #729

mikemimik · 2020-01-27T21:08:00Z

What / Why

This is a continuation of the work that @seanhealy has done. The docs were changed to gatsby with a new styling and the markdown was not rendering correctly. I've simply updated some of the formatting and condensed some sections of information together.

References

docs: Taking a crack at updating the scripts docs. #89

@seanhealy

- A continuation of @seanhealy's work PR-URL: #729 Credit: @mikemimikClose: #729 Reviewed-by: @mikemimik

ljharb · 2020-01-27T22:52:49Z

-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>`.


it might be worth noting that although "test" can be user-defined/overridden, "install" can't be (and probably others, like "publish" etc)?

That's a great point, same with pack. I'll add a "caveats" section. Does that sound right?

Rather than a caveats section I think what I mean is that we have some shorthands for scripts.
npm run test -> npm test
npm run start -> npm start
npm run build -> npm build
npm run restart -> npm restart
I can't think of any others, can you @ljharb ?

Shorthands that can be overridden for user scripts would also include version, but I can't think of any others.
It'd be great to exhaustively list BOTH sets - ie, one list of "shorthand commands that run user scripts when present" and "shorthand commands that ignore user scripts even if present" (noting that they all invoke pre/post scripts)

ljharb · 2020-01-27T22:53:26Z

+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**


it would be helpful to indicate the npm version in which each of these scripts was added inline (not just in the paragraph below, and also including prepack/postpack?)

I think that's a great idea, that context is missing from this update. prepack and postpack are included in the list. Did you mean add the version context to those two script names as well?

Seems only the version information about prepare was there before. I've included it in here now :D

yes, i have no idea when prepack/postpack/pack was added :-p

@seanhealy

- A continuation of @seanhealy's work

npm-deploy-user · 2020-01-28T00:16:31Z

	angular-quickstart			app-large			app-medium			ember-quickstart			react-app
	prev	current	status	prev	current	status	prev	current	status	prev	current	status	prev	current	status
initial install	41s	39.5s	✅	39.5s	35.5s	✅	34.5s	33.2s	✅	28.1s	25.7s	✅	33.5s	30.4s	✅
repeat install	9.6s	8.2s	✅	8.6s	7.7s	✅	8.3s	7.7s	✅	7.7s	6.6s	✅	9.1s	7.7s	✅
with warm cache	32.3s	28.3s	✅	33.8s	30.5s	✅	31.3s	26.3s	✅	23.4s	20.7s	✅	29.1s	26.9s	✅
with node_modules	9.2s	8.2s	✅	8.6s	7.3s	✅	9s	7.7s	✅	7.8s	6.8s	✅	9.4s	7.8s	✅
with lockfile	32.6s	26.6s	✅	31s	29.8s	✅	29s	25.3s	✅	21.7s	19.3s	✅	27.4s	24.8s	✅
with warm cache and node_modules	9.3s	8.6s	✅	7.9s	7.2s	✅	8.4s	8.1s	✅	7.6s	7.4s	✅	9.2s	8s	✅
with warm cache and lockfile	24.7s	22.5s	✅	26.3s	24.6s	✅	24.3s	22.2s	✅	17.8s	15.2s	✅	21.3s	19.5s	✅
with node_modules and lockfile	10.1s	8.3s	✅	9.8s	7.6s	✅	8.6s	8.1s	✅	7.8s	6.8s	✅	9.7s	8.5s	✅

mikemimik · 2020-01-28T16:59:28Z

Note: will be moving this from Sprint 2 -> Sprint 3 and rolled into the next release.

@seanhealy

- A continuation of @seanhealy's work PR-URL: #729 Credit: @mikemimikClose: #729 Reviewed-by: @mikemimik

claudiahdz · 2020-01-29T20:06:12Z

+
+### 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.


Typo in 'addtion'.

claudiahdz · 2020-01-29T20:22:30Z

Can we also improve wording on the "Default Values" section? Just to make it clearer users don't have to explicitly declare a start script in the case of having a sever.js file, for example.

darcyclarke · 2020-02-11T21:56:34Z

Closed out by @mikemimik in #729

mikemimik · 2020-01-27T21:08:00Z

What / Why

This is a continuation of the work that @seanhealy has done. The docs were changed to gatsby with a new styling and the markdown was not rendering correctly. I've simply updated some of the formatting and condensed some sections of information together.

References

docs: Taking a crack at updating the scripts docs. #89

@seanhealy

- A continuation of @seanhealy's work PR-URL: #729 Credit: @mikemimikClose: #729 Reviewed-by: @mikemimik

ljharb · 2020-01-27T22:52:49Z

-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>`.


it might be worth noting that although "test" can be user-defined/overridden, "install" can't be (and probably others, like "publish" etc)?

That's a great point, same with pack. I'll add a "caveats" section. Does that sound right?

Rather than a caveats section I think what I mean is that we have some shorthands for scripts.
npm run test -> npm test
npm run start -> npm start
npm run build -> npm build
npm run restart -> npm restart
I can't think of any others, can you @ljharb ?

Shorthands that can be overridden for user scripts would also include version, but I can't think of any others.
It'd be great to exhaustively list BOTH sets - ie, one list of "shorthand commands that run user scripts when present" and "shorthand commands that ignore user scripts even if present" (noting that they all invoke pre/post scripts)

ljharb · 2020-01-27T22:53:26Z

+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**


it would be helpful to indicate the npm version in which each of these scripts was added inline (not just in the paragraph below, and also including prepack/postpack?)

I think that's a great idea, that context is missing from this update. prepack and postpack are included in the list. Did you mean add the version context to those two script names as well?

Seems only the version information about prepare was there before. I've included it in here now :D

yes, i have no idea when prepack/postpack/pack was added :-p

@seanhealy

- A continuation of @seanhealy's work

npm-deploy-user · 2020-01-28T00:16:31Z

	angular-quickstart			app-large			app-medium			ember-quickstart			react-app
	prev	current	status	prev	current	status	prev	current	status	prev	current	status	prev	current	status
initial install	41s	39.5s	✅	39.5s	35.5s	✅	34.5s	33.2s	✅	28.1s	25.7s	✅	33.5s	30.4s	✅
repeat install	9.6s	8.2s	✅	8.6s	7.7s	✅	8.3s	7.7s	✅	7.7s	6.6s	✅	9.1s	7.7s	✅
with warm cache	32.3s	28.3s	✅	33.8s	30.5s	✅	31.3s	26.3s	✅	23.4s	20.7s	✅	29.1s	26.9s	✅
with node_modules	9.2s	8.2s	✅	8.6s	7.3s	✅	9s	7.7s	✅	7.8s	6.8s	✅	9.4s	7.8s	✅
with lockfile	32.6s	26.6s	✅	31s	29.8s	✅	29s	25.3s	✅	21.7s	19.3s	✅	27.4s	24.8s	✅
with warm cache and node_modules	9.3s	8.6s	✅	7.9s	7.2s	✅	8.4s	8.1s	✅	7.6s	7.4s	✅	9.2s	8s	✅
with warm cache and lockfile	24.7s	22.5s	✅	26.3s	24.6s	✅	24.3s	22.2s	✅	17.8s	15.2s	✅	21.3s	19.5s	✅
with node_modules and lockfile	10.1s	8.3s	✅	9.8s	7.6s	✅	8.6s	8.1s	✅	7.8s	6.8s	✅	9.7s	8.5s	✅

mikemimik · 2020-01-28T16:59:28Z

Note: will be moving this from Sprint 2 -> Sprint 3 and rolled into the next release.

@seanhealy

- A continuation of @seanhealy's work PR-URL: #729 Credit: @mikemimikClose: #729 Reviewed-by: @mikemimik

claudiahdz · 2020-01-29T20:06:12Z

+
+### 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.


Typo in 'addtion'.

claudiahdz · 2020-01-29T20:22:30Z

Can we also improve wording on the "Default Values" section? Just to make it clearer users don't have to explicitly declare a start script in the case of having a sever.js file, for example.

darcyclarke · 2020-02-11T21:56:34Z

Closed out by @mikemimik in #729

mikemimik · 2020-01-27T21:08:00Z

What / Why

This is a continuation of the work that @seanhealy has done. The docs were changed to gatsby with a new styling and the markdown was not rendering correctly. I've simply updated some of the formatting and condensed some sections of information together.

References

docs: Taking a crack at updating the scripts docs. #89

@seanhealy

- A continuation of @seanhealy's work PR-URL: #729 Credit: @mikemimikClose: #729 Reviewed-by: @mikemimik

ljharb · 2020-01-27T22:52:49Z

-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>`.


it might be worth noting that although "test" can be user-defined/overridden, "install" can't be (and probably others, like "publish" etc)?

That's a great point, same with pack. I'll add a "caveats" section. Does that sound right?

Rather than a caveats section I think what I mean is that we have some shorthands for scripts.
npm run test -> npm test
npm run start -> npm start
npm run build -> npm build
npm run restart -> npm restart
I can't think of any others, can you @ljharb ?

Shorthands that can be overridden for user scripts would also include version, but I can't think of any others.
It'd be great to exhaustively list BOTH sets - ie, one list of "shorthand commands that run user scripts when present" and "shorthand commands that ignore user scripts even if present" (noting that they all invoke pre/post scripts)

ljharb · 2020-01-27T22:53:26Z

+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**


it would be helpful to indicate the npm version in which each of these scripts was added inline (not just in the paragraph below, and also including prepack/postpack?)

I think that's a great idea, that context is missing from this update. prepack and postpack are included in the list. Did you mean add the version context to those two script names as well?

Seems only the version information about prepare was there before. I've included it in here now :D

yes, i have no idea when prepack/postpack/pack was added :-p

@seanhealy

- A continuation of @seanhealy's work

npm-deploy-user · 2020-01-28T00:16:31Z

	angular-quickstart			app-large			app-medium			ember-quickstart			react-app
	prev	current	status	prev	current	status	prev	current	status	prev	current	status	prev	current	status
initial install	41s	39.5s	✅	39.5s	35.5s	✅	34.5s	33.2s	✅	28.1s	25.7s	✅	33.5s	30.4s	✅
repeat install	9.6s	8.2s	✅	8.6s	7.7s	✅	8.3s	7.7s	✅	7.7s	6.6s	✅	9.1s	7.7s	✅
with warm cache	32.3s	28.3s	✅	33.8s	30.5s	✅	31.3s	26.3s	✅	23.4s	20.7s	✅	29.1s	26.9s	✅
with node_modules	9.2s	8.2s	✅	8.6s	7.3s	✅	9s	7.7s	✅	7.8s	6.8s	✅	9.4s	7.8s	✅
with lockfile	32.6s	26.6s	✅	31s	29.8s	✅	29s	25.3s	✅	21.7s	19.3s	✅	27.4s	24.8s	✅
with warm cache and node_modules	9.3s	8.6s	✅	7.9s	7.2s	✅	8.4s	8.1s	✅	7.6s	7.4s	✅	9.2s	8s	✅
with warm cache and lockfile	24.7s	22.5s	✅	26.3s	24.6s	✅	24.3s	22.2s	✅	17.8s	15.2s	✅	21.3s	19.5s	✅
with node_modules and lockfile	10.1s	8.3s	✅	9.8s	7.6s	✅	8.6s	8.1s	✅	7.8s	6.8s	✅	9.7s	8.5s	✅

mikemimik · 2020-01-28T16:59:28Z

Note: will be moving this from Sprint 2 -> Sprint 3 and rolled into the next release.

@seanhealy

- A continuation of @seanhealy's work PR-URL: #729 Credit: @mikemimikClose: #729 Reviewed-by: @mikemimik

claudiahdz · 2020-01-29T20:06:12Z

+
+### 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.


Typo in 'addtion'.

claudiahdz · 2020-01-29T20:22:30Z

Can we also improve wording on the "Default Values" section? Just to make it clearer users don't have to explicitly declare a start script in the case of having a sever.js file, for example.

darcyclarke · 2020-02-11T21:56:34Z

Closed out by @mikemimik in #729

First take on breaking out the lifecycle hooks.
2012f52

mikemimik added semver:patch semver patch level for changes Enhancement new feature or improvement Release 6.x work is associated with a specific npm 6 release Community labels Jan 27, 2020

mikemimik added this to the OSS - Sprint 2 milestone Jan 27, 2020

mikemimik requested a review from a teamJanuary 27, 2020 21:08

mikemimik self-assigned this Jan 27, 2020

mikemimik pushed a commit that referenced this pull request Jan 27, 2020
docs: updated scripts docs in using-npm section
9e3a103
- A continuation of @seanhealy's work PR-URL: #729 Credit: @mikemimikClose: #729 Reviewed-by: @mikemimik

ljharb reviewed Jan 27, 2020
View reviewed changes

docs: updated scripts docs in using-npm section
e95987c
- A continuation of @seanhealy's work

mikemimik force-pushed the mikemimik/feature/npm-scripts-update branch from 83f2241 to e95987cCompare January 28, 2020 00:01

darcyclarke approved these changes Jan 28, 2020
View reviewed changes

mikemimik modified the milestones: OSS - Sprint 2, OSS - Sprint 3 Jan 28, 2020

mikemimik pushed a commit that referenced this pull request Jan 28, 2020
docs: updated scripts docs in using-npm section
a6790d1
- A continuation of @seanhealy's work PR-URL: #729 Credit: @mikemimikClose: #729 Reviewed-by: @mikemimik

claudiahdz reviewed Jan 29, 2020
View reviewed changes

claudiahdz approved these changes Jan 29, 2020
View reviewed changes

darcyclarke closed this Feb 11, 2020

darcyclarke reopened this Feb 11, 2020

darcyclarke mentioned this pull request Feb 11, 2020
docs: Taking a crack at updating the scripts docs. #89
Closed

darcyclarke modified the milestones: OSS - Sprint 3, OSS - Sprint 4 Feb 11, 2020

darcyclarke mentioned this pull request Feb 18, 2020
Release v6.14npm/statusboard#68
Closed

darcyclarke closed this in 284c1c0Feb 25, 2020

isaacs mentioned this pull request Feb 27, 2020
deps: upgrade npm to 6.14.1 nodejs/node#31977
Closed

snyk-bot mentioned this pull request Mar 10, 2020
[Snyk] Upgrade npm from 6.11.2 to 6.14.2 Hypnos3/RedMatic#4
Open

This was referenced Mar 26, 2020
[Snyk] Upgrade npm from 6.4.1 to 6.14.2 ali8889/etherwallet#14
Open
[Snyk] Upgrade npm from 6.2.0 to 6.14.2 restinpeaceinout/atom#163
Open
[Snyk] Upgrade npm from 6.1.0 to 6.14.2 nahidf/mock-api#2
Closed

claudiahdz deleted the mikemimik/feature/npm-scripts-update branch March 30, 2020 23:03

snyk-bot mentioned this pull request Apr 1, 2020
[Snyk] Upgrade npm from 6.4.1 to 6.14.4 baophucct/etherwallet#1
Open

This was referenced Apr 8, 2020
[Snyk] Upgrade npm from 6.14.0 to 6.14.2 paulradzkov/scaffold#9
Merged
[Snyk] Upgrade npm from 6.4.1 to 6.14.3 ali8889/etherwallet#15
Open
[Snyk] Upgrade npm from 6.2.0 to 6.14.3 restinpeaceinout/atom#180
Open

This was referenced Apr 17, 2020
[Snyk] Upgrade npm from 6.4.1 to 6.14.4 ali8889/etherwallet#17
Open
[Snyk] Upgrade npm from 6.2.0 to 6.14.4 restinpeaceinout/atom#186
Open
[Snyk] Upgrade npm from 6.10.1 to 6.14.4 aminatakonate000/Graviton-App#3
Open

snyk-ioBot mentioned this pull request Oct 21, 2024
[Snyk] Fix for 21 vulnerabilities Graybar-codespace/cli-3#24
Open