- 投稿日
- 更新日
Life Cycle Scripts を理解する
npm scripts には、pre と post というプレフィックスのついたスクリプトがある。これは、スクリプトの前後に実行されるスクリプトを指定するものである。
その中でも、特定の状況下で実行されるスクリプトがある。それらを Life Cycle Scripts と呼ぶ。この挙動が混乱しがちなので、整理してみた。
Life Cycle Scripts とは、pre や post のついたスクリプトの中でも、特定の状況下で実行されるスクリプトのことである。
具体的には、以下のようなスクリプトが Life Cycle Scripts に該当する。
npm install や npm ci が実行されたときに実行されるスクリプトである。
npm publish では実行されない。(ナント！！！)
このスクリプトは、名前と挙動の違いから混乱するという理由で非推奨1であり、代わりに prepare スクリプトと prepublishOnly スクリプトを使うことが推奨されている。prepublish のユースケースを公式では以下のように説明されている。
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. This includes tasks such as:
Compiling CoffeeScript source code into JavaScript.
Creating minified versions of JavaScript source code.
Fetching remote resources that your package will use.
prepare スクリプトは、npm install や npm publish , npm pack が実行されたときに、実行されるスクリプトである。
prepublish スクリプトの挙動の互換性の観点から、prepare スクリプトは prepublishOnly スクリプトの前に実行され、prepublish スクリプトの後に実行される。
prepublishOnly スクリプトは、npm publish が実行されたときにのみ、実行されるスクリプトである。(シンプル！)
tarball が作成される前に実行されるスクリプトである。tarball が作成されるタイミングは以下の通りである。
npm packnpm publishgit URL でのインストール
ここで npm run pack と npm pack は別である。前者はユーザーが定義したスクリプトであり、prepack は実行されない。
tarball が作成された後に実行されるスクリプトである。
node_modules ディレクトリが変更されたとき、変更の後に実行される。
次に npm のコマンドが実行されたときに、どの Life Cycle Scripts がどの順番で実行されるかを整理する。
| コマンド | 実行される Life Cycle Scripts の種類と順番 |
|---|---|
npm cache add | prepare |
npm ci | preinstall --> install --> postinstall --> prepublish --> preprepare --> prepare --> postprepare |
npm diff | prepare |
npm install2 | preinstall --> install --> postinstall --> prepublish --> preprepare --> prepare --> postprepare |
npm pack | prepack --> pack --> postpack |
npm publish3 | prepublishOnly --> prepack --> prepare --> postpack --> publish --> postpublish |
npm rebuild4 | preinstall --> install --> postinstall --> prepare |
npm restart | prerestart --> restart --> postrestart |
npm start | prestart --> start --> poststart |
npm stop | prestop --> stop --> poststop |
npm test | pretest --> test --> posttest |
npm version | preversion --> version --> postversion |
余談だが npm 以外のパッケージマネージャでは、原則 pre と post プレフィックスの付いたスクリプトは実行されない。これはワークフローの動作が複雑になることを避けるために設計されている。56
また yarn5 や pnpm7 では定義されている Life Cycle Scripts が npm と異なるので注意が必要である。
@s6n_jp から指摘されて気づいたのだが、どうやら pnpm v9 以降では Life Cycle Scripts がサポートされるようになった8ようだ。これにより、pnpm でも npm と同様に Life Cycle Scripts が実行されるようになった。
Twitter で poll を取った結果9入った変更のようで、多くの人がこの変更を望んでいたようだ。
調べていくと、npm の Life Cycle Scripts は意外と複雑で、挙動が混乱しやすい。しかし、理解してしまえば、それほど難しいものではない。この記事が、少しでもその理解に役立てば幸いである。