package.jsonを作ってnpmでInstallする依存関係をまとめる

package.jsonを作っておくとnpm installしたnode_modulesをリポジトリにpushしたりしなくて済むし、複数人で開発する際にnpm installすればpackage.jsonに登録しておいたnode moduleがinstallされるので便利

CocoaPodsとかCarthageのPodfileやCartfileと同じもの

1. node_modulesを.gitignoreに追加する

node_modulesのコードを保存して共有したいということがない限りは.gitignoreにnode_modulesを無視するように追加しよう

node_modules/

2. package.jsonの雛形をつくる

以下のコマンドで作ってくれる

npm init

対話式になっていてプロジェクトの名前、著者、Version、リポジトリの情報などなどを聞かれる

答えていくと以下のようなjsonファイルが出来上がる

{
    "name": "npm-practice",
    "version": "0.0.1",
    "description": "npm package practice",
    "main": "index.js",
    "scripts": {
        "test": "test"
    },
    "repository": {
        "type": "git",
        "url": "https://github.com/corosukeK/npm-practice.git"
    },
    "keywords": [
        "Node.js",
        "npm"
    ],
    "author": "Keisuke Kimura",
    "license": "MIT",
}

3. package.jsonに依存関係を記述する

通常node moduleをInstallする際は

npm install module_name

でInstallできるがオプションを付けることによってpackage.jsonに依存関係を追記してくれる

npm install module_name --save

たとえば

npm install vue.js --save

と実行するとpackage.jsonのdependenciesにvue.jsについて追記される

開発時には使うがdeploy先では使わないようなものなどがあれば

npm install module_name --save-dev

とすればdevDependenciesに追加されるようになる

後は出来上がったpackage.jsonを共有すれば自分以外の人が開発する際でも

npm install

を実行してもらえればnode_modulesが出来上がる

以上です