2.7 KiB
2.7 KiB
Tasks — document-site-middleware-integration
1. Authoring
- 1.1 Read the original
add-api-plugin-siteproposal exclusion paragraph and confirm the no-hard-dep constraint. - 1.2 Author
proposal.mdwith### Source mapping+### Excluded from this change+### Affected dependents. - 1.3 Author the spec delta in
specs/api-plugin-site/spec.mdwith## ADDED Requirements+## MODIFIED Requirements.
2. Implementation
- 2.1 Add
src/integration/middleware-recommendations.tsexportingMiddlewareRecommendationtype +MIDDLEWARE_RECOMMENDATIONSconstant with one recommendation per route group (public-resolve, public-read, private-write). - 2.2 Add sibling
src/integration/middleware-recommendations.md(≥200 words, Purpose / Features / Basic / Advanced / API Reference / Implementation Notes). - 2.3 Add
src/integration/middleware-composition.integration.test.ts— real Hono app composingcreateAuditMiddleware,rateLimit, andcreatePrivateSiteRoutes; assert site behaviour preserved, rate-limit headers set, audit event recorded. - 2.4 Update
src/routes/private-routes.mdwith "Recommended middleware" section. - 2.5 Update
README.mdwith "Middleware composition" subsection linking the doc + recommendations. - 2.6 Add
docs/middleware-integration.md(package-level guide). - 2.7 Update
src/index.tsto re-exportMIDDLEWARE_RECOMMENDATIONSandMiddlewareRecommendation. - 2.8 Update
package.jsonto add@suaveplan/api-plugin-rate-limit+@suaveplan/api-plugin-auditasdevDependenciesonly. - 2.9 Update the
api-plugin-site.spec-conformance.test.tssurface count to include the new export.
3. Pre-archive gates
- 3.1
bunx biome check src/clean. - 3.2
bunx turbo lint typecheck test --filter=@suaveplan/api-plugin-sitegreen. - 3.3
bunx turbo test:coverage --filter=@suaveplan/api-plugin-site≥ 100% on every metric. - 3.4
bun scripts/openspec-conformance.ts @suaveplan/api-plugin-sitereturns 0 errors. - 3.5
bunx turbo build --filter=@suaveplan/api-plugin-sitegreen. - 3.6 Banned-pattern scan returns no hits (
@deprecated,TODO,FIXME,ts-ignore,ts-expect-error,.skip,.only,any,console.log). - 3.7 Test-runner import scan returns no hits (
from "vitest"/from "bun:test"). - 3.8 Sibling
.mdscan returns no missing-doc hits. - 3.9 No bare versions in
package.json.
4. Archive
- 4.1 Fold
specs/api-plugin-site/spec.mdintoopenspec/specs/api-plugin-site/spec.md. - 4.2
mv openspec/changes/document-site-middleware-integration openspec/archive/2026-05-19-document-site-middleware-integration.