配置package.json文件

前面我們講到,當使用 yarn init 初始化一個項目時,會自動生成一個 package.json 文件,在這個文件中可以配置項目的信息,例如名稱、版本號、描述信息等,還可以定義項目所需要的各種依賴包。

package.json文件中的字段

下面是一些 package.json 文件中的字段介紹,其中 nameversionpackage.json 中最重要的兩個必需字段,如果沒有它們那麼包將無法被安裝,兩者一起用來創建一個唯一的id。

  • name:包的名字,在 URL 中作爲命令行參數,作爲 node_modules 裏的目錄名使用。由小寫字母組成,儘量簡潔。
  • version: 包的當前版本號。
  • author:作者信息。
  • description:是一個字符串,可以幫助我們瞭解軟件包的用途,也可以在包管理中搜索包時使用它。
  • keywords:是一個字符串數組,在包管理器中搜索包時起作用。
  • license:許可證,以方便用戶知道他們是在什麼授權下使用此包,以及此包還有哪些附加限制。
  • main:項目的入口文件,默認爲 index.js
  • scripts:定義自動化開發相關任務的好方法,比如使用一些簡單的構建過程或開發工具。可以通過 yarn run <script> 命令來執行。
  • dependencies:包的開發版和發佈版都需要的依賴。
  • devDependencies:只在包開發期間需要,但是生產環境不會被安裝的包。
  • config:配置你的腳本的選項或參數。
  • homepage:包的項目主頁或者文檔首頁。
  • bugs:問題反饋系統的 URL,或者是 email 地址之類的鏈接,用戶通過該途徑向你反饋問題。
  • repository:代碼託管的位置。
  • contributors:貢獻者信息,可以是多個人。
  • files:項目包含的文件,可以是單獨的文件、整個文件夾,或者通配符匹配到的文件。
  • directories:當我們的包安裝時,可以指定確切的位置來放二進制文件、man pages、文檔、例子等。

創建一個package.json文件

我們可以通過 yarn init 來創建一個 package.json 文件,例如: 根據提示填寫 package.json 中的字段信息,最後會創建一個類似如下所示的文件,例如:

{
  "name": "xkd_yarn",
  "version": "1.0.0",
  "description": "hello xkd",
  "main": "index.js",
  "author": "xiakedao",
  "license": "MIT"
}

如果想要快速創建一個默認 package.json 文件,可以使用如下命令:

yarn init --yes

鏈接:https://www.9xkd.com/

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