npm入門文檔

時間 2019-11-06

標籤 npm 入門文檔简体版

原文原文鏈接

前言

NPM做爲Node的模塊管理和發佈工具，做用與Ruby的gem、Python的pypl或setuptools、PHP的pear和.Net的Nuget同樣。在當前前端工程化極速狂奔的年代，即便不作nodejs的開發，也須要學習和使用NPM的，誰叫grunt、bower、yeoman這一堆的工具都經過NPM發佈呢？！本文爲針對非nodejs的開發者整理的NPM使用說明。固然最好的教程仍是官網的啦！html

2、什麼是包？

nodejs以包的形式組織程序模塊，而包的定義卻十分簡單——包含文件內容符合規範package.json文件的目錄或歸檔文件。並經過」package-name」@」version」來惟一標識每一個包。前端

3、靈魂——package.json

包的定義和NPM都圍繞着package.json文件作文章，package.json文件其實就至關於JAVA中的MANIFEST.MF文件，用於存放模塊的名稱、版本、做者、機構、模塊入口、依賴項等信息。首先咱們經過node

npm init git

命令在當前工做目錄下以用戶引導的方式建立一個全新的package.json文件。而後經過github

npm help json shell

命令打開幫助文檔，並根據實際的項目需求自行初始化package.json的項目便可。下面將對基礎配置項進行敘述。npm

name

必選項，表示模塊名稱。命名時不能包含js、node、和url中須要轉義的字符，不能以.和_爲開頭。json

version

必選項，表示模塊的版本號。版本號以前端工程化

主版本號(Major).副版本號(Minor).補丁版本號(Patch) 數組

構成（如1.2.0）。而engines、dependencies和devDependencies等配置項中可以使用語義化版本號語法，具體以下：

標記

介紹

1.1.1

精確下載安裝1.1.1版本的包

>、=1.1.1

分別表示下載安裝大於、小於等於、大於等於1.1.1版本的包

1.0.1-1.1.1

表示版本範圍是包含1.0.1到1.1.1版本的包

~1.1.1

表示儘可能採用靠近1.1.1版本的包，但可用的包版本範圍是1.1.1-0到1.1.x-x版本的包

~1.1

表示下載安裝1.1.x-x版本的包

表示下載安裝1.x.x-x版本的包

^1.1.1

表示包版本範圍是1.1.1到1.x.x-x

^0.1.1

表示包版本範圍是1.1.1到1.1.x-x

^1.1

表示包版本範圍是1.1.x-x到1.x.x-x

表示包版本範圍是1.x.x-x

空格、x、

表示任意版本便可

其餘

兩個版本選擇器間，空格表示and關係，」||」表示or關係。

main

必選項，模塊入口文件相對路徑（相對於模塊根目錄）。

description

可選項，表示模塊功能描述，顯示在

npm search "package-name"

中

keywords

可選項，數組類型，表示模塊的關鍵字，顯示在

npm search "package-name"

中

author

可選項，表示發起者信息。示例以下：

{
"author": {
"name": "luoyue",
"email": "luoyue@zz173.com",
"url": "https://post.zz173.com"
},
}

engines

可選項，依賴的node版本。示例以下：

{
"engines":{
"node": ">= 0.8.0"
}
}

repository

可選項，源碼託管地址。示例以下：

{
"repository": {
"type": "git",
"url": "git+https://github.com/rozbo/hexo-hrefmd.git",
},
}

scripts

可選項，自定義在cli中輸入

npm "script"

時實際執行的程序。npm默認提供大量的script供咱們調用。

dependencies、devDependencies

可選項，用於配置模塊的生產環境依賴包和開發環境依賴包。當執行npm install時，npm會根據這兩個配置項的值去下載安裝相關的依賴包。二者的區別是devDependencies是模塊開發過程的依賴包（如：grunt只在開發時有用的模塊），而且當其餘模塊須要依賴當前模塊時，當經過npm install 「package-name」時會自動下載安裝dependencies的包而不會下載devDependencies的包。