docs(scripts): replace deprecated prepublish and install examples with prepare #8810
+12
−13
Conversation
This file contains hidden or 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
…h prepare - Updated examples section to use prepare and test scripts instead of discouraged install/postinstall - Changed use case recommendations from prepublish to prepare - Replaced CoffeeScript example with TypeScript (more current) - Replaced make commands with modern build tools (tsc, jest) - Fixes npm#3992
owlstronaut
requested changes
Dec 5, 2025
| **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. | ||
| 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 `prepare` script. |
Contributor
There was a problem hiding this comment.
This sentence is also very strangely composed. Give a go at rephrasing?
| * 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. | ||
| The advantage of doing these things at `prepare` time is that they can be done once, in a single place, thus reducing complexity and variability. |
Contributor
There was a problem hiding this comment.
I know you didn't add this, but doing these things feels very 3rd grade vague. Mind rewording it while you are here?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR updates the scripts.md documentation to remove examples using deprecated and discouraged features.
Changes
Fixes
Closes #3992
Context
The issue reported that the documentation was confusing because it:
This update aligns the examples and recommendations with current best practices: