npm package.json文件解讀

每個Nodejs項目的根目錄下面,一般都會有一個package.json文件。該文件可以由npm init生成,定義了項目所需要的各種模塊,以及項目的配置信息(比如名稱、版本、許可證等元數據)。

package.json文件內部就是一個JSON對象,該對象的每一個成員就是當前項目的一項設置。

基本字段

  1. name

    項目名稱(npm包名)。必需字段

  2. version

    項目版本。必需字段。
    版本號的格式為"1.0.0",分別代表“主版本號.次版本號.修訂號”。它的遞增規則如下:

    • 主版本號:當你做了不兼容的API 修改;
    • 次版本號:當你做了向下兼容的功能性新增;
    • 修訂號:當你做了向下兼容的問題修正。

    在實際使用中,一般可以看到各種形式的版本號:

    *: 任意版本
    1.1.0: 指定版本
    ~1.1.0: 1.1.0 <= 版本 < 1.2.0
    ^1.1.0: 1.1.0 <= 版本 < 2.0.0
    latest:安裝最新版本。
    
    • *表示任意版本;
    • ~前綴表示,安裝大于指定的這個版本,并且匹配到 x.y.z 中 z 最新的版本;
    • ^前綴在 ^0.y.z 時的表現和 ~0.y.z 是一樣的,然而 ^1.y.z 的時候,就會匹配到 y 和 z 都是最新的版本;
    • 特殊的是,當版本號為 ^0.0.z 或者 ~0.0.z 的時候,考慮到 0.0.z 是一個不穩定版本, 所以它們都相當于 =0.0.z。
  3. author && contributors

    項目作者以及貢獻者。author是字符串形式的作者名,contributors是一個項目貢獻者數組。

  4. description && keywords

    項目描述和項目關鍵字。幫助人們在使用npm search時找到這個包。

  5. license

    許可證。

功能性字段

  1. scripts

    定義腳本命令。它的每一個屬性,對應一段腳本。并且可以在命令行下使用npm run命令執行這段腳本。

    npm 腳本的原理非常簡單。每當執行npm run,就會自動新建一個 Shell,在這個 Shell 里面執行指定的腳本命令。因此,只要是 Shell(一般是 Bash)可以運行的命令,就可以寫在 npm 腳本里面。

    比較特別的是,npm run新建的這個 Shell,會將當前目錄的node_modules/.bin子目錄加入PATH變量,執行結束后,再將PATH變量恢復原樣。

    更多可參考阮老師的 npm scripts 使用指南

  2. dependencies && devDependencies

    npm install在安裝node模塊時,有兩種命令參數可以把它們的信息寫入package.json文件: –save以及–save-dev–save會把依賴包名稱添加到package.json文件dependencies鍵下,–save-dev則添加到package.json文件devDependencies鍵下。

    dependencies字段指定了項目生產環境中需要的依賴,即正常運行該包時所依賴的模塊,devDependencies指定項目開發所需要的依賴項,像一些進行單元測試之類的包,比如grunt-contrib-uglify,我們用它混淆js文件,它們不會被部署到生產環境。

    它們都指向一個對象。該對象的各個成員,分別由模塊名和對應的版本要求組成,表示依賴的模塊及其版本范圍。

  3. bin

    用來指定各個內部命令對應的可執行文件的位置。

    例如:

    "bin": {
        "someTool": "./bin/someTool.js"
    }
    

    上面代碼指定,someTool 命令對應的可執行文件為 bin 子目錄下的 someTool.js

  4. main

    指定包的入口程序文件。這個字段的默認值是模塊根目錄下面的index.js。

  5. config

    用于向環境變量輸出值。

    比如:

    {
        // ...
        "config" : { "port" : "8080" },
    }
    

    然后通過process.env.npm_package_config_port讀取該值。

其他字段

  1. engines

    指定node的工作版本

  2. man

    指定當前模塊的man文檔的位置。

  3. preferGlobal

    布爾類型值,表示當用戶不將該模塊安裝為全局模塊時(即不用–global參數),要不要顯示警告。

    ...

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。

推薦閱讀更多精彩內容

  • Spring Cloud為開發人員提供了快速構建分布式系統中一些常見模式的工具(例如配置管理,服務發現,斷路器,智...
    卡卡羅2017閱讀 134,923評論 18 139
  • 原文:http://javascript.ruanyifeng.com/nodejs/packagejson.ht...
    水墨熊貓閱讀 1,221評論 0 2
  • 什么是 NPM npm之于Node,就像pip之于Python,gem之于Ruby,composer之于PHP。 ...
    ihoey閱讀 6,264評論 2 36
  • npm是什么 NPM的全稱是Node Package Manager,是隨同NodeJS一起安裝的包管理和分發工具...
    build1024閱讀 7,959評論 0 9
  • 原文鏈接:http://www.mujiang.info/translation/npmjs/files/pack...
    R_X閱讀 1,046評論 0 1