Skip to content

AGENTS.md

Latest commit

 

History

History
33 lines (26 loc) · 1.54 KB

AGENTS.md

File metadata and controls

33 lines (26 loc) · 1.54 KB
Raw

AGENTS.md

Project structure

Synthpunk is a synthwave-inspired color scheme that ships as themes for multiple tools. All theme artifacts are generated from a single palette source.

  • palette/ — source-of-truth color palette data (the only place to edit colors)
  • generator/ — TypeScript theme-generation engine (run via bun run build)
  • themes/ — generated artifacts, one subdirectory per target:
    • vscode/ — VS Code extension package
    • zed/ — Zed extension package
    • neovim/ — Neovim colorscheme (Lua)
    • wezterm/ — WezTerm color scheme files (TOML)
    • starship/ — Starship prompt config (TOML)
  • scripts/ — release tooling (version bumping)
  • tests/ — cross-target tests (version lockstep)
  • assets/ — preview images for the README
  • schemas/ — JSON schemas for palette files

Commands

bun install          # install dependencies
bun run build        # regenerate all theme artifacts from palette/
bun test             # run all tests
bun run check        # biome lint/format + tsc typecheck
bun run format       # auto-format with biome

Key rules

  • Never edit themes/** directly. These files are generated. Edit palette/ and generator/, then run bun run build. CI enforces that committed artifacts match generator output.
  • Version lockstep. The version in package.json, themes/vscode/package.json, and themes/zed/extension.toml must always match. Use bun scripts/bump-version.ts <version> to bump all at once. The lockstep is enforced by tests/lockstep.test.ts.