讓 JetBrains IDE 和 VSCode 支持 JSON 註釋(JSONC - JSON with comment)

目前實際上 npm 仍然未允許在 package.json 中添加行或塊註釋,所以請不要在 package.json 文件中添加註釋,否則將直接影響你的node.js 或 包管理器的運行。

本文只是針對 IDE 或編輯器的一個設置,如果一個 JSON 文件,將要被其他程序讀取,那麼請確保:

  1. 你的讀取程序已經支持的 jsonc
  2. 或者在進行 json 解析前,對行或塊註釋進行提取,正則表達式也很簡單

JetBrains 設置

JetBrains 有兩種方式實現:

方法1:通過編輯器語法檢查設置

image-20220319004518717

方法2:通過文件類型設置

基本思路:

  1. *.json 設置爲 JSON5 類型
  2. package.json 設置爲 JSON 類型

image-20220319005304866

image-20220319005323293

實際上也可以反過來:

  1. 啥都不用改
  2. 將你要支持 JSONC 的文件名,添加進 JSON5,比如:rush.json

VSCode 設置

在 VSCode 設置中搜索 files.associations 添加:

{
    "*.json": "jsonc",
    "package.json": "json"
}

通過界面設置也是一樣的:

image-20220319004747811

這樣所有 json 文件採用 jsonc ,而 package.json 使用 json。

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章