package.json 文件

中英双语

您需要在项目的根目录中有一个 package.json 文件才能使用 npm 执行大部分操作。这基本上是整个界面。

有关该文件中内容的详细信息,请参见 package.json。至少,您需要:

  • name:这应该是一个标识您的项目的字符串。请不要使用名称来指定它在 node 上运行,或者在 JavaScript 中。您可以使用 "engines" 字段来明确说明程序所需的 node 版本(或其他任何版本),并且可以很好地假设它是 JavaScript。

    它不一定需要与您的 github 存储库名称匹配。

    所以,node-foobar-js 是坏名字。foobar 更好。

  • 版本:与 semver 兼容的版本。

  • 引擎:指定程序运行的 node(或其他)版本。Node API 变化很大,可能存在您依赖的错误或新功能。明确。

  • 作者:拿点功劳。

  • scripts:如果你有特殊的编译或安装脚本,那么你应该把它放在 scripts 对象中。您绝对应该至少有一个基本的烟雾测试命令作为 "scripts.test" 字段。见 脚本

  • main:如果你有一个模块作为程序的入口点(就像 "foo" 包在 require("foo") 中给你的那样),那么你需要在 "main" 字段中指定它。

  • 目录:这是一个将名称映射到文件夹的对象。最好包括 "lib" 和 "doc",但如果您使用 "man" 指定一个充满手册页的文件夹,它们将像这些一样被安装。

您可以在包的根目录中使用 npm init,以便开始使用非常基本的 package.json 文件。有关详细信息,请参阅 npm init