目前实际上 npm 仍然未允许在 package.json 中添加行或块注释,所以请不要在 package.json 文件中添加注释,否则将直接影响你的node.js 或 包管理器的运行。
本文只是针对 IDE 或编辑器的一个设置,如果一个 JSON 文件,将要被其他程序读取,那么请确保:
- 你的读取程序已经支持的 jsonc
- 或者在进行 json 解析前,对行或块注释进行提取,正则表达式也很简单
JetBrains 设置
JetBrains 有两种方式实现:
方法1:通过编辑器语法检查设置
方法2:通过文件类型设置
基本思路:
- 将
*.json
设置为 JSON5 类型 - 将
package.json
设置为 JSON 类型
实际上也可以反过来:
- 啥都不用改
- 将你要支持 JSONC 的文件名,添加进 JSON5,比如:
rush.json
VSCode 设置
在 VSCode 设置中搜索 files.associations
添加:
{
"*.json": "jsonc",
"package.json": "json"
}
通过界面设置也是一样的:
这样所有 json 文件采用 jsonc ,而 package.json 使用 json。