JSONC

JSONC (JSON with Comments) est une variante de JSON autorisant les commentaires, utilisée principalement pour la configuration de VS Code (tsconfig, settings.json).

Objectif

Autoriser les commentaires en JSON pour que les fichiers de configuration portent des explications, améliorant la maintenabilité.

Mécanisme

Par-dessus JSON, il autorise les commentaires monolignes // et multilignes /* */ ; le reste de la syntaxe est JSON. VS Code et le compilateur TypeScript le prennent en charge. Certaines implémentations tolèrent aussi les virgules finales.

Cas d’usage

settings.json de VS Code
tsconfig.json
Configuration ESLint
Fichiers de configuration d'IDE

Exemples

entrée
```
{// comment
"a":1}
```
Output
```
The object {a:1}
```
Comments are allowed

Erreurs courantes

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

Termes associés

JSON (JavaScript Object Notation) est un format léger d'échange de données fondé sur les littéraux d'objets JavaScript, utilisant paires clé-valeur et tableaux.

JSON5 est un sur-ensemble de JSON qui autorise apostrophes, clés sans guillemets, commentaires, virgules finales, NaN/Infinity et nombres hexadécimaux, le rendant meilleur pour la configuration écrite à la main.

HJSON (Human JSON) est un format JSON orienté humain qui autorise commentaires, clés et valeurs sans guillemets, chaînes multilignes et virgules finales, privilégiant la lisibilité.

Outils associés

Format, minify, or sort JSON online. Gratuit, privé et 100% côté client.

Formateur JSONC

Jsonc Format — outil 100% côté client. Confidentialité d'abord, sans aller-retour serveur.

Validateur JSONC

Jsonc Validate — outil 100% côté client. Confidentialité d'abord, sans aller-retour serveur.

Analyseur JSONC

JSONC Parser — outil 100% côté client. Confidentialité d'abord, sans aller-retour serveur.

Sérialiseur JSONC

JSONC Stringify — outil 100% côté client. Confidentialité d'abord, sans aller-retour serveur.

References