JSONC

JSONC (JSON with Comments) ist eine JSON-Variante, die Kommentare erlaubt, hauptsächlich für die VS-Code-Konfiguration (tsconfig, settings.json) genutzt.

Zweck

Kommentare in JSON erlauben, damit Konfigurationsdateien Erläuterungen tragen und die Wartbarkeit steigt.

Mechanismus

Über JSON hinaus erlaubt es einzeilige //- und mehrzeilige /* */-Kommentare; der Rest der Syntax ist JSON. VS Code und der TypeScript-Compiler unterstützen es. Manche Implementierungen erlauben auch nachgestellte Kommas.

Anwendungsfälle

VS-Code settings.json
tsconfig.json
ESLint-Konfiguration
IDE-Konfigurationsdateien

Beispiele

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

Häufige Fehler

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

Verwandte Begriffe

JSON (JavaScript Object Notation) ist ein leichtgewichtiges Datenaustauschformat auf Basis von JavaScript-Objektliteralen, das Schlüssel-Wert-Paare und Arrays nutzt.

JSON5 ist eine Obermenge von JSON, die Single-Quotes, Schlüssel ohne Anführungszeichen, Kommentare, nachgestellte Kommas, NaN/Infinity und Hexadezimalzahlen erlaubt — besser für handeditierte Konfiguration.

HJSON (Human JSON) ist ein menschenorientiertes JSON-Format, das Kommentare, Schlüssel und Werte ohne Anführungszeichen, mehrzeilige Zeichenketten und nachgestellte Kommas erlaubt und die Lesbarkeit betont.

Verwandte Tools

JSON-Formatierer

Format, minify, or sort JSON online. Kostenlos, privat und 100% clientseitig.

JSONC-Formatierer

Jsonc Format — reines Client-seitiges Tool. Datenschutz zuerst, kein Server-Roundtrip.

JSONC-Validator

Jsonc Validate — reines Client-seitiges Tool. Datenschutz zuerst, kein Server-Roundtrip.

JSONC Parser — reines Client-seitiges Tool. Datenschutz zuerst, kein Server-Roundtrip.

JSONC-Serialisierung

JSONC Stringify — reines Client-seitiges Tool. Datenschutz zuerst, kein Server-Roundtrip.

References