npm 的 package.json 简介

描述

关于 package.json 文件中需要的内容，您只需要了解这个文档。
它必须是标准的JSON，而不是JavaScript对象字面量。

本文档中描述的许多行为都受到npm-config中描述的配置设置的影响。

name

如果您计划发布包，那么包中最重要的部分。json是名称和版本字段，因为它们是必需的。名称和版本一起构成一个标识符，该标识符被认为是完全惟一的。对包的更改应该与对版本的更改一起出现。如果不打算发布包，名称和版本字段是可选的。
名字就是你的东西的名字。

规则：

• 名称必须小于或等于214个字符。这包括作用域包的作用域。
• 名称不能以点或下划线开头。
• 新包的名称中不能有大写字母。
• 该名称最终成为URL、命令行上的参数和文件夹名称的一部分。因此，名称不能包含任何非url安全字符。

小贴士：

• 不要使用与核心节点模块相同的名称。
• 不要在名称中使用“js”或“node”。假设它是js，因为您正在编写一个包。json文件，您可以使用“engine”字段指定引擎。(见下文)。
• 名称可能会作为参数传递给require()，所以它应该是简短的，但也应该是合理的描述性的。
• 在过于依赖npm注册表之前，您可能希望检查npm注册表，看看是否已经有了这个名称。https://www.npmjs.com/

名称可以有选择地用范围作为前缀，例如@myorg/mypackage。有关详细信息，请参见np -scope。

version

如果您计划发布包，那么包中最重要的部分。json是名称和版本字段，因为它们是必需的。名称和版本一起构成一个标识符，该标识符被认为是完全惟一的。对包的更改应该与对版本的更改一起出现。如果不打算发布包，名称和版本字段是可选的。

版本必须由node-semver解析，它与npm绑定为依赖项。（npm install semver to use it yourself.）

更多关于版本号和范围的信息请访问semver.

description

在里面放一段描述。它是一个字符串。这有助于人们发现你的包，因为它列在 npm search 结果里。

keywords

输入关键词。它是一个字符串数组。这有助于人们发现您的包，因为它列在npm search 结果里。