package.json 入門

PACKAGE.JSON

參考連接：blog.csdn.net/u011240877/…

1. package.json

npm在package.json文件中管理項目的依賴項以及項目的元數據。 node執行js中require（es6 import）的時候，也會根據package.json中的依賴項查找。

2. package.json 文件解析

2.1 做用

• 描述了你的項目依賴哪些包，並指明依賴包的版本
• 更好地與開發者分享，便於重複使用

2.2 字段說明

2.2.1 文檔連接 package.json

2.2.2 必選字段

• name 所有小寫，不支持空格
• version 版本號

2.2.3 可選字段

• description 描述信息，有助於npm search
• keywords 關鍵字，有助於npm search
• main 入口文件
• homepage 帶協議前綴的URL，例如 www.xxx.com
• bugs 提供郵箱或url連接追蹤項目的問題信息，例如

{
    "url":"http://github.com/issues, "email" :"xxx@gmail.com" } 複製代碼

• repository 當前的項目遠程倉庫，便於用戶進行貢獻，例如

"repository" :
  { 
    "type" : "git", 
    "url" : "http://github.com/npm/npm.git"
  }
複製代碼

• author 用戶，一我的，例如

{ 
    "name" : "Barney Rubble, "email" : "b@rubble.com", "url" : "http://barnyrubble.tumblr.com/" } 複製代碼

簡寫爲

"Barney Rubble <b@rubble.com>(http://barnyrubble.tumblr.com/)"
複製代碼

• contributors 用戶羣組
• dependencies 項目的依賴安裝包，指定版本，也能夠是一個git url
• devDependencies 基本同於dependencies，可是若是隻須要下載使用某些模塊，而不下載這些模塊的測試和文檔框架，放在這個下面比較不錯

3. 依賴包的版本號

3.1 基本的匹配模式

• version 徹底匹配
• >version 大於這個版本
• >=version 大於或等於這個版本
• <version 小於這個版本
• <=version 小於等於這個版本
• version1 - version2，等價於 >=version1 && <=version2.
• range1 || range2 知足任意一個便可
• http://... Unix系統下使用的tarball的URL。
• git... Git地址
• latest 保持最新版本

上述列舉條目與下面例子一一對應

{ 
    "dependencies" :
      { 
        "boo" : "2.0.1",
        "bar" : ">1.0.2", 
        "bar2" : ">=1.0.2", 
        "baz" : "<2.3.4", 
        "baz2" : "<=2.3.4", 
        "foo" : "1.0.0 - 2.9999.9999",
        "qux" : "<1.0.0 || >=2.3.1 <2.4.5「, "asd" : "http://asdf.com/asdf.tar.gz", 'git-smt': "git address", "lat" : "latest", } } 複製代碼

3.2 版本號

3.2.1 規範

• 補丁版本：解決了 bug 或者一些較小的更改，增長最後一位數字，好比 1.0.1 --> 1.0.2
• 小版本：增長了新特性，同時不會影響以前的版本，增長中間一位數字，好比 1.0.2 --> 1.1.2
• 大版本：大改版，沒法兼容以前的，增長第一位數字，好比 1.1.2 --> 2.1.2

3.2.2 更新程度

• 若是隻接受補丁版本的更新（也就是最後一位的改變），就能夠這麼寫：
  • 1.0
  • 1.0.x
  • ~1.0.4
• 若是接受小版本的更新（第二位的改變，接受補丁版本的改變），就能夠這麼寫：
  • 1
  • 1.x
  • ^1.0.4
• 若是能夠接受大版本的更新（天然接受小版本和補丁版本的改變），就能夠這麼寫：
  • *
  • x
  • ""