Saltar al contenido
uencoder

JSONC

JSONC (JSON with Comments) es una variante de JSON que permite comentarios, usada principalmente para la configuración de VS Code (tsconfig, settings.json).

Propósito

Permitir comentarios en JSON para que los archivos de configuración lleven explicaciones, mejorando la mantenibilidad.

Mecanismo

Sobre JSON permite comentarios // de una línea y /* */ multilínea; el resto de la sintaxis es JSON. Lo soportan VS Code y el compilador de TypeScript. Algunas implementaciones también permiten comas finales.

Casos de uso

  • settings.json de VS Code
  • tsconfig.json
  • Configuración de ESLint
  • Archivos de configuración de IDE

Ejemplos

  • entrada
    {// comment
    "a":1}
    Output
    The object {a:1}

    Comments are allowed

Errores comunes

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

Términos relacionados

Herramientas relacionadas

References