npm使用入門

NPM是什么

npm

npm makes it easy for JavaScript developers to share and reuse code, and it makes it easy to update the code that you're sharing.

簡單來說,npm就是javascript的包管理工具,類似java語法當中的maven, gradle, python的pip。

安裝

npm是和Node.js一起發布的,只要安裝了Node.js,npm也安裝好了,可以從Node.js的下載頁下載對應操作系統的安裝包安裝即可。 安裝好后,執行如下命令,檢查是否安裝成功。

$ node -v
v6.10.0

$ npm -v
4.4.1

但是由于npm自身的更新頻率比Node.js高很多,所以通過上面的命令安裝的npm可能不是最新版本,可以通過下面的命令單獨更新npm

$ npm install npm@latest -g

安裝包

執行命令

$ npm install <package_name>

便可以安裝對應的包到執行命令的當前目錄,并創建一個node_modules的文件夾,然后把需要安裝的安裝包下載到里面。

使用package.json

通過上面的命令,直接安裝的包默認都是最新版本的。但是在項目中,我們怎么讓一起開發的同事知道項目中用了哪些包,具體包的版本信息呢?這時package.json就上場了,可以把它想成是java語言中的pom.xml,
python語言中的requirements.txt

一個基本的package.json文件至少需要包含兩個重要信息: 包名name和版本信息version
例如:

{
  "name": "my-awesome-package",
  "version": "1.0.0"
}

創建package.json

我們可以使用命令npm init來初始化一個package.json文件,運行這個命令后,它會詢問一些關于包的基本信息,根據實際情況回答即可。如果不喜歡這種方式,可以使用npm init --yes命令直接使用默認的配置來創建package.json文件,最后根據需要修改創建好的package.json文件即可。

package.json文件創建好后,我們來看看它長得什么樣子吧!

{
  "name": "my_package",
  "description": "",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "repository": {
    "type": "git",
    "url": "https://github.com/ashleygwilliams/my_package.git"
  },
  "keywords": [],
  "author": "",
  "license": "ISC",
  "bugs": {
    "url": "https://github.com/ashleygwilliams/my_package/issues"
  },
  "homepage": "https://github.com/ashleygwilliams/my_package"
}

主要字段的含義如下:

  • name: 模塊名, 模塊的名稱有如下要求:

    • 全部小寫
    • 只能是一個詞語,沒有空格
    • 允許使用破折號和下劃線作為單詞分隔符
  • version: 模塊版本信息

  • description:關于模塊功能的簡單描述,如果這個字段為空的話,默認會從當前目錄的READMD.mdREADME文件讀取第一行內容作為它的默認值。

  • main: 模塊被引入后,首先加載的文件,默認為index.js

  • scripts: 定義一些常用命令入口

類似git一樣,npm也可以做一些簡單的配置來設置一些我們常用的信息

$ npm set init.author.email "wombat@npmjs.com"

$ npm set init.author.name "ag_dubs"

$ npm set init.license "MIT"

這樣下次執行npm init的時候,就會用上我們配置的一些默認信息啦!

安裝模塊

使用npm install會讀取package.json文件來安裝模塊。安裝的模塊分為兩類
dependenciesdevDependencies,分別對應生產環境需要的安裝包和開發環境需要的安裝包。

同樣在安裝模塊的時候,可以通過指定參數來修改package.json文件,如

$ npm install <package_name> --save

$ npm install <package_name> --save-dev

來將新安裝的模塊信息記錄到package.json文件。

更新模塊

$ npm update

卸載模塊

$ npm uninstall <package_name>

如果要在卸載模塊的同時,也將他從package.json文件中移除,可以添加跟安裝時候一樣的參數,例如:

$ npm uninstall --save lodash

全局包管理

默認情況下。我們執行默認的安裝命令安裝的包都是安裝到當前目錄下的,只能在當前目錄下使用。但是假如我們需要使用一些全局的軟件,如grunt,我們可以在安裝的時候,添加-g選項來安裝,方便后面在任何目錄下都可以使用grunt相關的命令

$ npm install -g grunt

同理,更新全局的安裝包只需要執行命令

$ npm update -g

為了查看當前哪些包需要更新,可以使用如下命令來查看

$ npm outdated -g --depth=0
Package             Current  Wanted  Latest  Location
vue-cli               2.7.0   2.8.1   2.8.1
webpack              1.13.2   2.2.1   2.2.1
webpack-dev-server   1.14.1   2.4.1   2.4.1

卸載全局安裝的包也只需要加上-g選項即可。如

$ npm uninstall -g jshint

創建自己的Node.js模塊

一個Node.js模塊就是一個可以發布到npm,供其他開發者下載和使用的模塊。那么,到底怎樣和其他開發者分享我們的模塊呢?

首先,我們必須創建一個package.json文件,添加上關于我們想要分享的模塊信息,如:模塊功能,開發者信息等。

一旦package.json文件創建好后,我們需要創建一個模塊被引入時,就加載的文件。
package.jsonmain字段指定的文件,默認為index.js。我們需要在文件中將一個函數賦值給exports模塊,方便其他開發者調用我們的模塊。如

exports.printMsg = function() {
  console.log("This is a message from the demo package");
}

包(Pacakges)和模塊(Modules)

在使用npm的時候,有兩個概念容易搞混,那就是包(Pacakges)和模塊(Modules)。簡單來說,包和模塊的區別如下:

  • 包是一個被package.json文件描述了的文件或者目錄
  • 模塊是可以被Node.js引用的文件或目錄

什么是包?

a) a folder containing a program described by a package.json file
b) a gzipped tarball containing (a)
c) a url that resolves to (b)
d) a <name>@<version> that is published on the registry with (c)
e) a <name>@<tag> that points to (d)
f) a <name> that has a latest tag satisfying (e)
g) a git url that, when cloned, results in (a).

什么是模塊?

  • A folder with a package.json file containing a main field.
  • A folder with an index.js file in it.
  • A JavaScript file.

npm配置

在使用npm時,我們可以根據個人的需要,指定很多配置信息。
npm的配置信息加載優先級如下(從高到低)

  1. 命令行參數
  2. 環境變量
  3. npmrc文件
    1. 項目級別的npmrc文件(/path/to/my/project/.npmrc)
    2. 用戶級別的npmrc文件(~/.npmrc)
    3. 全局的npmrc文件($PREFIX/etc/npmrc)
    4. npm內置的npmrc文件(/path/to/npm/npmrc)

查看配置

$ npm config list -l

配置npm源

最后介紹一個比較重要的配置,當我們使用默認配置從npm官網下載模塊時,由于網絡的因素,會導致我們的下載速度特別慢。所以,我們可以配置一些國內的鏡像來加快我們的下載速度。在這里,我推薦使用[淘寶的npm鏡像](淘寶 NPM 鏡像), 具體使用方式如下:

  • 臨時使用, 安裝包的時候通過--registry參數即可

      $ npm install express --registry https://registry.npm.taobao.org
    
  • 全局使用

      $ npm config set registry https://registry.npm.taobao.org
      // 配置后可通過下面方式來驗證是否成功
      npm config get registry
      // 或
      npm info express
    
  • 使用cnpm使用

      // 安裝cnpm
      npm install -g cnpm --registry=https://registry.npm.taobao.org
    
      // 使用cnpm安裝包
      cnpm install express
    

更多使用

請參考官方文檔

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 229,885評論 6 541
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 99,312評論 3 429
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 177,993評論 0 383
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 63,667評論 1 317
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 72,410評論 6 411
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 55,778評論 1 328
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,775評論 3 446
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,955評論 0 289
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 49,521評論 1 335
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 41,266評論 3 358
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 43,468評論 1 374
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,998評論 5 363
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,696評論 3 348
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 35,095評論 0 28
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 36,385評論 1 294
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 52,193評論 3 398
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 48,431評論 2 378

推薦閱讀更多精彩內容

  • 描述 npm從以下來源獲取配置值,按優先級排序: 命令行標記 在命令行上放置--foo bar設置foo配置參數為...
    竹天亮閱讀 44,203評論 0 8
  • npm是什么 NPM的全稱是Node Package Manager,是隨同NodeJS一起安裝的包管理和分發工具...
    build1024閱讀 7,930評論 0 9
  • Spring Cloud為開發人員提供了快速構建分布式系統中一些常見模式的工具(例如配置管理,服務發現,斷路器,智...
    卡卡羅2017閱讀 134,821評論 18 139
  • 什么是 NPM npm之于Node,就像pip之于Python,gem之于Ruby,composer之于PHP。 ...
    ihoey閱讀 6,262評論 2 36
  • 借助XShell,使用linux命令sz可以很方便的將服務器上的文件下載到本地,使用rz命令則是把本地文件上傳到服...
    AiPuff閱讀 4,342評論 0 0