npmの使い方入門編

えびかずき

こんにちは、えびかずきです。

今回はnpmの使い方を簡単に説明していきます！

ちなみにnpmはnode package managerの略です。

こんな人におすすめ：
・Node.jsを使い始めたのでnpmの使い方を知りたい

1. 開発環境
2. npmの使い方
3. 試しにライブラリをインストールして使ってみよう
4. npmパッケージを探す方法
5. まとめ

開発環境

MacOS：Catalina 10.15.7

npmの使い方

ライブラリのインストール

下のコマンドでパッケージをグローバル環境にインストールできます。

$ npm -g install <package>

グローバルとローカルについて：
上記コマンドの「-g」はグローバルを意味します。
つまりどこのディレクトリにいても使えるパッケージとしてインストールするという事です。
一方「-g」を省略するとパッケージはローカルにインストールされます。
つまり今いるカレントディレクトリにインストールされるという事です。
インストール先は「node_modules」というディレクトリで、なければ勝手に作られます。

ローカルにインストールする場合の注意点：
もしカレントディレクトリの親ディレクトリにnode_modulesがある場合、そちらにインストールを実行してしまうようです。
うまくいかない時は確認してみましょう。

参考：npmのグローバルインストールとローカルインストール

インストール済みライブラリの確認

下のコマンドでインストールしたライブラリのリストが表示されます。

「-g」はインストールの時と同様にグローバルオプションです。これを省略すると、今いるディレクトリのみのローカル環境にインストールしたライブラリが表示されます。

$ npm -g ls

使い方をnpmコマンドで確認する方法

単純に「npm」だけでコマンドを実行すると、npmの使用方法が表示されます。

$ npm

下のような使用法のテキストが出力されます。

Usage: npm <command>　（使い方：npm <コマンド>）
where <command> is one of:　（<コマンド>は下記のいずれかです：）

access, adduser, bin, bugs, c, cache, completion, config
ddp, dedupe, deprecate, dist-tag, docs, doctor, edit,
explore, get, help, help-search, i, init, install,
install-test, it, link, list, ln, login, logout, ls,
outdated, owner, pack, ping, prefix, profile, prune,
publish, rb, rebuild, repo, restart, root, run, run-script,
s, se, search, set, shrinkwrap, star, stars, start, stop, t,
team, test, token, tst, un, uninstall, unpublish, unstar,
up, update, v, version, view, whoami

npm <command> -h quick help on <command>
npm -l display full usage info
npm help <term> search for help on <term>
npm help npm involved overview

Specify configs in the ini-formatted file: /Users/username/.npmrc
or on the command line via: npm <command> –key value
Config info can be viewed via: npm help config
npm@5.6.0/Users/username/.nodebrew/node/v8.9.4/lib/node_modules/npm

さらに詳しい使用法を確認するには、下記のコマンドを入力します。

それぞれのコマンドの詳しい使用法付きのテキストが出力されます。

$ npm -l

試しにライブラリをインストールして使ってみよう

適当にテスト用のディレクトリを作って、ローカルに「request」ライブラリをインストールしてみましょう。

「request」はHTTPリクエストを簡単に送れるライブラリです。

１．下記コマンドでrequestをインストール

$ npm install request

２．Javascriptのテストファイルを作成

「request_test.js」というファイルを作成し、下のコードをコピペしましょう。

内容は、requestライブラリを使ってエビワークストップページのHTMLを取得するというものです。

'use strict';                                                const request = require('request');
request('http://ebi-works.com',(error, response, body) => {
  console.log(body);
});

３．テストコードの実行

下のコマンドでテストコードを実行します。