[BUG] scripts.md promotes the use of deprecated and otherwise discouraged features #3992
Open
1 task done
Labels
Bug
thing that needs fixing
Documentation
documentation related issue
Release 8.x
work is associated with a specific npm 8 release
Is there an existing issue for this?
Current Behavior
Since at least 2015, the documentation has mentioned that
prepublish
scripts[1], as well asinstall
scripts[2] are discouraged, with the former also being deprecated. Conversely, the section immediately following the deprecation notice ofprepublish
recommends using it for transpilation and fetching remote resources.Similarly, the only examples[3] on the page showcase the use of the recently removed
uninstall
script[4] along withinstall
being used to execute Unix Make scripts, discouraged in favor of node-gyp (and ironically,prepublish
scripts) just two sections later.Expected Behavior
Documentation is consistent and leaves the reader informed, not confused. Current examples should be replaced with more realistic ones. According to bug 10074[5],
prepare
should take the place ofprepublish
.The text was updated successfully, but these errors were encountered: