npm 入門

時間  2019-11-30
標籤 npm 入門 简体版
原文   原文鏈接

Npm 是隨同 Nodejs 一塊兒安裝的 js 包管理工具。javascript

關鍵詞： nodejs, 包管理, npm, cnpmhtml

簡介

Npm 是隨同 Nodejs 一塊兒安裝的 js 包管理工具。前端

常見的使用場景有如下幾種：java

  • 容許用戶從 Npm 服務器下載別人編寫的第三方包到本地使用。
  • 容許用戶從 Npm 服務器下載並安裝別人編寫的命令行程序到本地使用。
  • 容許用戶將本身編寫的包或命令行程序上傳到 Npm 服務器供別人使用。

若是一個項目中存在 package.json 文件，那麼用戶能夠直接使用 npm install 命令自動安裝和維護當前項目所需的全部模塊。在 package.json 文件中，開發者能夠指定每一個依賴項的版本範圍，這樣既能夠保證模塊自動更新，又不會由於所需模塊功能大幅變化致使項目出現問題。開發者也能夠選擇將模塊固定在某個版本之上。node

安裝

因爲新版的 nodejs 已經集成了 npm，因此以前 npm 也一併安裝好了。一樣能夠經過輸入 npm -v 來測試是否成功安裝。命令以下，出現版本提示表示安裝成功:react

$ npm -v
2.3.0

能夠經過命令方式升級 npmwebpack

  • Linux - sudo npm install npm -g
  • Window - npm install npm -g

Npm 工做流

Npm 工做流：git

  1. 建立一個新項目
  2. 增長／更新／刪除依賴
  3. 安裝／重裝你的依賴
  4. 引入版本控制系統（例如 git）
  5. 持續集成

Npm 經常使用命令

每一個命令都會更新 package.json 文件。github

  • Npm 提供了不少命令，例如install和publish，使用npm help可查看全部命令。
  • 使用npm help可查看某條命令的詳細幫助，例如npm help install。
  • 在package.json所在目錄下使用npm install . -g可先在本地安裝當前命令行程序，可用於發佈前的本地測試。
  • 使用npm update能夠把當前目錄下node_modules子目錄裏邊的對應模塊更新至最新版本。
  • 使用npm update -g能夠把全局安裝的對應命令行程序更新至最新版。
  • 使用npm cache clear能夠清空 Npm 本地緩存，用於對付使用相同版本號發佈新版本代碼的人。
  • 使用npm unpublish @能夠撤銷發佈本身發佈過的某個版本代碼。

Npm 提供了不少命令，例如 install 和 publish，使用 npm help 可查看全部命令。web

初始化新項目

npm init 用於初始化項目，它會建立一個名爲 package.json 的配置文件。

命令格式

npm init [-f|--force|-y|--yes]

說明

執行命令後，npm 會問你一系列問題，而後在執行命令的目錄下建立一個package.json文件。

若是使用 -f / --force 或 -y / --yes ，npm 會使用默認值爲你建立 package.json 文件，再也不詢問任何問題。

建立模塊，package.json 文件是必不可少的。咱們可使用 Npm 生成 package.json 文件，生成的文件包含了基本的結果。

$ 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) runoob                   # 模塊名
version: (1.0.0)
description: Node.js 測試模塊(www.runoob.com)  # 描述
entry point: (index.js)
test command: make test
git repository: https://github.com/runoob/runoob.git  # Github 地址
keywords:
author:
license: (ISC)
About to write to ……/node_modules/package.json:      # 生成地址

{
  "name": "runoob",
  "version": "1.0.0",
  "description": "Node.js 測試模塊(www.runoob.com)",
  ……
}


Is this ok? (yes) yes

以上的信息，你須要根據你本身的狀況輸入。在最後輸入 "yes" 後會生成 package.json 文件。

接下來咱們可使用如下命令在 npm 資源庫中註冊用戶（使用郵箱註冊）：

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

安裝模塊

npm install 用於安裝模塊。

命令格式

npm install (with no args, in package dir)
npm install <tarball file>  # 安裝位於文件系統上的包。
npm install <tarball url>   # 獲取 url，而後安裝它。爲了區分此選項和其餘選項，參數必須以「http://」或「https://」開頭。
npm install <folder>        # 安裝位於文件系統上某文件夾中的包
npm install [<@scope>/]<name>                 # 安裝指定的包的最新版本。
npm install [<@scope>/]<name>@<tag>           # 安裝被 tag 引用的包的版本。若是 tag 不存在於該包的註冊表數據中，則失敗。
npm install [<@scope>/]<name>@<version>       # 安裝指定的包的版本。若是版本還沒有發佈到註冊表，則失敗。
npm install [<@scope>/]<name>@<version range> # 安裝與指定版本範圍相匹配的包版本。

npm install [<@scope>/] [-S|--save|-D|--save-dev|-O|--save-optional] 參數說明：

npm install 有 3 個可選參數，用於保存或更新主 package.json 中的包版本：

  • -S, --save - 包將被添加到 dependencies。
  • -D, --save-dev - 包將被添加到 devDependencies。
  • -O, --save-optional - 包將被添加到 optionalDependencies。

當使用上述任何選項將依賴保存到 package.json 時，有兩個額外的可選標誌 -

  • -E, --save-exact - 會在 package.json 文件指定安裝模塊的確切版本。
  • -B, --save-bundle - 包也將被添加到bundleDependencies。

全局安裝與本地安裝

npm 的包安裝分爲本地安裝（local）、全局安裝（global）兩種，從敲的命令行來看，差異只是有沒有-g 而已，好比

npm install express     # 本地安裝
npm install express -g  # 全局安裝
本地安裝
  1. 將安裝包放在 node_modules 下（運行 npm 命令時所在的目錄），若是沒有 node_modules 目錄，會在當前執行 npm 命令的目錄下新建 node_modules 目錄。
  2. 能夠經過 require() 來引入本地安裝的包。

示例：咱們使用 npm 命令安裝經常使用的 Node.js 的 web 框架模塊 express:

$ npm install express

安裝好以後，express 包就放在了工程目錄下的 node_modules 目錄中，所以在代碼中只須要經過 require('express') 的方式就好，無需指定第三方包路徑。

var express = require('express');
全局安裝
  1. 將安裝包放在 /usr/local 下或者你 node 的安裝目錄。
  2. 能夠直接在命令行裏使用。

若是你但願具有二者功能，則須要在兩個地方安裝它或使用 npm link。

接下來咱們使用全局方式安裝 express

$ 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)

卸載模塊

npm uninstall 用於卸載包。

命令格式

npm uninstall [<@scope>/]<pkg>[@<version>]... [-S|--save|-D|--save-dev|-O|--save-optional]

aliases: remove, rm, r, un, unlink

說明

在全局模式下（即，在命令中附加-g或--global），它將當前包上下文做爲全局包卸載。

npm uninstall 有 3 個可選參數，用於保存或更新主 package.json 中的包版本：

  • -S, --save - 包將被添加到 dependencies。
  • -D, --save-dev - 包將被添加到 devDependencies。
  • -O, --save-optional - 包將被添加到 optionalDependencies。

例：

npm uninstall sax
npm uninstall sax --save
npm uninstall @myorg/privatepackage --save
npm uninstall node-tap --save-dev
npm uninstall dtrace-provider --save-optional

更新模塊

npm update 用於更新本地安裝的模塊。

命令格式

npm update [-g] [<pkg>...]

aliases: up, upgrade

注：從 npm@2.6.1 開始，npm update 僅更新頂級包。舊版本的 npm 會遞歸檢查全部的依賴。若是要達到舊版本的行爲，請使用npm --depth 9999 update。

管理配置文件

npm config 命令用於管理配置文件。

命令格式

npm config set <key> <value> [-g|--global]  # 設置一個配置參數
npm config get <key>                        # 獲取一個配置參數
npm config delete <key>                     # 刪除一個配置參數
npm config list                             # 打印配置參數列表
npm config edit                             # 直接編輯配置文件
npm get <key>                               # npm config get <key> 的簡寫。
npm set <key> <value> [-g|--global]         # npm config set <key> <value> [-g|--global] 的簡寫

發佈包

npm publish 用於發佈一個包。

命令格式

npm publish [<tarball>|<folder>] [--tag <tag>] [--access <public|restricted>]

Publishes '.' if no argument supplied
Sets tag 'latest' if no --tag specified

說明：將包發佈到註冊表，以即可以按名稱安裝。若是沒有本地 .gitignore 或 .npmignore 文件，則包括軟件包目錄中的全部文件。若是這兩個過濾文件都存在時，某個文件被 .gitignore 忽略，而不被 .npmignore 忽略，則它將被包括。

執行腳本

npm run 用於執行腳本。

若是在 package.json 文件中的 scripts 字段定義了命令，就可使用 npm run 來執行腳本命令。

示例：

假設 package.json 文件中的 scripts 字段以下定義：

"scripts": {
    "test": "mocha",
    "lint": "eslint lib bin hot scripts",
    "prepublish": "npm run test && npm run lint",
    "start": "node index.js"
}
  • npm run test - 至關於執行 mocha 命令。它會開始執行測試框架 Mocha 。
  • npm run lint - 至關於執行 eslint lib bin hot scripts 命令。它會開始執行 eslint 檢查。
  • npm run prepublish - 至關於執行 npm run test 和 npm run lint 兩條命令。如今你瞭解如何複合命令了吧。
  • npm start - 至關於執行 node index.js 。Node.js 啓動一個服務的入口腳本。

查看安裝信息

你可使用如下命令來查看全部全局安裝的模塊：

$ npm list -g

├─┬ cnpm@4.3.2
│ ├── auto-correct@1.0.0
│ ├── bagpipe@0.3.5
│ ├── colors@1.1.2
│ ├─┬ commander@2.9.0
│ │ └── graceful-readlink@1.0.1
│ ├─┬ cross-spawn@0.2.9
│ │ └── lru-cache@2.7.3
……

若是要查看某個模塊的版本號，可使用命令以下：

$ npm list grunt

projectName@projectVersion /path/to/project/folder
└── grunt@0.4.1

配置文件

使用 npm 來管理的 javascript 項目通常都有一個package.json文件。它定義了這個項目所依賴的各類包，以及項目的配置信息（好比名稱、版本、依賴等元數據）。

package.json 中的內容就是 json 形式。

重要字段：

  • name - 包名。
  • version - 包的版本號。
  • description - 包的描述。
  • homepage - 包的官網 url 。
  • author - 包的做者姓名。
  • contributors - 包的其餘貢獻者姓名。
  • dependencies - 指定項目運行所依賴的模塊。
  • devDependencies - 指定項目開發所依賴的模塊。
  • repository - 包代碼存放的地方的類型，能夠是 git 或 svn，git 可在 Github 上。
  • main - main 字段是一個模塊 ID，它是一個指向你程序的主要項目。就是說，若是你包的名字叫 express，而後用戶安裝它，而後 require("express")。
  • keywords - 關鍵字
  • bin - 用來指定各個內部命令對應的可執行文件的位置。
  • scripts - 指定了運行腳本命令的 npm 命令行縮寫。

示例：一個完整的 package.json

{
  "name": "reactnotes",
  "version": "1.0.0",
  "description": "react 教程",
  "main": "./index.js",
  "dependencies": {
    "react": "^15.4.1",
    "react-dom": "^15.4.1"
  },
  "devDependencies": {
    "webpack-dev-server": "^1.16.2"
  },
  "scripts": {
    "start": "node index.js"
  },
  "repository": {
    "type": "git",
    "url": "git+https://github.com/atlantis1024/ReactNotes.git"
  },
  "author": "victor",
  "license": "Apache-2.0",
  "bugs": {
    "url": "https://github.com/atlantis1024/ReactNotes/issues"
  },
  "homepage": "https://github.com/atlantis1024/ReactNotes#readme"
}

package 版本

上文介紹 package.json 文件中的 dependencies 和 devDependencies 字段，這兩者都是 json 數組。它們的每一個 json 子對象，key 表示包名，value 表示版本。

npm 容許的版本聲明方式十分多樣。下面將爲你介紹一二。

說明

  • version - 安裝一個肯定的版本，遵循「大版本.次要版本.小版本」的格式規定。如：1.0.0。
  • ~version - 以 ~1.0.0 來舉例，表示安裝 1.0.x 的最新版本（不低於 1.0.0）。可是大版本號和次要版本號不能變。
  • ^version - 以 ^1.0.0 來舉例，表示安裝 1.x.x 的最新版本（不低於 1.0.0），可是大版本號不能變。
  • 1.2.x - 表示安裝 1.2.x。
  • >、>=、<、<= - 能夠像數組比較同樣，使用比較符來限定版本範圍。
  • version1 - version2 - 至關於 >=version1 <=version2.
  • range1 || range2 - 版本知足 range1 或 range2 兩個限定條件中任意一個便可。
  • tag - 一個指定 tag 對應的版本。
  • * 或 "" (空字符串)：任意版本。
  • latest - 最新版本。
  • http://... 或 file://... - 你能夠指定 http 或本地文件路徑下的包做爲版本。
  • git... - 參考下面的「直接將 Git Url 做爲依賴包版本」
  • user/repo - 參考下面的「直接將 Git Url 做爲依賴包版本」

例：下面的版本聲明都是有效的

{
  "dependencies": {
    "foo": "1.0.0 - 2.9999.9999",
    "bar": ">=1.0.2 <2.1.2",
    "baz": ">1.0.2 <=2.3.4",
    "boo": "2.0.1",
    "qux": "<1.0.0 || >=2.3.1 <2.4.5 || >=2.5.2 <3.0.0",
    "asd": "http://asdf.com/asdf.tar.gz",
    "til": "~1.2",
    "elf": "~1.2.3",
    "two": "2.x",
    "thr": "3.3.x",
    "lat": "latest",
    "dyl": "file:../dyl"
  }
}

直接將 Git Url 做爲依賴包版本

Git Url 形式能夠以下：

git://github.com/user/project.git#commit-ish
git+ssh://user@hostname:project.git#commit-ish
git+ssh://user@hostname/project.git#commit-ish
git+http://user@hostname/project/blah.git#commit-ish
git+https://user@hostname/project/blah.git#commit-ish

版本號

使用 Npm 下載和發佈代碼時都會接觸到版本號。Npm 使用語義版本號來管理代碼，這裏簡單介紹一下。

語義版本號分爲 X.Y.Z 三位，分別表明主版本號、次版本號和補丁版本號。當代碼變動時，版本號按如下原則更新。

  • 若是隻是修復 bug，須要更新 Z 位。
  • 若是是新增了功能，可是向下兼容，須要更新 Y 位。
  • 若是有大變更，向下不兼容，須要更新 X 位。

版本號有了這個保證後，在申明第三方包依賴時，除了可依賴於一個固定版本號外，還可依賴於某個範圍的版本號。例如"argv": "0.0.x"表示依賴於 0.0.x 系列的最新版 argv。

Npm 支持的全部版本號範圍指定方式能夠查看官方文檔。

npm 擴展

cnpm

你們都知道國內直接使用 npm 的官方鏡像是很是慢的，這裏推薦使用淘寶 NPM 鏡像。

淘寶 NPM 鏡像是一個完整 npmjs.org 鏡像，你能夠用此代替官方版本(只讀)，同步頻率目前爲 10 分鐘 一次以保證儘可能與官方服務同步。

你可使用淘寶定製的 cnpm (gzip 壓縮支持) 命令行工具代替默認的 npm:

$ npm install -g cnpm --registry=https://registry.npm.taobao.org

這樣就可使用 cnpm 命令來安裝模塊了：

$ cnpm install [name]

更多信息能夠查閱：http://npm.taobao.org/。

nrm

Nrm 是 NPM 註冊服務器管理工具，能夠快速切換不一樣的註冊表：npm，cnpm，nj，taobao，或者是你本身的私服。

安裝 nrm

npm install -g nrm

查看可用服務器

# 查看可用服務器
$ nrm ls

* npm -----  https://registry.npmjs.org/
  cnpm ----  http://r.cnpmjs.org/
  taobao --  https://registry.npm.taobao.org/
  nj ------  https://registry.nodejitsu.com/
  rednpm -- http://registry.mirror.cqupt.edu.cn
  skimdb -- https://skimdb.npmjs.com/registry

# 切換服務器
$ nrm use tabao

nrm 命令語義

Usage: nrm [options] [command]

  Commands:

    ls                           List all the registries
    use <registry>               Change registry to registry
    add <registry> <url> [home]  Add one custom registry
    del <registry>               Delete one custom registry
    home <registry> [browser]    Open the homepage of registry with optional browser
    test [registry]              Show the response time for one or all registries
    help                         Print this help

  Options:

    -h, --help     output usage information
    -V, --version  output the version number

引用和引伸

👉 歡迎閱讀 個人前端技術教程系列：frontend-tutorial

相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程