NPM の使用の概要


NPM は、NodeJS と一緒にインストールされるパッケージ管理ツールで、NodeJS コードのデプロイメントにおける多くの問題を解決できます。

  • ユーザーが他の人によって作成されたサードパーティのパッケージを NPM サーバーからダウンロードできるようにします。彼らのローカルエリアでの使用。

  • ユーザーがローカルで使用するために、他の人が作成したコマンド ライン プログラムを NPM サーバーからダウンロードしてインストールできるようにします。

  • ユーザーが作成したパッケージまたはコマンド ライン プログラムを、他のユーザーが使用できるように NPM サーバーにアップロードできるようにします。

新しいバージョンのnodejsにはnpmが統合されているため、以前のnpmもインストールされています。 "npm -v" と入力して、インストールが成功したかどうかをテストすることもできます。コマンドは次のとおりです。バージョン プロンプトが表示されたら、インストールは成功です。

$ npm -v
2.3.0

npm の古いバージョンをインストールしている場合は、npm コマンドを使用して簡単にアップグレードできます。 Windows システムの場合は、次のコマンドを使用します:

$ sudo npm install npm -g
/usr/local/bin/npm -> /usr/local/lib/node_modules/npm/bin/npm-cli.js
npm@2.14.2 /usr/local/lib/node_modules/npm

npm コマンドを使用してモジュールをインストールします

npm Node.js モジュールをインストールする構文形式は次のとおりです:

npm install npm -g

次の例では、一般的に使用される Node.js Web フレームワーク モジュールをインストールするための npm コマンド

express

:

$ npm install <Module Name>
インストール後、Express パッケージはプロジェクト ディレクトリの下の node_modules ディレクトリに配置されるため、使用する必要があるのは

require('express' )

をコード内でサードパーティのパッケージのパスを指定せずに使用します。

$ npm install express

グローバルインストールとローカルインストール

npmパッケージのインストールは、ローカルインストール(local)とグローバルインストール(global)の2種類に分かれますが、コマンドラインから判断すると、-gの有無だけが違います。

var express = require('express');

次のエラーが発生した場合:

npm install express          # 本地安装
npm install express -g   # 全局安装

解決策は次のとおりです:

npm err! Error: connect ECONNREFUSED 127.0.0.1:8087

ローカルインストール

    1. インストールパッケージを ./node_modules (npm コマンドを実行するディレクトリ) に配置します。 node_modulesディレクトリは、現在npmコマンドを実行しているディレクトリに生成されます。
  • 2. ローカルにインストールされたパッケージは、require() を通じて導入できます。
  • グローバルインストール

    1. インストールパッケージを /usr/local またはノードのインストールディレクトリに配置します。
  • 2. コマンドラインで直接使用できます。
  • 両方の機能が必要な場合は、両方の場所にインストールするか、
npm リンク

を使用する必要があります。 次に、グローバルメソッドを使用して、express

$ npm config set proxy null

をインストールします。インストールプロセスでは、次の内容が出力されます。最初の行は、モジュールのバージョン番号とインストール場所を出力します。

$ npm install express -g

次のコマンドを使用して、グローバルにインストールされているすべてのモジュールを表示できます:

express@4.13.3 node_modules/express
├── escape-html@1.0.2
├── range-parser@1.0.2
├── merge-descriptors@1.0.0
├── array-flatten@1.1.1
├── cookie@0.1.3
├── utils-merge@1.0.0
├── parseurl@1.3.0
├── cookie-signature@1.0.6
├── methods@1.1.1
├── fresh@0.3.0
├── vary@1.0.1
├── path-to-regexp@0.1.7
├── content-type@1.0.1
├── etag@1.7.0
├── serve-static@1.10.0
├── content-disposition@0.5.0
├── depd@1.0.1
├── qs@4.0.0
├── finalhandler@0.4.0 (unpipe@1.0.0)
├── on-finished@2.3.0 (ee-first@1.1.1)
├── proxy-addr@1.0.8 (forwarded@0.1.0, ipaddr.js@1.0.1)
├── debug@2.2.0 (ms@0.7.1)
├── type-is@1.6.8 (media-typer@0.3.0, mime-types@2.1.6)
├── accepts@1.2.12 (negotiator@0.5.3, mime-types@2.1.6)
└── send@0.13.0 (destroy@1.0.3, statuses@1.2.1, ms@0.7.1, mime@1.3.4, http-errors@1.3.1)

package.json を使用します

package.json はモジュールのディレクトリにあり、パッケージのプロパティを定義するために使用されます。次に、node_modules/express/package.json にある Express パッケージの package.json ファイルを見てみましょう。 内容:

$ npm ls -g

Package.json プロパティの説明

  • name

    - パッケージ名。

  • version

    - パッケージのバージョン番号。

  • description

    - パッケージの説明。

  • homepage

    - パッケージの公式 Web サイトの URL。

  • author - パッケージの作成者の名前。

  • contributors - パッケージへの他の貢献者の名前。

  • dependency - 依存関係パッケージのリスト。依存パッケージがインストールされていない場合、npm は依存パッケージを node_module ディレクトリに自動的にインストールします。

  • リポジトリ - パッケージ コードが保存される場所のタイプ。git または svn にすることができます。git は Github 上に置くこともできます。

  • main - main フィールドはモジュール ID で、プログラムのメイン プロジェクトへのポインタです。つまり、パッケージの名前が Express で、ユーザーがそれをインストールする場合は、require("express") になります。

  • キーワード - キーワード


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

次のコマンドを使用して、Node.js モジュールをアンインストールできます。

{
  "name": "express",
  "description": "Fast, unopinionated, minimalist web framework",
  "version": "4.13.3",
  "author": {
    "name": "TJ Holowaychuk",
    "email": "tj@vision-media.ca"
  },
  "contributors": [
    {
      "name": "Aaron Heckmann",
      "email": "aaron.heckmann+github@gmail.com"
    },
    {
      "name": "Ciaran Jessup",
      "email": "ciaranj@gmail.com"
    },
    {
      "name": "Douglas Christopher Wilson",
      "email": "doug@somethingdoug.com"
    },
    {
      "name": "Guillermo Rauch",
      "email": "rauchg@gmail.com"
    },
    {
      "name": "Jonathan Ong",
      "email": "me@jongleberry.com"
    },
    {
      "name": "Roman Shtylman",
      "email": "shtylman+expressjs@gmail.com"
    },
    {
      "name": "Young Jae Sim",
      "email": "hanul@hanul.me"
    }
  ],
  "license": "MIT",
  "repository": {
    "type": "git",
    "url": "git+https://github.com/strongloop/express.git"
  },
  "homepage": "http://expressjs.com/",
  "keywords": [
    "express",
    "framework",
    "sinatra",
    "web",
    "rest",
    "restful",
    "router",
    "app",
    "api"
  ],
  "dependencies": {
    "accepts": "~1.2.12",
    "array-flatten": "1.1.1",
    "content-disposition": "0.5.0",
    "content-type": "~1.0.1",
    "cookie": "0.1.3",
    "cookie-signature": "1.0.6",
    "debug": "~2.2.0",
    "depd": "~1.0.1",
    "escape-html": "1.0.2",
    "etag": "~1.7.0",
    "finalhandler": "0.4.0",
    "fresh": "0.3.0",
    "merge-descriptors": "1.0.0",
    "methods": "~1.1.1",
    "on-finished": "~2.3.0",
    "parseurl": "~1.3.0",
    "path-to-regexp": "0.1.7",
    "proxy-addr": "~1.0.8",
    "qs": "4.0.0",
    "range-parser": "~1.0.2",
    "send": "0.13.0",
    "serve-static": "~1.10.0",
    "type-is": "~1.6.6",
    "utils-merge": "1.0.0",
    "vary": "~1.0.1"
  },
  "devDependencies": {
    "after": "0.8.1",
    "ejs": "2.3.3",
    "istanbul": "0.3.17",
    "marked": "0.3.5",
    "mocha": "2.2.5",
    "should": "7.0.2",
    "supertest": "1.0.1",
    "body-parser": "~1.13.3",
    "connect-redis": "~2.4.1",
    "cookie-parser": "~1.3.5",
    "cookie-session": "~1.2.0",
    "express-session": "~1.11.3",
    "jade": "~1.11.0",
    "method-override": "~2.3.5",
    "morgan": "~1.6.1",
    "multiparty": "~4.1.2",
    "vhost": "~3.0.1"
  },
  "engines": {
    "node": ">= 0.10.0"
  },
  "files": [
    "LICENSE",
    "History.md",
    "Readme.md",
    "index.js",
    "lib/"
  ],
  "scripts": {
    "test": "mocha --require test/support/env --reporter spec --bail --check-leaks test/ test/acceptance/",
    "test-ci": "istanbul cover node_modules/mocha/bin/_mocha --report lcovonly -- --require test/support/env --reporter spec --check-leaks test/ test/acceptance/",
    "test-cov": "istanbul cover node_modules/mocha/bin/_mocha -- --require test/support/env --reporter dot --check-leaks test/ test/acceptance/",
    "test-tap": "mocha --require test/support/env --reporter tap --check-leaks test/ test/acceptance/"
  },
  "gitHead": "ef7ad681b245fba023843ce94f6bcb8e275bbb8e",
  "bugs": {
    "url": "https://github.com/strongloop/express/issues"
  },
  "_id": "express@4.13.3",
  "_shasum": "ddb2f1fb4502bf33598d2b032b037960ca6c80a3",
  "_from": "express@*",
  "_npmVersion": "1.4.28",
  "_npmUser": {
    "name": "dougwilson",
    "email": "doug@somethingdoug.com"
  },
  "maintainers": [
    {
      "name": "tjholowaychuk",
      "email": "tj@vision-media.ca"
    },
    {
      "name": "jongleberry",
      "email": "jonathanrichardong@gmail.com"
    },
    {
      "name": "dougwilson",
      "email": "doug@somethingdoug.com"
    },
    {
      "name": "rfeng",
      "email": "enjoyjava@gmail.com"
    },
    {
      "name": "aredridel",
      "email": "aredridel@dinhe.net"
    },
    {
      "name": "strongloop",
      "email": "callback@strongloop.com"
    },
    {
      "name": "defunctzombie",
      "email": "shtylman@gmail.com"
    }
  ],
  "dist": {
    "shasum": "ddb2f1fb4502bf33598d2b032b037960ca6c80a3",
    "tarball": "http://registry.npmjs.org/express/-/express-4.13.3.tgz"
  },
  "directories": {},
  "_resolved": "https://registry.npmjs.org/express/-/express-4.13.3.tgz",
  "readme": "ERROR: No README data found!"
}


アンインストール後、/node_modules/ ディレクトリに移動してパッケージがまだ存在するかどうかを確認するか、次のコマンドを使用して確認できます:

$ npm uninstall express

モジュールを更新します

次のコマンドを使用して更新できますモジュール:

$ npm ls

モジュールを検索

以下を使用してモジュールを検索:

$ npm update express

モジュールを作成する

モジュールを作成するには、package.json ファイルが必須です。 NPM を使用して package.json ファイルを生成でき、生成されたファイルには基本的な結果が含まれます。

$ npm search express

上記の情報はご自身の状況に応じて入力する必要があります。最後に「yes」を入力すると、package.json ファイルが生成されます。

次に、次のコマンドを使用して npm リポジトリにユーザーを登録します (登録には電子メールを使用します):

$ 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> --save` afterwards to install a package and
save it as a dependency in the package.json file.

Press ^C at any time to quit.
name: (node_modules) php                   # 模块名
version: (1.0.0) 
description: Node.js 测试模块(www.php.cn)  # 描述
entry point: (index.js) 
test command: make test
git repository: https://github.com/php/php.git  # Github 地址
keywords: 
author: 
license: (ISC) 
About to write to ……/node_modules/package.json:      # 生成地址

{
  "name": "php",
  "version": "1.0.0",
  "description": "Node.js 测试模块(www.php.cn)",
  ……
}


Is this ok? (yes) yes

次に、次のコマンドを使用してモジュールを公開します:

$ npm adduser
Username: mcmohd
Password:
Email: (this IS public) mcmohd@gmail.com

上記の手順を正しく実行した場合、他のモジュールと同様に npm を使用してインストールできます。


バージョン番号

NPM を使用してコードをダウンロードして公開するときに、バージョン番号を知ることになります。 NPM はセマンティック バージョン番号を使用してコードを管理します。ここで簡単に説明します。

セマンティック バージョン番号は、X.Y.Z の 3 桁に分かれており、それぞれメジャー バージョン番号、マイナー バージョン番号、パッチ バージョン番号を表します。コードが変更されると、次の原則に従ってバージョン番号が更新されます。

  • バグを修正するだけの場合は、Z ビットを更新する必要があります。

  • 新しい機能が追加されても下位互換性がある場合は、Y ビットを更新する必要があります。

  • 大きな変更がある場合、下位互換性がなくなり、X ビットを更新する必要があります。

このバージョン番号の保証により、サードパーティのパッケージの依存関係を宣言するときに、固定のバージョン番号に依存することに加えて、特定の範囲のバージョン番号にも依存することができます。たとえば、「argv」: 「0.0.x」は、0.0.x シリーズの argv の最新バージョンに依存することを意味します。

NPM でサポートされているすべてのバージョン番号範囲指定方法は、公式ドキュメントで参照できます。


NPM 共通コマンド

この章で紹介した部分に加えて、NPM は多くの機能も提供しており、package.json には他にも多くの便利なフィールドがあります。

npmjs.org/doc/ で公式ドキュメントを参照することに加えて、ここでは一般的な NPM コマンドをいくつか紹介します。

NPM には、インストールやパブリッシュなどの多くのコマンドが用意されています。すべてのコマンドを表示するには、npm help を使用します。

  • NPM には、installpublish などの多くのコマンドが用意されており、すべてのコマンドを表示するには npm help を使用します。 installpublish,使用npm help可查看所有命令。

  • 使用npm help <command>可查看某条命令的详细帮助,例如npm help install

  • package.json所在目录下使用npm install . -g可先在本地安装当前命令行程序,可用于发布前的本地测试。

  • 使用npm update <package>可以把当前目录下node_modules子目录里边的对应模块更新至最新版本。

  • 使用npm update <package> -g可以把全局安装的对应命令行程序更新至最新版。

  • 使用npm cache clear可以清空NPM本地缓存,用于对付使用相同版本号发布新版本代码的人。

  • 使用npm unpublish <package>@<version>

npm help <command> を使用して、npm help install などのコマンドの詳細なヘルプを表示します。
🎜🎜🎜 package.json が配置されているディレクトリで npm install . -g を使用して、最初に現在のコマンド ライン プログラムをローカルにインストールします。これはローカル テストに使用できます。発売前に。 🎜🎜🎜🎜npm update <package> を使用して、現在のディレクトリの node_modules サブディレクトリにある対応するモジュールを最新バージョンに更新します。 🎜🎜🎜🎜 npm update <package> -g を使用して、グローバルにインストールされている対応するコマンド ライン プログラムを最新バージョンに更新します。 🎜🎜🎜🎜NPM ローカル キャッシュをクリアするには、npm queue clear を使用します。これは、コードの新しいバージョンをリリースするために同じバージョン番号を使用するユーザーに対処するために使用されます。 🎜🎜🎜🎜公開したコードのバージョンを非公開にするには、npm unpublish <package>@<version> を使用します。 🎜🎜🎜🎜