我有一个简单的包裹。json文件，我想添加一个评论。有办法做到这一点吗，或者有什么hack可以做到这一点吗?
{
"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崩溃时不起作用。我还尝试了// style注释。
当前回答
我有一个有趣的黑客想法。
创建一个适当的npm包名，作为文件包中的依赖项和devDependencies块的注释分隔符。Json，例如x----x----x
{
"name": "app-name",
"dependencies": {
"x----x----x": "this is the first line of a comment",
"babel-cli": "6.x.x",
"babel-core": "6.x.x",
"x----x----x": "this is the second line of a comment",
"knex": "^0.11.1",
"mocha": "1.20.1",
"x----x----x": "*"
}
}
注意:您必须在最后一个注释分隔行中添加一个有效的版本，如块中的*。
其他回答
我做了一些你们可能会喜欢的事情:
这个//在名字里面意味着它是我的注释:
"//":"Main and typings are used till ES5",
"//main": "build/index",
"//typings": "build/index",
除了全局的//注释(或注释数组)之外，你还可以使用semver管道分隔符对特定依赖项进行注释。
"@types/node": "^16.11.7 || keep-same-major-version-as-node"
正如这个答案所解释的，//键是保留的，所以它可以常规地用于注释。//注释的问题是它不实用，因为它不能被多次使用。在包上删除重复的密钥。Json自动更新:
"//": "this comment about dependencies stays",
"dependencies": {}
"//": "this comment disappears",
"devDependencies": {}
另一个问题是// comment不能在依赖项和devDependencies中使用，因为它被视为常规依赖项:
"dependencies": {
"//": "comment"
}
npm犯错!代码EINVALIDPACKAGENAME npm犯错!无效的包名“//”:名称只能包含url友好 字符
在NPM中工作的一个变通方法，而不是Yarn，是使用一个非字符串值:
"dependencies": {
"foo": ["unused package"],
}
一个在NPM和Yarn中工作的变通方法是添加一个注释作为语义版本控制的一部分:
"dependencies": {
"bar": "^2",
"foo": "^2 || should be removed in 1.x release"
}
注意，如果OR之前的第一部分不匹配，则可以解析来自注释的版本，例如1.x。
需要注释但没有安装的包应该移动到另一个键，例如dependencies //:
"dependencies //": {
"baz": "unused package",
}
以下是我对包内评论的看法。Json / bower.json:
我有文件package.json.js，其中包含一个脚本，导出实际的package.json。运行脚本将覆盖旧包。Json并告诉我它所做的更改，完美地帮助你跟踪NPM所做的自动更改。这样，我甚至可以通过编程方式定义我想要使用的包。
最新的Grunt任务如下: https://gist.github.com/MarZab/72fa6b85bc9e71de5991
As of pnpm 7.17.1, which was just released, you can switch to pnpm for package management, move your package.json to package.json5, and comments in package.json5 are allowed and will be preserved by pnpm. Note however that for publishing as a package to use on the npm registry (for example), a package.json5 will not be recognized by other package managers and I doubt by all of the registry's processing. So you would have to convert the package.json5 to a package.json before publishing. On the other hand, for "top-level applications" that are unlikely to be included as packages in other projects, a package.json5 seems to work just fine, as long as you then stick with pnpm as your package manager.
