WORK-159
Setting up your dashboard 0 entities found · 7/31 branches scanned
ID:WORK-159Status:draft

Unified RefraktConfig types, loader, and JSON Schema

Promote refrakt.config.json from a site-only file into the unified root config defined in ADR-010. Add type-level support for plugins, plan, site, and sites, normalize the three valid input shapes (flat / singular site / plural sites) into a canonical internal form, and publish a JSON Schema so editors can autocomplete and validate the file.

Priority:highComplexity:moderateMilestone:v0.11.0Source:ADR-010
main View source

Criteria completion

Criteria completion: 0 of 10 (0%) checked; tracking started on May 1, no incremental history yet0%25%50%75%100%May 1Jun 15

Tracking started May 1 — check back for trends.

Relationships

Implements 1
Related 10
Branches 3
main current draft
claude/v0.11.0-config-foundation doneclaude/mcp-cli-wrapper-design-LsEXZ draftmain draft

Acceptance Criteria

  • RefraktConfig in @refrakt-md/types gains optional plugins: string[], plan: PlanConfig, site: SiteConfig, and sites: Record<string, SiteConfig> fields
  • Existing flat fields (contentDir, theme, target, packages, routeRules, icons, backgrounds, siteName, logo, baseUrl) stay on the type and are JSDoc-marked as deprecated shorthand for sites.default.*
  • Normalization lives in @refrakt-md/transform/node (the shared loader used by Astro / Nuxt / Next / Eleventy adapters); loadRefraktConfig() in that package returns a normalized config where sites is always populated (flat shape and singular site collapse to sites.default)
  • loadRefraktConfigFile() in packages/cli/src/config-file.ts is rewritten as a thin delegation to the transform/node loader so the CLI and adapters share one source of truth
  • Both loaders expose the original raw input alongside the normalized form (for the migration command and any tool that needs to round-trip)
  • Loader rejects files that declare both site and sites with a clear error message
  • Loader accepts a planning-only config ({ "plan": { "dir": "plan" } }) without complaint
  • refrakt.config.schema.json is published at the repo root and referenced from the package's files array; covers all three shapes and the plugins/plan/site/sites sections
  • Tests cover: flat shape, singular site, plural sites, plan-only, plan + sites, mutually-exclusive error, missing file fallback — exercised against both the transform/node loader and the CLI delegate
  • All existing call sites of loadRefraktConfig (in adapters) and loadRefraktConfigFile (in CLI) continue to work without changes (backwards-compatible normalization)

Approach

  1. Extend packages/types/src/ with PlanConfig and SiteConfig interfaces, then update RefraktConfig to include the new fields. Keep the flat fields for backwards compatibility but mark them @deprecated.

  2. Add a normalizeRefraktConfig(raw: RawRefraktConfig): NormalizedRefraktConfig helper in @refrakt-md/transform/node (alongside the existing loadRefraktConfig). The normalized shape always has sites: Record<string, SiteConfig> populated; flat-shape files produce { default: { contentDir, theme, target, packages, routeRules, icons, … } }.

  3. Update loadRefraktConfig in transform/node to call the normalizer and return { normalized, raw }. Existing consumers reading the flat shape continue to work because the normalized form preserves backwards-compatible accessors (or they get migrated as part of WORK-166's adapter updates).

  4. Update loadRefraktConfigFile in packages/cli/src/config-file.ts to import and delegate to the transform/node loader rather than parsing on its own.

  5. Author the JSON Schema by hand from the TypeScript types; it does not need to be auto-generated for v1. Use oneOf to express the singular-vs-plural exclusivity.

  6. Add a $schema reference at the top of site/refrakt.config.json after WORK-172 lands so editors pick it up automatically.

Dependencies

  • None. This is the foundation other items in v0.11.0 build on.

References

  • ADR-010 — Unified root-level refrakt config
  • packages/transform/src/node.ts (or wherever loadRefraktConfig lives) — shared loader for adapters
  • packages/cli/src/config-file.ts — CLI loader to delegate
  • packages/types/src/ — where RefraktConfig lives
  • packages/astro/src/integration.ts, packages/nuxt/src/module.ts — current adapter consumers of loadRefraktConfig
  • site/refrakt.config.json — current flat-shape example