描述

關(guān)于 package.json 文件中需要的內(nèi)容，您只需要了解這個文檔。
它必須是標準的JSON，而不是JavaScript對象字面量。

本文檔中描述的許多行為都受到npm-config中描述的配置設(shè)置的影響。

name

如果您計劃發(fā)布包，那么包中最重要的部分。json是名稱和版本字段，因為它們是必需的。名稱和版本一起構(gòu)成一個標識符，該標識符被認為是完全惟一的。對包的更改應(yīng)該與對版本的更改一起出現(xiàn)。如果不打算發(fā)布包，名稱和版本字段是可選的。
名字就是你的東西的名字。

規(guī)則：

• 名稱必須小于或等于214個字符。這包括作用域包的作用域。
• 名稱不能以點或下劃線開頭。
• 新包的名稱中不能有大寫字母。
• 該名稱最終成為URL、命令行上的參數(shù)和文件夾名稱的一部分。因此，名稱不能包含任何非url安全字符。

小貼士：

• 不要使用與核心節(jié)點模塊相同的名稱。
• 不要在名稱中使用“js”或“node”。假設(shè)它是js，因為您正在編寫一個包。json文件，您可以使用“engine”字段指定引擎。(見下文)。
• 名稱可能會作為參數(shù)傳遞給require()，所以它應(yīng)該是簡短的，但也應(yīng)該是合理的描述性的。
• 在過于依賴npm注冊表之前，您可能希望檢查npm注冊表，看看是否已經(jīng)有了這個名稱。https://www.npmjs.com/

名稱可以有選擇地用范圍作為前綴，例如@myorg/mypackage。有關(guān)詳細信息，請參見np -scope。

version

如果您計劃發(fā)布包，那么包中最重要的部分。json是名稱和版本字段，因為它們是必需的。名稱和版本一起構(gòu)成一個標識符，該標識符被認為是完全惟一的。對包的更改應(yīng)該與對版本的更改一起出現(xiàn)。如果不打算發(fā)布包，名稱和版本字段是可選的。

版本必須由node-semver解析，它與npm綁定為依賴項。（npm install semver to use it yourself.）

更多關(guān)于版本號和范圍的信息請訪問semver.

description

在里面放一段描述。它是一個字符串。這有助于人們發(fā)現(xiàn)你的包，因為它列在 npm search 結(jié)果里。

keywords

輸入關(guān)鍵詞。它是一個字符串數(shù)組。這有助于人們發(fā)現(xiàn)您的包，因為它列在npm search 結(jié)果里。