Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(docs): update scripts docs #2690

Merged
merged 1 commit into from
Mar 4, 2021
Merged

Conversation

wraithgar
Copy link
Member

The lifecycle events section was very out of date, and lots
of other cleanup needed to happen too

References

Closes npm/statusboard#267


* `preinstall`
* `install`
* `postinstall`
* `prepare` (links only)
Copy link

@DeeDeeG DeeDeeG Feb 13, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the updated documentation... Random person from the community here with a question:

What does "links only" mean here?

Edit: this maybe? https://docs.npmjs.com/cli/v7/commands/npm-link

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is still a WIP PR. This will be fleshed out more as I continue to rewrite this file.

This means symlinks. npm link does use symlinks under the hood, but this also ends up happening for instance when you've installed a package globally.

@darcyclarke darcyclarke added Release 7.x work is associated with a specific npm 7 release release: next These items should be addressed in the next release semver:patch semver patch level for changes labels Feb 13, 2021
@darcyclarke darcyclarke removed the release: next These items should be addressed in the next release label Feb 18, 2021
@wraithgar wraithgar marked this pull request as ready for review February 24, 2021 19:11
@wraithgar wraithgar requested a review from a team as a code owner February 24, 2021 19:11
@wraithgar
Copy link
Member Author

Gonna have to cut this refactor off where it stands. It's a marked improvement on what we have. There's lots more to fix here probably but this PR is too old already.

@wraithgar wraithgar added the release: next These items should be addressed in the next release label Feb 25, 2021
The lifecycle events section was very out of date, and lots
of other cleanup needed to happen too

PR-URL: #2690
Credit: @wraithgar
Close: #2690
Reviewed-by: @ruyadorno
This was referenced Mar 12, 2021
@wraithgar wraithgar deleted the gar/docs-lifecycle branch June 3, 2021 16:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
release: next These items should be addressed in the next release Release 7.x work is associated with a specific npm 7 release semver:patch semver patch level for changes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Spike] Investigate publish lifecycle scripts
4 participants