如何为npm install添加注释到package.json？

2018-05-30 03:32:09

我有一个简单的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休息时不起作用。我也尝试过//风格评论。

最近在node.js邮件列表中讨论了这个问题。

根据Isaac Schlueter创建的npm：

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

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

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

这是另一个用于在JSON中添加评论的黑客技术。以来：

{"a": 1, "a": 2}

相当于

{"a": 2}

你可以做一些事情：

{
  "devDependencies": "'mocha' not needed as should be globally installed",
  "devDependencies" :  {
    "should": "*"
  }
}

在浪费了一个小时的复杂和黑客解决方案后，我发现自己是一个非常简单，优雅且有效的解决方案，用于评论package.json庞大的依赖关系部分。像这样：

{
  "name": "package name",
  "version": "1.0",
  "description": "package description",
  "scripts": {
    "start": "npm install && node server.js"
  },
  "scriptsComments": {
    "start": "Runs development build on a local server configured by server.js"
  },
  "dependencies": {
    "ajv": "^5.2.2"
  },
  "dependenciesComments": {
    "ajv": "JSON-Schema Validator for validation of API data"
  }
}

当以同样的方式排序时，我现在可以非常容易地在git commit diffs中或者在使用package.json在编辑器中跟踪这些依赖关系/注释对。