簡單產生 package.json 的方法

簡單產生 package.json 的方法

---

手動加入

規範

• name(名稱)
• 全部小寫
• 一個詞
• 不能用空白，可以用底線[ _ ]跟虛線[ - ]
• version(版本)
• 以x.x.x的形式
• 遵循semver規範(可以參考https://semver.org/lang/zh-TW/)

{

  "name": "my-awesome-package",

  "version": "1.0.0"

}

手動寫一個簡單的package.json，新增一個筆記本然後把上面的代碼貼進去後，把檔名更改成package.json

---

使用npm自動產生

我是使用npm指令的所以需要先安裝npm，然後結果就是把Node.js安裝起來就有npm了~(https://www.npmjs.com/get-npm)

---

要產出基本的package.json先切換到需要輸出的資料夾，輸入指令 >npm init --yes

---

產出的檔案長這樣

• name：當前目錄名稱
• version：總是 1.0.0
• description：自述文件中的信息，或者一個空字符串 ""
• main：總是 index.js
• scripts：默認情況下會創建一個空test腳本
• keywords：空的
• author：空的
• license： ISC
• bugs：來自當前目錄的信息（如果存在）
• homepage：來自當前目錄的信息（如果存在）

---

配置（npm init）

這些默認值已經提供給npm init無init-module。

作者姓名： init-author-name

• 默認：“”
• 類型：字符串

該值npm init應該默認用於包作者的名字。

npm set init-author-name="Your Name"

作者電郵： init-author-email

• 默認：“”
• 類型：字符串

該值npm init應該默認用於包作者的電子郵件。

npm set init-author-name="your@email.com"

作者網址： init-author-url

• 默認：“”
• 類型：字符串

該值npm init應該在包作者的主頁中默認使用。

npm set init-author-url="http://yoursite.com"

執照 init-license

• 默認：“ISC”
• 類型：字符串

該值npm init應該默認用於軟件包許可證。

npm set init-license="BSD-2-Clause"

許可證名稱必須是有效的SPDX許可證表達式。有關更多信息，請參閱https://spdx.org/licenses。

版 init-version

• 默認值：“1.0.0”
• 類型：semver

該值npm init應該默認軟件包版本號使用，如果在尚未設置package.json。

npm set init-version="1.0.0"

配置（init-module）

這些默認值需要init-module為了在中可用npm init。

測試腳本： init-scripts-start

• 默認值：null
• 類型：字符串

運行時使用的命令npm start。

npm set init-scripts-start="node ."

測試腳本： init-scripts-test

• 默認值：'echo'錯誤：未指定測試“&& exit 1'
• 類型：字符串

運行時使用的命令npm test。

npm set init-scripts-test="standard"

---

如果要產出比較詳細的package.json，先用以上參數設定好後他會設定為預設值(Default)下次產生時就會自動帶出以上資訊，設定好後一樣使用>npm init --yes來產生package.json。

PS.我有這裡測試有個問題就是設定完畢後還是一直沒有輸入設定的資訊，就可以把package.json刪除重新產生一次就可以了。

---

如果手動設定輸出資訊的部分可以用>npm init

---

參考

https://docs.npmjs.com/getting-started/using-a-package.json

https://www.npmjs.com/package/init-module