Skip to content

Health

Health analyzes the active document and presents a vitality-style report: score, status, metrics, and actionable findings.

Valid JSON can still be a problem. Deep nesting, inconsistent property types, oversized arrays, mixed naming styles, and sparse null-heavy leaves all create maintenance cost. Health surfaces those signals early, while the document is still easy to change.

Health dock showing a score of 100, node and size metrics, and a structure breakdown
Health scores the open document and breaks the same file into nodes, depth, size, and value counts.

Open Health

Right dock → Health

The panel updates as the document changes. Use refresh for an immediate pass, and Copy health report for a plain-text summary.

Status model

Status Meaning
Healthy No concerning findings, or only informational notes
Needs Attention Warnings or errors in structure, consistency, performance, or style
Invalid JSON The document does not parse; fix syntax first

Invalid documents can still show limited stats and a clear path into the Errors dock via View Errors.

What the report contains

Hero

  • Score visualization
  • Status label and short hint
  • Quick jump to Errors when the document is invalid

Metrics

Tiles and sections summarize document shape, including counts such as nodes, depth, objects, arrays, and related size signals. Section labels in the UI include areas such as STRUCTURE, VALUES, ARRAYS, EMPTY, and SIZE.

Findings

Findings are categorized roughly as:

Category Examples of concern
Validity Parse failure
Structure Extreme nesting depth
Consistency Mixed types for the same property name, unstable array object shapes
Performance Very large node counts, large arrays, long strings
Style Naming inconsistency, high null ratios among leaves

Click a finding to reveal the related location in the editor when a source index or JSON path is available.

Practical use

Before committing a content pack:

  1. Open the document in Documents
  2. Confirm Errors is clean
  3. Review Health status and findings
  4. Click through warnings that affect shared keys or array shapes
  5. Copy the report into a review note if teammates need context

Health is guidance for craft quality, not a replacement for schema validation. Use Schema when you need a formal contract.