【Node.js】npmとは？npmの使い方からnpmコマンド一覧紹介

2023年1月31日Node

node.js
ミニマリスト_カミ

みなさんこんにちは！
カミ@god48_です。

みなさんnpmの知識はありますか？
この記事はNode.jsで使うnpmについて聞いたことはあるけど、いまいちnpmコマンドについてよく分かってない方や、npmとyarnの違いについての全く知識がない方へnpmについての紹介です。

この記事でわかること

この記事を最後まで読めば「npm」の理解が深まりますので、最後まで読んで「npmコマンド」についてマスターしましょう。

それでは順に見ていきましょう。

npmとは

読み方はnpmは「エヌピーエム」と読みます。

Node Package Managerの省略で、Node.jsのパッケージモジュールを管理するシステムです。

https://god48.com/node-npm

npmでNodeの管理するpackageにフレームワークやライブラリなどのモジュールが管理されています。

Nodeとnpm関係

icon

Nodeとnpmの関係を説明します。

Nodeは先ほど説明した、npmによってライブラリやモジュールをpackage.jsonによって管理されています。

スポンサードサーチ

npmコマンドを使用できるようにする

npmを使用できるには準備は必要です。

  • homebrewをインストール
  • nodebrewをインストール

homebrewをインストール

まずはhomebrewをインストールしてください。

※別途homebrewのインストールの紹介します。

nodebrewをインストール

次にnodebrewにインストールしてください。

※別途nodebrewのインストールの紹介します。

nodebrewをインストールできればnpmコマンドが使えます。

npmのバージョン確認

npmが使用できるようになればコマンドを叩けば、npmのバージョンが返ってきます。

npm -v
npm -version

スポンサードサーチ

package.jsonの生成方法

npmのモジュールを使うには、まずはnpmコマンドでpackage.jsonを生成します。

npm -init

コマンドをたたくと、プロジェクト名などの質問に対して答えていくとpackage.jsonが作成される。
質問項目される項目は次のとおり

package name:
version: 
description:
entry point: 
test command:
git repository:
keywords:
author:
license:

package.jsonをとにかく生成して後から設定したい場合は次のコマンドを叩いてください。

npm init -y

package.jsonを確認すると、生成されているので確認してみましょう。

package.jsonとは

package.jsonとは

先ほど、npm initで生成したpackage.jsonの中身を確認してみます

{
  "name": "<current directory name>",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "keywords": [],
  "author": "",
  "license": "ISC"
}

Node.js で開発する場合、アプリケーションに対して実行するbuildやテストなどのコマンドで管理するファイルがあります。
package.json ファイルに実行コマンドを記述をして、コマンドプロンプトやターミナルでnpmコマンドを叩くことでpackage.json内の該当の命令が呼ばれて実行されます。

スポンサードサーチ

package.jsonの構文について

  • name：nameではモジュール名です。importやrequireでモジュールの読み込みで利用できます。
  • version：モジュールのバージョン名です。アプリの公開時のに使用できます。
  • description:：モジュールの説明です。
  • main：モジュール内で最初に呼ばれるスクリプトファイルです。
  • scripts：shell scriptを実行できます。エイリアスコマンドの定義できます。
  • keywords：パッケージマネージャ内でパッケージを探す時に使います。
  • author:：作成者のnameと任意でurlとemail記載します。
  • license:：ライセンス情報です。

詳しいpackage.jsonの説明の参考にしてみてください。

npmコマンド

ようやく本題のnpmコマンドについて紹介します。

npmコマンドには省略コマンドなど共通に使われるコマンドがあります。
まずはそのコマンドをサラッとでいいので理解して、よく使うコマンドを見ていきましょう。

共有のオプションコマンド

yesコマンド

-yes
-y

installコマンド

install
i
ci

グローバルコマンド

--global モジュール名
-g モジュール名

saveコマンド

--save モジュール名
-save モジュール名
-s モジュール名

devコマンド

--save-dev モジュール名

よく使うnpmコマンド

npmのバージョン

npm -version
npm -v

npmのバージョンを確認することができます。

package.jsonの生成

npm init -yes
npm init -y

package.jsonのとりあえず生成して、
後から自分で記述していく方法での生成スタイルです。

モジュールのインストール

npm install
npm i

package.jsonに記述している内容をインストールするコマンドです。

クリーンインストール

npm ci

package.json と package-lock.jsonを更新することができます。
package.jsonとpackage.json-lock.jsonを更新せずにnode_modulesを元に記述していモジュールを使用できます。

npm ci(npm clean install)を使うことをおすすめします

モジュールのインストール

npm install モジュール名
npm i モジュール名

モジュールをインストールできます。
node_modulesとpackage.json内の「dependencies」と「devDependencies」に記述されます。

グローバル

npm install --global モジュール名
npm install -g モジュール名

save

npm install --save モジュール名
npm install -save モジュール名
npm install -s モジュール名

package.json 「dependencies」に記述されます。
以前まではnpmのバージョンによってsaveオプションをつけなければいけませんでしたが、現在はsaveオプションを指定しなくても、「dependencies」に記述されます。

save-dev

npm install --save-dev モジュール名

package.jsonの「devDependencies」に記述されます。
「devDependencies」は開発用の記述で本番へにはアップしません。

アンインストール

npm uninstall パッケージ名
npm un パッケージ名

npm rm パッケージ名
npm r パッケージ名

npm remove パッケージ名
npm unlink パッケージ名

実装やエラーが解決できない場合

プログラミングの実装やエラーでどうしてもわからない場合はメンターに相談するのが一番です。

考えている、見えている範囲が狭くなり、解決から遠くに行って何時間も、何日も経っていることなんてよくある話です。

そういう時は聞ける先輩や、メンターに相談することが大事です。

僕にも相談可能なので気軽に相談してください。

Twitterからの連絡だと確実ですよ。

オンラインスクールやプログラミングスクールといったプログラミングを学べる方法もあるので、そちらもぜひ活用してもいいと思います。

Web開発で分からない時

オンライン完結型スクール DMM WEBCAMP PRO

アプリ開発で分からない時

プログラミング×稼げる副業スキルはテックキャンプ

プログラミングについて分からない時

【コエテコ様限定】※ご案内を受けた以外のメディアが使用しても成果は承認されません。
ミニマリスト_カミ

僕への個人でもメンターでも、スクールでもお好きな方を活用ください。

NodeNode.js,npm

Posted by kami