如何为 package.json 添加注释以进行 npm 安装？

小编典典

如何为 package.json 添加注释以进行 npm 安装？

all

我有一个简单的 package.json 文件，我想添加评论。有没有办法做到这一点，或者有任何黑客可以做到这一点？

{
  "name": "My Project",
  "version": "0.0.1",
  "private": true,
  "dependencies": {
    "express": "3.x",
    "mongoose": "3.x"
  },
  "devDependencies" :  {
    "should": "*"
    /* "mocha": "*" not needed as should be globally installed */
  }
}

上面的示例注释在 npm 中断时不起作用。我也尝试过 // 样式注释。

阅读 106

2022-03-14

共1个答案

小编典典

这最近在Node.js
邮件列表中进行了讨论。

根据创建 npm 的 Isaac Schlueter 的说法：

…“//”键永远不会被 npm 用于任何目的，并保留用于注释 …如果要使用多行注释，可以使用数组或多个“//”键。

使用常用工具（npm、yarn 等）时，将删除多个“//”键。这幸存下来：

{ "//": [
  "first line",
  "second line" ] }

这将无法生存：

{ "//": "this is the first line of a comment",
  "//": "this is the second line of the comment" }

2022-03-14