npmとは
Node Packaged Managerの略字。
node.jsで作られたpakageを管理するツールのこと。
開発者はnpmを利用してnode.jsで作られたpackageをインストールすることができる。
npm の利用方法
npmのインストール
node.jsサイトにて簡単にインストールすることができる。
packageのインストール
以下のコマンドでweb上のpackageをインストールすることができる。
npm install webpack
package.jsonの生成
以下のコマンドをターミナルで入力するとpackage.jsonを生成することができる。
正確には、npmを使うための初期設定をするコマンド。
npm init
コマンドを入力すると、いろいろ聞かれるが、そのままenter
を押して進むと作成が完了する。
package.jsonについては、以下の記事をご参考に...
npm i とnpm ci の違い
package.jsonの^ (キャレット) と~ (チルダ)の違い
これでpackage.jsonを作成することができた。
{
"name": "application-study",
"version": "1.0.0",
"description": "",
"main": "index.js",
"dependencies": {
"webpack": "2.2.1",
},
"scripts": {
"build": "webpack --config webpack/webpack.config.js",
},
"repository": {
"type": "git",
"url": "git+https://github.com/aaa/bbb.git"
},
"author": "",
"license": "ISC",
"bugs": {
"url": "https://github.com/aaa/bbb/issues"
},
"homepage": "https://github.com/aaa/bbb#readme"
}
ここで注目するものがscript
とdependencies
である。
script
:これから出てくるrun
コマンドをもって実行させたいことを記録したもの
dependencies
:インストールしたpackageを記録したもの
例えば、webpack.config.js
を実行させるためには、以下のコマンドを利用する。
npm run build
npmのコマンド
基本的には公式ドキュメントを参考にすればOK。
以下はよく使うコマンドを紹介する。
package.jsonの生成
npm init
npm init -y
を入力すると、すべての設定をデフォルトにしてセッティングをすることができる。
packageをインストール
npm install package名
基本的にはローカルにインストールするが、npm install -g package名
を入力すると、グローバルにインストールができる。
簡単にnpm i package名
を入力してもOK。
オプションとしてnpm install --save package名
を入力するとdependencies
に追加され、npm install --save-dev package名
を入力するとdevDependencies
に追加される。
packageの削除
npm uninstall package名
packageのアップデート
npm update package名
packageの検索
npm search package名
packageの詳細確認
npm info package名
ローカルpackageのインストール場所(node_modulesの場所)を確認
npm root
scriptの実行
npm run script名
package.jsonのscript
のプロパティのうち、指定したscriptを実行する。
npm内のcacheの確認
npm cache
npm内のcacheの削除
npm cache clean --force
npm内の重複されたmoduleを整理
npm dedupe
npmのバージョン確認
npm -v