GitHub - tailscale/hujson: HuJSON: JSON for Humans (JWCC: JSON w/ comments and trailing commas) (original) (raw)

HuJSON - "Human JSON" (JWCC)

Go Reference

The github.com/tailscale/hujson package implements the JWCC extension of standard JSON.

The JWCC format permits two things over standard JSON:

  1. C-style line comments and block comments intermixed with whitespace,
  2. allows trailing commas after the last member/element in an object/array.

All JSON is valid JWCC.

For details, see the JWCC docs at:

https://nigeltao.github.io/blog/2021/json-with-commas-comments.html

Formatting with hujsonfmt

hujsonfmt is a program that formats HuJSON files. Install it by running:

go install github.com/tailscale/hujson/cmd/hujsonfmt@latest

Visual Studio Code association

Visual Studio Code supports a similar jsonc (JSON with comments) format. To treat all *.hujson files as jsonc with trailing commas allowed, you can add the following snippet to your Visual Studio Code configuration:

"files.associations": { ".hujson": "jsonc" }, "json.schemas": [{ "fileMatch": [".hujson"], "schema": { "allowTrailingCommas": true } }]