Skip to content

TP-01 — Document Querya custom theme JSON schema #96

Description

@ZhuchkaTriplesix

Epic: A
Depends on: none

Source: docs/theme-parser-github-issues.md

Goal

Create public documentation for the new Querya custom theme JSON format (querya.theme.v1) before implementing the parser.

Context

Current docs/theme-import.md describes VS Code theme import. The new format must be documented separately so parser behavior is clear and testable.

Implementation

Create docs/theme-custom-json.md with:

  • purpose of the Querya custom format;
  • required root fields:
    • schema
    • id
    • name
    • type
    • shadcn_colors
    • editor_colors
  • optional root fields:
    • tokenColors
    • description
    • author
    • version
  • accepted type values: dark, light;
  • accepted color formats:
    • #RRGGBB
    • RRGGBB
    • #AARRGGBB
    • AARRGGBB
    • optionally #RGB / #RGBA if supported by existing parser;
  • fallback rules:
    • missing optional colors fallback to QueryaTheme.darkDefault / QueryaTheme.lightDefault;
    • invalid optional color is ignored;
    • missing required root field fails parsing;
    • broken selected theme falls back to Querya Dark on startup;
  • difference between VS Code JSON/JSONC and Querya custom JSON;
  • one minimal working example and one full example.

Update docs/theme-import.md with a short link to docs/theme-custom-json.md.

Acceptance Criteria

  • docs/theme-custom-json.md exists.
  • It includes a valid copy-pastable JSON example.
  • It explicitly says VS Code import remains supported.
  • It documents fallback/error behavior.

Tests

Docs only. No automated tests required.


Metadata

Metadata

Labels

documentationImprovements or additions to documentationgood first issueGood for newcomersthemeTheming, colors, VS Code themes

Type

No type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions