package.json各字段含義

package.json字段分析(瞭解)

  • name:包的名稱,必須是唯一的,由小寫英文字母、數字和下劃線組成,不能包含空格

  • version:符合語義化版本識別規範的版本字符串

    • 主版本號:當你做了不兼容的 API 修改
    • 子版本號:當你做了向下兼容的功能性新增
    • 修訂號:當你做了向下兼容的問題修正
  • description:包的簡要說明

  • keywords:關鍵字數組,通常用於搜索

  • author:作者

  • main:指定包的入口文件,若沒有指定,默認找index.js文件。若包中沒有index.js文件,也沒有指定main,就會報錯。

  • scripts :保存一些常用指令,通過npm run [key]的方式運行指令
    應用場景:每次執行某個js文件都需要傳遞參數,並且每次傳遞的參數都是一樣的。
    那麼就可以通過將指令保存到scripts中來簡化輸入指令的操作。

    • test:如果scripts中的key爲test,要想運行test可以不寫run,即:npm [key]
    • start:如果scripts中的key爲start,要想運行start可以不寫run,即:npm [key]
  • maintainers:維護者數組,每個元素要包含name、email(可選)、web(可選)字段

  • contributors:貢獻者數組,格式與maintainers相同。包的作者應該是貢獻者數組的第一- 個元素

  • bugs:提交bug的地址,可以是網站或者電子郵件地址

  • licenses:許可證數組,每個元素要包含type(許可證名稱)和url(鏈接到許可證文本的- 地址)字段。也稱爲開源協議。

  • repositories:倉庫託管地址數組,每個元素要包含type(倉庫類型,如git)、url(倉- 庫的地址)和path(相對於倉庫的路徑,可選)字段

  • dependencies:生產環境包的依賴,一個關聯數組,由包的名稱和版本號組成

  • devDependencies:開發環境包的依賴,一個關聯數組,由包的名稱和版本號組成
    npm官網對應各字段

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