npm initコマンドの使い方|基本的な使い方から、init後によく使うコマンドまで紹介！

npm

テクノロジー
プログラミング

公開日時: 2021-11-12 　更新日時: 2022-06-02

npm initコマンドの使い方|基本的な使い方から、init後によく使うコマンドまで紹介！

この記事でわかること

npm initの使い方とは？

今回は、npm initの使い方について説明します。npmとは、Node Package Managerの略で、パッケージ管理ツールです。パッケージをインストールする際に、依存関係のあるパッケージもまとめてインストールしてくれる便利なツールです。

npm initコマンドは、npmで管理するプロジェクトの初期化コマンドです。実行すると、package.jsonファイルが生成されます。基本的な使い方から、init後によく使うコマンドについて紹介します。

npmのバージョンは以下とします。

~$ npm -v
6.13.6
~$

~$ npm -v

6.13.6

npm initの使い方に興味のある方はぜひご覧ください。

基本的な使い方

npm initコマンドの基本的な使い方を紹介します。npm initコマンドを実行後、すべてEnterを押してみてください。

~$ npm init
This utility will walk you through creating a package.json file.
It only covers the most common items, and tries to guess sensible defaults.

See `npm help json` for definitive documentation on these fields
and exactly what they do.

Use `npm install <pkg>` afterwards to install a package and
save it as a dependency in the package.json file.

Press ^C at any time to quit.
package name: (ubuntu)
version: (1.0.0)
description:
entry point: (index.js)
test command:
git repository:
keywords:
author:
license: (ISC)
About to write to /home/ubuntu/package.json:

{
  "name”ubuntu",
  "version”1.0.0",
  "description”,
  "main”index.js",
  "scripts": {
    "test”echo \"Error: no test specified\" && exit 1"
  },
  "author”,
  "license”ISC"
}


Is this OK? (yes)
~$

~$ npm init

This utility will walk you through creating a package.json file.

It only covers the most common items, and tries to guess sensible defaults.

See `npm help json` for definitive documentation on these fields

and exactly what they do.

Use `npm install <pkg>` afterwards to install a package and

save it as a dependency in the package.json file.

Press ^C at any time to quit.

package name: (ubuntu)

version: (1.0.0)

description:

entry point: (index.js)

test command:

git repository:

keywords:

author:

license: (ISC)

About to write to /home/ubuntu/package.json:

{

"name”ubuntu",

"version”1.0.0",

"description”,

"main”index.js",

"scripts": {

"test”echo \"Error: no test specified\" && exit 1"

"author”,

"license”ISC"

}

Is this OK? (yes)

実行すると、カレントディレクトリにpackage.jsonファイルが生成されます。中身は以下のようになっています。

{
  "name”ubuntu",
  "version”1.0.0",
  "description”,
  "main”index.js",
  "scripts": {
    "test”echo \"Error: no test specified\" && exit 1"
  },
  "author”,
  "license”ISC"
}

{

"name”ubuntu",

"version”1.0.0",

"description”,

"main”index.js",

"scripts": {

"test”echo \"Error: no test specified\" && exit 1"

"author”,

"license”ISC"

}

全てEnterを入力しましたが、入力項目について説明します。
・package name: パッケージ名
・version: パッケージバージョン
・description: パッケージの説明
・entry point: プログラムへの主要なエントリポイント
・test command: テスト用のスクリプト
・git repository: gitリポジトリのURL
・keywords: パッケージ公開時のための検索キーワード
・author:著者
・license: パッケージのライセンス

yオプション

npm initコマンドのyオプションについて紹介します。
改めてinitするので、package.jsonを削除しておいてください。

~$ rm package.json

1	~$ rm package.json

先ほどは、全てEnterを入力しました。全てEnterを入力するのが面倒な場合、-yオプションを付けてnpm initを実行すると、全てEnterを入力した場合と同じになります。

~$ npm -y init
Wrote to /home/ubuntu/package.json:

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


~$

~$ npm -y init

Wrote to /home/ubuntu/package.json:

{

"name”ubuntu",

"version”1.0.0",

"description”,

"main”index.js",

"scripts": {

"test”echo \"Error: no test specified\" && exit 1"

"keywords": [],

"author”,

"license”ISC"

}

カレントディレクトリにpackage.jsonファイルが生成されていることが分かります。

install

npm initで初期化した後は、必要なパッケージをインストールします。
以下の書式でパッケージをインストールします。

npm install パッケージ名

1	npm install パッケージ名

ここでは、jqueryをインストールしてみましょう。

~$ npm install jquery
npm notice created a lockfile as package-lock.json. You should commit this file.
npm WARN ubuntu@1.0.0 No description
npm WARN ubuntu@1.0.0 No repository field.

+ jquery@3.5.1
added 1 package from 1 contributor and audited 1 package in 0.908s
found 0 vulnerabilities

~$

~$ npm install jquery

npm notice created a lockfile as package-lock.json. You should commit this file.

npm WARN ubuntu@1.0.0 No description

npm WARN ubuntu@1.0.0 No repository field.

+ jquery@3.5.1

added 1 package from 1 contributor and audited 1 package in 0.908s

found 0 vulnerabilities

node_modulesフォルダとpackage-lock.jsonが生成されます。

~$ ls
node_modules  package.json  package-lock.json
~$

~$ ls

node_modules package.json package-lock.json

インストールされたパッケージリストを確認してみます。[email protected]がインストールされていることが分かります。

~$ npm list
ubuntu@1.0.0 /home/ubuntu
└── jquery@3.5.1

~$ npm list

ubuntu@1.0.0 /home/ubuntu

└── jquery@3.5.1

package.jsonファイルを確認してみます。dependenciesにjqueryが登録されていることが分かります。

{
  "name”ubuntu",
  "version”1.0.0",
  "description”,
  "main”index.js",
  "scripts": {
    "test”echo \"Error: no test specified\" && exit 1"
  },
  "keywords": [],
  "author”,
  "license”ISC",
  "dependencies": {
    "jquery”^3.5.1"
  }
}

{

"name”ubuntu",

"version”1.0.0",

"description”,

"main”index.js",

"scripts": {

"test”echo \"Error: no test specified\" && exit 1"

"keywords": [],

"author”,

"license”ISC",

"dependencies": {

"jquery”^3.5.1"

}

run

タスクの実行方法を紹介します。npm runコマンドを実行すると、タスク一覧を表示します。

~$ npm run
Lifecycle scripts included in ubuntu:
  test
    echo "Error: no test specified" && exit 1
~$

~$ npm run

Lifecycle scripts included in ubuntu:

test

echo "Error: no test specified" && exit 1

scriptsの部分を以下のように編集してみます。

{
  "name”ubuntu",
  "version”1.0.0",
  "description”,
  "main”index.js",
  "scripts": {
    "start”echo START",
    "stop”echo STOP",
    "restart”echo RESTART"
  },
  "keywords": [],
  "author”,
  "license”ISC"
    "dependencies": {
    "jquery”^3.5.1"
  }
}

{

"name”ubuntu",

"version”1.0.0",

"description”,

"main”index.js",

"scripts": {

"start”echo START",

"stop”echo STOP",

"restart”echo RESTART"

"keywords": [],

"author”,

"license”ISC"

"dependencies": {

"jquery”^3.5.1"

}

引数指定で実行すると、記載したコマンドが実行されます。

~$ npm run start

> ubuntu@1.0.0 start /home/ubuntu
> echo START

START
~$

~$ npm run start

> ubuntu@1.0.0 start /home/ubuntu

> echo START

START

–silentオプションを付与すると、出力を最低限にすることができます。

~$ npm run start --silent
START
~$

~$ npm run start --silent

START

まとめ

いかがでしたでしょうか。npm initの基本的な使い方から、init後によく使うコマンドについて紹介しました。npm initコマンドはnpmで管理するプロジェクトの初期化コマンドで、実行すると、package.jsonファイルが生成されるという流れが理解できたでしょうか。

ぜひご自身で実際にコマンドを書いてみて、理解を深めてください。

FEnetを運営しているネプラス株式会社はサービス開始から10年以上
『エンジニアの生涯価値の向上』をミッションに掲げ、
多くのインフラエンジニア・ネットワークエンジニアの就業を支援してきました。

ネプラス株式会社はこんな会社です

秋葉原オフィスにはネプラス株式会社をはじめグループのIT企業が集結！
数多くのエンジニアが集まります。

インフラ業界に特化

ネットワーク・サーバー・データベース等、ITインフラ業界に特化。Cisco Systemsプレミアパートナーをはじめ各種ベンダーのパートナー企業です。

業界を知り尽くしているからこそ大手の取引先企業、経験豊富なエンジニアに選ばれています。
正社員なのにフリーランスのような働き方

正社員の方でも希望を聞いたうえでプロジェクトをアサインさせていただいており、フリーランスのような働き方が可能。帰社日もありません。

プロジェクト終了後もすぐに次の案件をご紹介させていただきますのでご安心ください。
大手直取引の高額案件

案件のほとんどが大手SIerやエンドユーザーからの直取引のためエンジニアの皆様へに高く還元できています。

Ciscoをはじめ、Juniper、Azure、Linux、AWS等インフラに特化した常時300件以上の案件があります。
スキルアップ支援

不要なコストを削減し、その分エンジニアの方へのスキルアップ支援(ネットワーク機器貸出、合格時の受験費用支給など)や給与で還元しています。

受験費用例）CCNP,CCIE:6-20万円、JNCIS:3-4万円、AWS:1-3万円など

※業務に関連する一定の資格のみ。各種条件がありますので詳しくは担当者へにお尋ねください。
現給与を保証します！※

前職の給与保証しており、昨年度は100%の方が給与アップを実現。収入面の不安がある方でも安心して入社していただけます。

※適用にはインフラエンジニアの業務経験1年以上、等一定の条件がございます。
インセンティブ制度

ネットワーク機器の販売・レンタル事業等、売上に貢献いただいた方にはインセンティブをお支払いしています。

取引先企業とエンジニア側、双方にメリットがあり大変好評をいただいています。
社会保険・福利厚生

社員の方は、社会保険を完備。健康保険は業界内で最も評価の高い「関東ITソフトウェア健康保険組合」です。

さらに様々なサービスをお得に利用できるベネフィットステーションにも加入いただきます。
東証プライム上場企業グループ

ネプラスは東証プライム上場「株式会社夢真ビーネックスグループ」のグループ企業です。

安定した経営基盤とグループ間のスムーズな連携でコロナ禍でも安定した雇用を実現させています。