JSONC

JSONC（JSON with Comments）はコメントを許可する JSON の変種である。主に VS Code の設定（tsconfig、settings.json）に使われる。

目的

JSON にコメントを許可し、設定ファイルに説明を持たせて保守性を高める。

メカニズム

JSON の上に、// 単行コメントと /* */ 複数行コメントを許可する。それ以外の構文は JSON である。VS Code と TypeScript コンパイラがサポートする。実装によっては末尾カンマも許可される。

ユースケース

VS Code の settings.json
tsconfig.json の記述
ESLint のコンフィグ
IDE 設定ファイル

例

入力
```
{// comment
"a":1}
```
Output
```
The object {a:1}
```
Comments are allowed

よくあるエラー

A standard JSON parser fails on JSONC: Use a comment-aware parser such as jsonc-parser

関連用語

JSON（JavaScript Object Notation）は、JavaScript のオブジェクトリテラルに基づく軽量なデータ交換形式である。キー・バリューペアと配列を使う。

JSON5 は JSON のスーパーセットである。単一引用符、引用符なしキー、コメント、末尾カンマ、NaN/Infinity、16 進数を許可し、手書きの設定に向く。

HJSON（Human JSON）は人間向けの JSON 形式であり、コメント、クォートなしのキーと値、複数行文字列、末尾カンマを許可し、可読性を重視する。

関連ツール

JSON フォーマッター

Format, minify, or sort JSON online。無料、プライベート、100%クライアントサイド。

JSONC フォーマッター

Jsonc Format — 純クライアントサイドツール。プライバシーファースト、サーバー往復なし。

JSONC バリデーター

Jsonc Validate — 純クライアントサイドツール。プライバシーファースト、サーバー往復なし。

JSONC パーサー

JSONC Parser — 純クライアントサイドツール。プライバシーファースト、サーバー往復なし。

JSONC 文字列生成

JSONC Stringify — 純クライアントサイドツール。プライバシーファースト、サーバー往復なし。

References