package.jsonとは？
NpmやYarn等のJavaScriptのパッケージマネージャーがパッケージを定義するファイルです。このファイルに記載されているライブラリ群が一つのパッケージになります。名前の通り純粋なJSON形式のファイルになっており手動で記述することが可能です。ここに追加されたパッケージはプロジェクトが依存するライブラリという意味で依存パッケージと呼びます。
利用されるパッケージマネージャー
- npm
- Yarn
npmやYarnでもどちらでも「package.json」は利用されており共通の仕組みになっております。むしろnpmの規格とされこの仕組みに沿ったパッケージは「npmパッケージ」と呼ばれます。
package.jsonの作成方法
npmでは下記のコマンドで自動生成することが可能です。
|
1 |
npm init -y |
タグ一覧
script
タスクのショートカットを登録することができます。登録したショートカットは「npm run ショートカット」にて呼び出すことが可能です。以下のようなエイリアスが使われることが一般的です。開発環境によってはかなり細かくスクリプトが分かれていたりするので都度勉強が必要になります。
start
アプリケーションの実行
build
本番コードのビルド(webpackなど)
test
テストコードの実行
dependencies
本番環境やローカル環境どちらでも利用するパッケージを指定します。例えば、Reactなど。
|
1 |
npm install パッケージ名@バージョン |
上記のように指定すればパッケージが自動で追加されます。(バージョンを省略した場合は最新版が自動でインストールされます。）
devDependencies
ローカル環境やテスト環境で利用するパッケージを指定します。例えば、eslintやjestなどが代表例です。
|
1 |
npm install パッケージ名 --save-dev(or -D) |
上記のオプションを指定することでここに自動で記述されます。
package-lock.json
yarn installやnpm installなどでインストールするとこのファイルが生成されます。実際にインストールした詳細情報が記述されています。
node_modulesのフォルダに大量のパッケージの実コードがダウンロードされるのですがそのモジュールのバージョンなどの情報が一覧で記載されています。
この記事へのコメントはありません。