如果你是一個JavaScript系的開發者,一定不會陌生NPM,它既是一個平台,也是一個工具。在這個平台上,我們能夠使用其他開發者提供的功能代碼,當然我們也能將我們自己代碼提交到這里分享給世界上的開發者。
以下記錄一些NPM作為工具的一些使用技巧。
npmrc
.npmrc 做為npm的配置文件,它可以定義在多個地方。
- ~/.npmrc
用戶根目錄,根目錄內所有的npm指令都會查詢到該配置
- /path/to/npm/npmrc
npm內建配置文件
- ./.npmrc
當前項目根目錄,用於配置特定於當前項目的配置
npmrc對我們來說十分有用,我們可以配置例如username、registry、email等信息。 eg:
save=true
save-exact=true
email=wfsovereign@outlook.com
username=wfsovereign
registry=https://registry.npm.taobao.org
npm最讓人頭疼的問題之一就是版本號了,這里配置了save和save-exact屬性,作用是讓我們 npm install
指令安裝的依賴自動保存在package.json
文件的dependencies
中並且讓版本號固定。
一些國內的服務器在拉取某些被牆的包的經常會失敗或者速度很慢,這個時候我們可以試試淘寶NPM鏡像(這是一個完整 npmjs.org 鏡像,你可以用此代替官方版本(只讀),同步頻率目前為 10分鍾 一次以保證盡量與官方服務同步)。官方還定制了cnpm,這個看具體情況而定了。比如,我曾經的一個項目,部署在微軟的Asure上面,這個服務器感覺被牆的厲害,用官方的npm庫下phantomjs的zip文件運氣好的話也得下個兩三次才能下下來,后來為了解決這個問題嘗試了淘寶鏡像,不過問題就出在用了cnpm,用cnpm拉的包在本地編譯不了,后來換回npm,使用淘寶鏡像,一切正常了~
package.json
package.json
是項目的配置管理文件,它定義了這個項目所需要的各個依賴模塊以及項目的配置信息(名字,版本號,許可證等)。一個最基本的package.json
必須有name
和version
,差不多長這樣:
{
"name": "xxx",
"version": 0.0.0
}
我們可以通過npm init
指令初始化創建一個package.json文件,
{
"name": "test",
"version": "1.0.0",
"description": "",
"main": "index.js",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
"author": "wfsovereign",
"license": "ISC",
"devDependencies": {
},
"dependencies": {
}
}
下面分屬性介紹
scripts
scripts
定義了一些腳本指令的npm命令縮寫,通過這些命令我們可以方便的啟動項目、進行測試或者拿到一些鈎子來做某些指令前預先做的事,
"scripts": {
"pretest": "echo \"this is pre test\" ",
"test": "echo \"Error: no test specified\"",
"posttest": "echo \"this is post test\""
}
當我們執行npm test
會得到如下輸出:
this is pre test
test@1.0.0 test echo "Error: no test specified"
Error: no test specified
test@1.0.0 posttest echo "this is post test"
this is post test
通過如上實驗,我們能夠知道,prexx
指令是一個預執行指令,postxx
是一個后置指令,他倆都和xx
指令強相關。
main
main
指定項目加載的入口文件,默認是根目錄的inde.js
file
file
是一個字符串的數組,指定我們發布的包應該包含當前目錄的哪些文件,這個在我們發布包的時候很有用,因為開發包里面的文件夾不是都需要發布出去的。當然一下文件是始終會被包含進去的,不論我們是否設置,
- package.json
- README
- CHANGES / CHANGELOG / HISTORY
- LICENSE / LICENCE
- NOTICE
- The file in the "main" field
keywords
keywords
指定了在庫中搜索時能夠被哪些關鍵字搜索到,所以一般這個會多寫一些項目相關的詞在這里,這是一個字符串的數組。
其余屬性詳情可以查詢官方文檔
semantic version
關於語義化的版本號,這里不多講,放一些preference
Nodejs項目中最常見的一些版本標識( *, ~, ^ ),經常忘了它們的含義,這里記錄一下:
*
任意版本1.0.0
安裝指定的1.0.0版本
lodash: 4.7.0 會安裝准確的4.7.0到我們的node_module目錄
~1.0.0
安裝 >= 1.0.0 小於 1.(0 + 1).0的最新版本^1.0.0
安裝 >= 1.0.0 小於 (1 + 1).0.0的最新版本
package publish
如何發布一個包?
npm addUser
按照提示輸入賬號密碼,創建一個npm的賬號,如果已有賬號直接到下一步npm whoami
查看當前用戶,確認是使用當前用戶來發布包npm publish
然后就可以直接發布了,當然這個時候可能會出現各種問題,比如你的包和別人的重名了,或者當前的包的版本號已經發布過了等等
說到發布包,這里在記錄一些開發包的小技巧。
我們在開發包的時候免不了一些調試,但是這些調試的過程我們並不想它發布又想確保當前的功能是可用的,這個時候有兩個辦法能夠幫助我們來解決這個問題。
npm link
關於npm link
的詳細介紹我們可以看官網,這里介紹三種用法:
- 直接在我們開發包的主目錄下直接使用,這個時候,相當於我們在npm global的目錄下符號鏈接了當前包。
npm link package-name
, 作用相當於把一個全局安裝的包link到了我們當前目錄下node_module中。- 在
package.json
文件的dependencies中使用如下方式聲明,然后就如同使用一個已經正常發布的包一樣安裝使用就行。
"dependencies": {
"bar": "file:../foo/bar"
}
ps: 繼續努力啊,如風少年~