Files
2026-05-27 23:29:53 +01:00

2.2 KiB

Tasks — @suaveplan/api-openapi-ui-redoc

0. Pre-flight (non-negotiable)

  • 0.1 Confirm clean working tree
  • 0.2 Worktree accounted for
  • 0.3 MANIFEST.md drift check

1. Spec authoring

  • 1.1 Read design doc (§7)
  • 1.2 Read openspec/AGENTS.md Sections 13 and 14
  • 1.3 Draft proposal.md
  • 1.4 Draft specs/api-openapi-ui-redoc/spec.md
  • 1.5 Every requirement carries **Verified by:**

2. Implementation

  • 2.1 Scaffold packages/api-stack/api/api-openapi-ui-redoc/
  • 2.2 src/handler/ — createRedocUiHandler
  • 2.3 src/per-plugin/ — createPerPluginRedocUiHandler
  • 2.4 src/options/ — RedocUiOptions Zod schema
  • 2.5 src/assets/ — cdn/bundled/inline resolver
  • 2.6 src/error-codes/ folder (CLAUDE.md no-flat-modules rule)
  • 2.7 src/index.ts — explicit named re-exports + side-effect import

3. Tests

  • 3.1 src/handler/handler.test.ts
  • 3.2 src/per-plugin/per-plugin.test.ts
  • 3.3 src/assets/assets.test.ts
  • 3.4 tests/dep-graph.test.ts
  • 3.5 Every it(...) carries { timeout: 5000 }

4. Documentation

  • 4.1 Sibling .md per implementation .ts
  • 4.2 README.md ## Modules
  • 4.3 Update CLAUDE.md package listing

5. Pre-archive verification (the 5-gate triple)

  • 5.1 bun run check
  • 5.2 bunx turbo lint typecheck test --filter=@suaveplan/api-openapi-ui-redoc
  • 5.3 bunx turbo test:coverage --filter=@suaveplan/api-openapi-ui-redoc — 100/100/100/100
  • 5.4 bun scripts/openspec-conformance.ts packages/api-stack/api/api-openapi-ui-redoc
  • 5.5 bunx turbo build --filter=@suaveplan/api-openapi-ui-redoc

6. Pre-archive 7-row checklist

  • 6.1 Generics threaded for typed options
  • 6.2 Zod schemas wired at host-config ingestion
  • 6.3 Every OPENAPI_UI_REDOC.* code thrown by a production path
  • 6.4 Strict-mode: bundled mode without asset raises
  • 6.5 OTel — n/a
  • 6.6 Lifecycle dedup — handler is idempotent
  • 6.7 No retroactive tick

7. Archive

  • 7.1 Fold spec delta into openspec/specs/api-openapi-ui-redoc/spec.md
  • 7.2 Move folder to archive
  • 7.3 Tick 8.9 in umbrella tasks
  • 7.4 Refresh MANIFEST.md