npm package.json屬性詳解

模塊安裝的時候，若是全局安裝，則npm會為bin中配置的文件在bin目錄下創建一個軟連接（對于windows系統，默認會在C:\Users\username\AppData\Roaming\npm目錄下），若是局部安裝，則會在項目內的./node_modules/.bin/目錄下創建一個軟鏈接。

因此，按上面的例子，當你安裝myapp的時候，npm就會為cli.js在/usr/local/bin/myapp路徑創建一個軟鏈接。

如果你的模塊只有一個可執行文件，并且它的命令名稱和模塊名稱一樣，你可以只寫一個字符串來代替上面那種配置，例如：

</div>

{ "name": "my-program"
, "version": "1.2.5"
, "bin": "./path/to/program" }

作用和如下寫法相同:

{ "name": "my-program"
, "version": "1.2.5"
, "bin" : { "my-program" : "./path/to/program" } }

man

制定一個或通過數組制定一些文件來讓linux下的man命令查找文檔地址。如果只有一個文件被指定的話，安裝后直接使用man+模塊名稱，而不管man指定的文件的實際名稱。例如:

{ "name" : "foo"
, "version" : "1.2.3"
, "description" : "A packaged foo fooer for fooing foos"
, "main" : "foo.js"
, "man" : "./man/doc.1"
}

通過man foo命令會得到 ./man/doc.1 文件的內容。如果man文件名稱不是以模塊名稱開頭的，安裝的時候會給加上模塊名稱前綴。因此，下面這段配置：

{ "name" : "foo"
, "version" : "1.2.3"
, "description" : "A packaged foo fooer for fooing foos"
, "main" : "foo.js"
, "man" : [ "./man/foo.1", "./man/bar.1" ]
}

會創建一些文件來作為man foo和man foo-bar命令的結果。man文件必須以數字結尾，或者如果被壓縮了，以.gz結尾。數字表示文件將被安裝到man的哪個部分。

{ "name" : "foo"
, "version" : "1.2.3"
, "description" : "A packaged foo fooer for fooing foos"
, "main" : "foo.js"
, "man" : [ "./man/foo.1", "./man/foo.2" ]
}

會創建 man foo 和 man 2 foo 兩條命令。

directories

CommonJs通過directories來制定一些方法來描述模塊的結構，看看npm的package.json文件 https://registry.npmjs.org/npm/latest ，可以發現里邊有這個字段的內容。

目前這個配置沒有任何作用，將來可能會整出一些花樣來。

directories.lib

告訴用戶模塊中lib目錄在哪，這個配置目前沒有任何作用，但是對使用模塊的人來說是一個很有用的信息。

directories.bin

如果你在這里指定了bin目錄，這個配置下面的文件會被加入到bin路徑下，如果你已經在package.json中配置了bin目錄，那么這里的配置將不起任何作用。

directories.man

指定一個目錄，目錄里邊都是man文件，這是一種配置man文件的語法糖。

directories.doc

在這個目錄里邊放一些markdown文件，可能最終有一天它們會被友好的展現出來（應該是在npm的網站上）

directories.example

放一些示例腳本，或許某一天會有用 - -！

repository

指定一個代碼存放地址，對想要為你的項目貢獻代碼的人有幫助。像這樣：

"repository" :
  { "type" : "git"
  , "url" : "
"repository" :
  { "type" : "svn"
  , "url" : "若你的模塊放在GitHub, GitHub gist, Bitbucket, or GitLab的倉庫里，npm install的時候可以使用縮寫標記來完成：

"repository": "npm/npm"

"repository": "gist:11081aaa281"
"repository": "bitbucket:example/repo"
"repository": "gitlab:another/repo"</pre> 
 
scripts

 
  
scripts屬性是一個對象，里邊指定了項目的生命周期個各個環節需要執行的命令。key是生命周期中的事件，value是要執行的命令。

  
 具體的內容有 install start stop 等，詳見 https://docs.npmjs.com/misc/scripts 

 
config
用來設置一些項目不怎么變化的項目配置，例如port等。用戶用的時候可以使用如下用法： 
http.createServer(...).listen(process.env.npm_package_config_port)
 
 
 可以通過npm config set foo:port 80來修改config。詳見 https://docs.npmjs.com/misc/config 

{ "name" : "foo"
, "config" : { "port" : "8080" } }
 
 
dependencies

 
  
dependencies屬性是一個對象，配置模塊依賴的模塊列表，key是模塊名稱，value是版本范圍，版本范圍是一個字符，可以被一個或多個空格分割。

  
dependencies也可以被指定為一個git地址或者一個壓縮包地址。

  
 不要把測試工具或transpilers寫到dependencies中。 下面是一些寫法，詳見 https://docs.npmjs.com/misc/semver 

 
 
  
version 精確匹配版本 

  
 
   
 
    
version 必須大于某個版本

   
 

  
 
   
 
    
=version 大于等于

   
 

  
<version 小于 

  
<=versionversion 小于 

  
~version "約等于"，具體規則詳見semver文檔 

  
^version "兼容版本"具體規則詳見semver文檔 

  
1.2.x 僅一點二點幾的版本 

  
 http:// ... 見下面url作為denpendencies的說明 

  
 
   
 
    
任何版本 

   
 

  
"" 空字符，和*相同 

  
version1 - version2 相當于 >=version1 <=version2. 

  
range1 || range2 范圍1和范圍2滿足任意一個都行 

  
git... 見下面git url作為denpendencies的說明 

  
user/repo See 見下面GitHub倉庫的說明 

  
 tag 發布的一個特殊的標簽，見npm-tag的文檔 https://docs.npmjs.com/getting-started/using-tags 

  
 path/path/path 見下面本地模塊的說明 

 下面的寫法都是可以的: 

 
{ "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"
  }
}
 
 
URLs as Dependencies

在版本范圍的地方可以寫一個url指向一個壓縮包，模塊安裝的時候會把這個壓縮包下載下來安裝到模塊本地。
Git URLs as Dependencies
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
 
 
commit-ish 可以是任意標簽，哈希值，或者可以檢出的分支，默認是master分支。

GitHub URLs
支持github的 username/modulename 的寫法，#后邊可以加后綴寫明分支hash或標簽：
{
  "name": "foo",
  "version": "0.0.0",
  "dependencies": {
    "express": "visionmedia/express",
    "mocha": "visionmedia/mocha#4727d357ea"
  }
}
 
 
Local Paths

npm2.0.0版本以上可以提供一個本地路徑來安裝一個本地的模塊，通過npm install xxx --save 來安裝，格式如下：
../foo/bar
~/foo/bar
./foo/bar
/foo/bar
 
 
package.json 生成的相對路徑如下:

{
  "name": "baz",
  "dependencies": {
    "bar": "file:../foo/bar"
  }
}
 
 
這種屬性在離線開發或者測試需要用npm install的情況，又不想自己搞一個npm server的時候有用，但是發布模塊到公共倉庫時不應該使用這種屬性。

devDependencies
 
  
如果有人想要下載并使用你的模塊，也許他們并不希望或需要下載一些你在開發過程中使用的額外的測試或者文檔框架。

  
在這種情況下，最好的方法是把這些依賴添加到devDependencies屬性的對象中。

  
這些模塊會在npm link或者npm install的時候被安裝，也可以像其他npm配置一樣被管理，詳見npm的config文檔。

  
對于一些跨平臺的構建任務，例如把CoffeeScript編譯成JavaScript，就可以通過在package.json的script屬性里邊配置prepublish腳本來完成這個任務，然后需要依賴的coffee-script模塊就寫在devDependencies屬性種。

  
例如:

 
{ "name": "ethopia-waza",
  "description": "a delightfully fruity coffee varietal",
  "version": "1.2.3",
  "devDependencies": {
    "coffee-script": "~1.6.3"
  },
  "scripts": {
    "prepublish": "coffee -o lib/ -c src/waza.coffee"
  },
  "main": "lib/waza.js"
}
 
 
prepublish腳本會在發布之前運行，因此用戶在使用之前就不用再自己去完成編譯的過程了。在開發模式下，運行npm install也會執行這個腳本（見npm script文檔），因此可以很方便的調試。

peerDependencies
有時候做一些插件開發，比如grunt等工具的插件，它們往往是在grunt的某個版本的基礎上開發的，而在他們的代碼中并不會出現require("grunt")這樣的依賴，dependencies配置里邊也不會寫上grunt的依賴，為了說明此模塊只能作為插件跑在宿主的某個版本范圍下，可以配置peerDependencies：
{
  "name": "tea-latte",
  "version": "1.3.5",
  "peerDependencies": {
    "tea": "2.x"
  }
}
 
 
 
  
上面這個配置確保再npm install的時候tea-latte會和2.x版本的tea一起安裝，而且它們兩個的依賴關系是同級的：

 ├── tea-latte@1.3.5 
 └── tea@2.2.0 
這個配置的目的是讓npm知道，如果要使用此插件模塊，請確保安裝了兼容版本的宿主模塊。
</div>
bundledDependencies
上面的單詞少個d，寫成bundleDependencies也可以。指定發布的時候會被一起打包的模塊。 
optionalDependencies
如果一個依賴模塊可以被使用， 同時你也希望在該模塊找不到或無法獲取時npm繼續運行，你可以把這個模塊依賴放到optionalDependencies配置中。這個配置的寫法和dependencies的寫法一樣，不同的是這里邊寫的模塊安裝失敗不會導致npm install失敗。當然，這種模塊就需要你自己在代碼中處理模塊確實的情況了，例如： 
try {
  var foo = require('foo')
  var fooVersion = require('foo/package.json').version
} catch (er) {
  foo = null
}
if ( notGoodFooVersion(fooVersion) ) {
  foo = null
}

// .. then later in your program ..
if (foo) {
  foo.doFooThings()
}</pre> 
 
optionalDependencies 中的配置會覆蓋dependencies中的配置，最好只在一個地方寫。

engines
 
  
你可以指定項目運行的node版本范圍，如下：

  
{ "engines" : { "node" : ">=0.10.3 <0.12" } }

  
和dependencies一樣，如果你不指定版本范圍或者指定為*，任何版本的node都可以。

  
也可以指定一些npm版本可以正確的安裝你的模塊，例如：

  
{ "engines" : { "npm" : "~1.0.20" } }

  
要注意的是，除非你設置了engine-strict屬性，engines屬性是僅供參考的。

 
engineStrict
注意：這個屬性已經棄用，將在npm 3.0.0 版本干掉。
os
 
  
可以指定你的模塊只能在哪個操作系統上跑：

  
"os" : [ "darwin", "linux" ]

  
也可以指定黑名單而不是白名單：

  
"os" : [ "!win32" ]

  
服務的操作系統是由process.platform來判斷的，這個屬性允許黑白名單同時存在，雖然沒啥必要這樣搞...

 
cpu
 
  
限制模塊只能在某某cpu架構下運行

  
"cpu" : [ "x64", "ia32" ]

  
同樣可以設置黑名單:

  
"cpu" : [ "!arm", "!mips" ]

  
cpu架構通過 process.arch 判斷

 
preferGlobal
如果您的軟件包主要用于安裝到全局的命令行應用程序，那么該值設置為true ，如果它被安裝在本地，則提供一個警告。實際上該配置并沒有阻止用戶把模塊安裝到本地，只是防止該模塊被錯誤的使用引起一些問題。
private
如果這個屬性被設置為true，npm將拒絕發布它，這是為了防止一個私有模塊被無意間發布出去。如果你只想讓模塊被發布到一個特定的npm倉庫，如一個內部的倉庫，可與在下面的publishConfig中配置倉庫參數。
publishConfig
這個配置是會在模塊發布時用到的一些值的集合。如果你不想模塊被默認被標記為最新的，或者默認發布到公共倉庫，可以在這里配置tag或倉庫地址。
DEFAULT VALUES
 
  
npm設置了一些默認參數，如：

  
"scripts": {"start": "node server.js"}

  
如果模塊根目錄下有一個server.js文件，那么npm start會默認運行這個文件。

  
"scripts":{"preinstall": "node-gyp rebuild"}

  
如果模塊根目錄下有binding.gyp, npm將默認用node-gyp來編譯preinstall的腳本

  
"contributors": [...]

  
 若模塊根目錄下有AUTHORS 文件，則npm會按Name 
        (url)格式解析每一行的數據添加到contributors中，可以用#添加行注釋
    

 
 參考文檔列表( https://docs.npmjs.com/ ) 
 
  
semver(7)

  
npm-init(1)

  
npm-version(1)

  
npm-config(1)

  
npm-config(7)

  
npm-help(1)

  
npm-faq(7)

  
npm-install(1)

  
npm-publish(1)

  
npm-rm(1)

 
 ** 轉自我的個人博客，原文地址： http://zoucz.com/blog/2016/02/16/npm-package ** 
 </div>

                    
                    

                        
 本文由用戶 reibatmna 自行上傳分享，僅供網友學習交流。所有權歸原作者，若您的權利被侵害，請聯系管理員。
                        
 轉載本站原創文章，請注明出處，并保留原始鏈接、圖片水印。
                        
 本站是一個以用戶分享為主的開源技術平臺，歡迎各類分享！
                        
 本文地址：http://www.baiduhome.net/lib/view/open1455669915605.html
                        
 JSON Node.js 開發