はじめに
開発プロジェクトでよく使われるパッケージマネージャー、Yarnとnpm。どちらもpackage.jsonのscriptsエントリを活用して、様々なコマンドを簡単に実行できます。この記事では、このscriptsエントリがどのように動作するのか、そしてそれがどれだけ便利なのかを詳しく解説します。
scriptsエントリの基本
package.jsonの中にはscriptsというエントリがあります。このエントリにコマンドを登録しておくと、Yarnやnpmで簡単にそのコマンドを実行できます。例えば、以下のような設定があった場合、
"scripts": {
"dev": "vite",
"build": "tsc && vite build",
"preview": "vite preview"
}
Yarnではyarn dev、npmではnpm run devといった形で、viteコマンドが実行されます。
予約キーワードと特別な挙動
scriptsエントリには予約キーワードがあり、特別な挙動が設定されています。以下はその例です。
start: 開発用サーバの起動restart: 開発用サーバの再起動stop: 開発用サーバの停止test: テストの実行
これらのキーワードは、特定のnpmコマンドや他のscriptsエントリの前後で自動的に実行される場合もあります。
フックとしての予約キーワード
さらに、preやpostをキーワードの前につけることで、特定の処理の前後にスクリプトを実行できます。例えば、
preinstall,postinstall: パッケージインストールの前後preuninstall,postuninstall: パッケージアンインストールの前後prestart,poststart:startスクリプトの前後pretest,posttest:testスクリプトの前後prepare: インストール後の最終処理
これらは、開発フローをよりスムーズにするために非常に便利です。
まとめ
package.jsonのscriptsエントリは、Yarnとnpmでプロジェクトを効率よく管理するための強力なツールです。予約キーワードやフックを活用することで、より高度なスクリプト管理が可能になります。この機能を最大限に活用して、開発プロセスを効率化しましょう。
参考文献
この記事が役立ったと感じたら、ぜひシェアをお願いします！
