關於npm的package.json配置項的小結

name

nameversion是package.json中最重要的兩個字段,也是發佈到NPM平臺上的唯一標識,如果沒有正確設置這兩個字段,包就不能發佈和被下載。

version

包的版本號。如"1.0.0"。

description

包的描述信息,將會在npm search的返回結果中顯示,以幫助用戶選擇合適的包。

keywords

包的關鍵詞信息,是一個字符串數組,同上也將顯示在npm search的結果中。

homepage

包的主頁地址。

bugs

包的bug跟蹤主頁地址。

license

包的開源協議名稱。

author

包的作者。

contributors, maintainers

包的貢獻者,是一個數組。

files(較少用)

包所包含的所有文件,可以取值爲文件夾。通常我們還是用.npmignore來去除不想包含到包裏的文件。

main

包的入口文件。

bin(較少用)

如果你的包裏包含可執行文件,通過設置這個字段可以將它們包含到系統的PATH中,這樣直接就可以運行,很方便。

man(較少用)

爲系統的man命令提供幫助文檔。幫助文件的文件名必須以數字結尾,如果是壓縮的,需要以.gz結尾。

"man": ["./man/foo.1", "./man/bar.1", "./man/foo.2" ]

directories(較少用)

CommonJS包所要求的目錄結構信息,展示項目的目錄結構信息。字段可以是:lib, bin, man, doc, example。值都是字符串。

repository

包的倉庫地址。

"repository": {
    "type": "git",
    "url": "git+https://github.com/rainnaZR/es6-react.git"
}

以上一段都是參考網上的資料,看一下都懂,重點說以下的內容

scripts

通過設置這個可以使NPM調用一些命令腳本,封裝一些功能。

"scripts": {"start": "babel-node src/pages/index.js",
    "build": "webpack --config config/webpack.config.js",
    "watch": "webpack-dev-server --config config/webpack.config.js --hot --inline --progress"
}

這個配置在配合webpack的使用時,很有用。

config

添加一些設置,可以供scripts讀取用,同時這裏的值也會被添加到系統的環境變量中。

"config": {
  "port": "8080"
}

npm start的時候會讀取到npm_package_config_port環境變量。

dependencies

指定依賴的其它包,這些依賴是指包發佈後正常執行時所需要的,也就是線上需要的包。使用下面的命令來安裝:

npm install --save packageName

如果是開發中依賴的包,可以在devDependencies設置。

devDependencies

這些依賴只有在開發時候才需要。使用下面的命令來安裝:

npm install --save-dev packageName 
發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章