駆け出しのエンジニア日記

プログラミング言語勉強中の奮闘日記

package.jsonについて

package.jsonについて触れる前に、npmのインストールについて簡単に再度説明します。

実は前回記述した

 npm install <パッケージ名>
または
 npm i <パッケージ名>

ローカルインストールというものになります。(dependenciesに追加される)

プロジェクト単位でパッケージのバージョンが異なる場合や、特定のプロジェクトでし

か使わないパッケージなどは、ローカルインストールにします。
(基本的にパッケージはロカールインストールです。)

それと別に、グローバルインストールがあります。

 npm install global <パッケージ名>
または
 npm i g <パッケージ名>

グローバルインストールは、PC上のどのフォルダからでも、コマンドが実行できる場所にインストールされます。

どのプロジェクトでも使用するパッケージで、なおかつ全てのプロジェクトで同じバー

ジョンを使用する場合などは、グローバルインストールしておくとよいかと思います。

 

・package.json

一言で説明すると、「Node.jsにおいてインストールするパッケージが記述されたファイル」です。

下記はpackage.jsonのサンプルです。

{
"name": "artster",
"version": "1.0.0",
"main": "index.js",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
"author": "",
"license": "ISC",
"dependencies": {
"colors": "^1.4.0",
"figlet": "^1.5.2"
},
"description": ""
}

構成要素いくつか見ていきます。

・name:パッケージ名

・version:パッケージのバージョン

・description:パッケージの説明

・dependencies:本番環境でも利用するパッケージやその依存関係が記述される

例えば、package.jsonがあるディレクトリでnpm installコマンドを実行すると、

dependenciesに記述されたモジュールがnode_module内にインストールされます。

 

ちなみに、dependenciesの「figlet」の詳細も載せておきます。

https://www.npmjs.com/package/figlet

 

また、「 npm init 」コマンドというコマンドがあります。

これはnpmで管理するプロジェクトの初期化コマンドです。実行すると、簡単に

package.jsonファイルを作成することができます。

package.jsonはパッケージ管理の設計書で、どんな環境においてもpackage.jsonを読み

込むことで同じパッケージをインストールすることができるものです。