VSCode で JSON ファイル内のコメント問題（Comments are not permitted in JSON）の対応方法覚書

VS Code で JSON ファイル内のコメント問題（Comments are not permitted in JSON）の解決方法

概要

JSON ファイルにコメントを当てると Comments are not permitted in JSON という Issue 扱いになってしまう。

結論

設定の Files: Associations で *.json に jsonc を関連付ける

1. ⌘ + , で設定を開き Files: Associations で検索
2. 項目: *.json を入力
3. 値: jsonc を入力 -> OK

settings.json での指定

settings.json

"files.associations": {
  "*.json": "jsonc"
}

安全な方法

ただし本来 JSON ファイルはコメントは許可されていないのでこの方法はやや強引かもしれない。
アプリやパッケージ上での JSON ファイルの扱い次第ではコメントを入れるとエラーが発生する可能性があるので、そのあたりを理解していれば問題はないがもう少し慎重にやるとすれば上記の方法を踏まえ、

• ユーザーではなくワークスペースごとに設定する
• **/src/**/manifest.json 等、ファイル名やパスを適宜指定し特定のファイルのみに適用する

としてしまう方が安全。

settings.json での指定

settings.json

"files.associations": {
  "**/src/**/manifest.json": "jsonc"
}

その他の解決方法

「言語モードの選択」で jsonc (JSON With Comments) に変更する

1. VS Code 画面右下の JSON を選択
2. 「言語モードの選択」に jsonc を入力し Enter

この方法の場合は言語モードを一時的に変更するだけで、設定自体は保存されない。
そのためファイルを開き直すと JSON に戻ってしまう。