我有一个简单的包裹。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注释。
当前回答
“脚本”中的命令是bash代码-我们可以注释bash:
"dedup": "yarn-deduplicate && yarn # TODO remove this on yarn/npm v2 because integrated"
奖励:当你运行它-你会看到评论:
其他回答
除了全局的//注释(或注释数组)之外，你还可以使用semver管道分隔符对特定依赖项进行注释。
"@types/node": "^16.11.7 || keep-same-major-version-as-node"
NPS(节点包脚本)为我解决了这个问题。它允许你把NPM脚本放到一个单独的JavaScript文件中，在那里你可以添加大量的注释和任何其他你需要的JavaScript逻辑。 https://www.npmjs.com/package/nps
来自我的一个项目的package-scripts.js示例
module.exports = {
scripts: {
// makes sure e2e webdrivers are up to date
postinstall: 'nps webdriver-update',
// run the webpack dev server and open it in browser on port 7000
server: 'webpack-dev-server --inline --progress --port 7000 --open',
// start webpack dev server with full reload on each change
default: 'nps server',
// start webpack dev server with hot module replacement
hmr: 'nps server -- --hot',
// generates icon font via a gulp task
iconFont: 'gulp default --gulpfile src/deps/build-scripts/gulp-icon-font.js',
// No longer used
// copyFonts: 'copyfiles -f src/app/glb/font/webfonts/**/* dist/1-0-0/font'
}
}
我只是做了一个本地安装npm安装nps -save-dev，并把它放在我的包。json脚本。
"scripts": {
"start": "nps",
"test": "nps test"
}
最近在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" }
必须注意，"//"只能在包的根目录下使用。json对象。例如 ｛ “/ /”:“评论!” “依赖”:{…} ｝ 是有效的但是 ｛ “依赖”:{ “/ /”:“评论?” ｝ ｝ 是无效的。 ——@david_p评论
我喜欢这个:
"scripts": {
"⏬⏬⏬ Jenkins Build - in this order ⏬⏬⏬ ": "",
"purge": "lerna run something",
"clean:test": "lerna exec --ignore nanana"
}
在命令名中有额外的空格，所以在Visual Studio Code的NPM Scripts插件中，你有更好的外观。
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.
