[RRFC] Development lifecycle scripts (hooks)
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 777
- Forks
- 267
- PR merge metrics
- No merged PRs in 30d
Description
Motivation ("The Why")
Sometimes in a project, there is a need to setup the development environment or enforce some policies on dependencies used in the project. However, npm doesn't provide a way to hook into its process and lifecycle scripts such as postinstall are (ab)used:
huskyusespostinstallto autoinstall Git hooks andpinstto disable them in the productionpostinstall-postinstallruns the app'spostinstallscript during itspostinstallscript- TBA
Furthermore, there is no way to run a script if the dependency tree of the pakcage has changed, i.e., a dependency is added or removed.
Example
As mentioned above, it can be used to setup the development environment or enforce some policies on dependencies used in the project.
How
Current Behaviour
postinstallscript runs afternpm install, but also runs when the package is installed as a dependencypreparescript runs afternpm install, but also before the pakcage is packed- Both scripts don't run when the dependency tree is changed and there is no way to trigger a script in this case
Desired Behaviour
- A new lifecycle, such as
preinstalldepandpostinstalldep - or, hook scripts that run before and after the dependency tree has changed (
reify)
References
- Old RFC #34 exists but seems stalled
- Alternative to #325
- Related to #437
Other package managers
- Yarn 1: undocumented hooks can wrap each step (https://github.com/yarnpkg/yarn/pull/7557)
- Yarn 2: hooks can be added via a plugin (https://yarnpkg.com/advanced/plugin-tutorial#using-hooks)
- pnpm: hooks can be added via configuration (https://pnpm.io/pnpmfile)
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
No implementation files or tests are identified in the issue. Start by reviewing the Current Behaviour, Desired Behaviour, and referenced RFCs #34, #325, and #437; the work is complete when a specific lifecycle-hook design has been agreed and documented.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100