create-fullstack-scaffold 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (530) hide show
  1. package/README.md +154 -0
  2. package/dist/cli/index.d.ts +2 -0
  3. package/dist/cli/index.js +439 -0
  4. package/dist/cli/index.js.map +1 -0
  5. package/package.json +171 -0
  6. package/template/.agents/skills/writing-hookify-rules/SKILL.md +408 -0
  7. package/template/.ai-context.md +368 -0
  8. package/template/.claude/hookify.block-dangerous-commands.local.md +41 -0
  9. package/template/.claude/hookify.check-api-types.local.md +111 -0
  10. package/template/.claude/hookify.check-duplicate-types.local.md +287 -0
  11. package/template/.claude/hookify.check-test-assertions.local.md +93 -0
  12. package/template/.claude/hookify.remind-add-tests.local.md +209 -0
  13. package/template/.claude/hookify.remind-db-migration.local.md +58 -0
  14. package/template/.claude/hookify.remind-run-tests.local.md +52 -0
  15. package/template/.claude/hookify.warn-any-type.local.md +203 -0
  16. package/template/.claude/hookify.warn-console-log.local.md +73 -0
  17. package/template/.claude/rules/00-project-config.md +147 -0
  18. package/template/.claude/rules/01-file-types.md +127 -0
  19. package/template/.claude/rules/02-git-workflow.md +167 -0
  20. package/template/.claude/rules/10-api-type-inference.md +555 -0
  21. package/template/.claude/rules/20-server-api.md +349 -0
  22. package/template/.claude/rules/21-server-entrypoint.md +257 -0
  23. package/template/.claude/rules/30-client-components.md +314 -0
  24. package/template/.claude/rules/31-client-services.md +768 -0
  25. package/template/.claude/rules/32-client-state-zustand.md +324 -0
  26. package/template/.claude/rules/33-client-app-entry.md +276 -0
  27. package/template/.claude/rules/34-client-admin-module.md +445 -0
  28. package/template/.claude/rules/35-cli-module.md +259 -0
  29. package/template/.claude/rules/40-admin-module.md +495 -0
  30. package/template/.claude/rules/40-shared-types.md +450 -0
  31. package/template/.claude/rules/50-websocket.md +245 -0
  32. package/template/.claude/rules/51-sse.md +372 -0
  33. package/template/.claude/rules/52-cloudflare-realtime.md +384 -0
  34. package/template/.claude/rules/60-testing-standards.md +245 -0
  35. package/template/.claude/rules/61-hono-testing.md +200 -0
  36. package/template/.claude/scripts/README.md +187 -0
  37. package/template/.claude/scripts/check-duplicate-types.ts +188 -0
  38. package/template/.claude/scripts/post-edit-check-incremental.sh +61 -0
  39. package/template/.claude/scripts/post-edit-check.sh +22 -0
  40. package/template/.claude/scripts/pre-tool-use-check.sh +86 -0
  41. package/template/.claude/scripts/test-pre-tool-use.sh +73 -0
  42. package/template/.claude/scripts/validate-git-changes.sh +38 -0
  43. package/template/.claude/settings.json +32 -0
  44. package/template/.claude/skills/writing-hookify-rules/SKILL.md +408 -0
  45. package/template/.dev-context-compact.md +54 -0
  46. package/template/.dev-context.md +621 -0
  47. package/template/.dev-guide.md +243 -0
  48. package/template/.env.example +60 -0
  49. package/template/.eslintrc.routes.json +39 -0
  50. package/template/.husky/_/husky.sh +27 -0
  51. package/template/.husky/commit-msg +4 -0
  52. package/template/.husky/post-commit +4 -0
  53. package/template/.husky/pre-commit +19 -0
  54. package/template/.husky/pre-push +12 -0
  55. package/template/.prettierignore +22 -0
  56. package/template/.prettierrc +8 -0
  57. package/template/.sessions/3/2026-03-26T05-41-09-154Z_03bb597f-3898-4a2e-8c08-5746bbe8d95e.jsonl +18 -0
  58. package/template/.sessions/3/2026-03-26T05-48-30-052Z_12de4774-9cb3-494c-9852-bd1e6b0003c3.jsonl +6 -0
  59. package/template/.vscode/extensions.json +8 -0
  60. package/template/.vscode/settings.json +4 -0
  61. package/template/.workspaces/3/hello.py +1 -0
  62. package/template/.wrangler/state/v3/d1/miniflare-D1DatabaseObject/803c2e37182b913f8857edf6d8776515cef4af6d48fcb25913e457f4b14ffa97.sqlite +0 -0
  63. package/template/.wrangler/state/v3/d1/miniflare-D1DatabaseObject/803c2e37182b913f8857edf6d8776515cef4af6d48fcb25913e457f4b14ffa97.sqlite-shm +0 -0
  64. package/template/.wrangler/state/v3/d1/miniflare-D1DatabaseObject/803c2e37182b913f8857edf6d8776515cef4af6d48fcb25913e457f4b14ffa97.sqlite-wal +0 -0
  65. package/template/CLAUDE.md +296 -0
  66. package/template/DESIGN.md +260 -0
  67. package/template/DEV_CONTEXT_GUIDE.md +366 -0
  68. package/template/DEV_TOOLS_README.md +396 -0
  69. package/template/FRAMEWORK_HISTORY.md +34 -0
  70. package/template/PROJECT_SUMMARY.md +325 -0
  71. package/template/QUICKSTART.md +305 -0
  72. package/template/README.md +154 -0
  73. package/template/STRUCTURE.txt +81 -0
  74. package/template/admin.html +13 -0
  75. package/template/auth-inject.html +33 -0
  76. package/template/commitlint.config.js +12 -0
  77. package/template/docs/PERMISSION_ARCHITECTURE.md +279 -0
  78. package/template/docs/PERMISSION_EXAMPLES.md +230 -0
  79. package/template/docs/PERMISSION_SYSTEM.md +301 -0
  80. package/template/docs/SMART_TEST.md +171 -0
  81. package/template/docs/runtime-abstract.md +253 -0
  82. package/template/drizzle/0000_rainy_boomer.sql +101 -0
  83. package/template/drizzle/0001_add_todo_attachments.sql +12 -0
  84. package/template/drizzle/0002_chilly_magneto.sql +89 -0
  85. package/template/drizzle/meta/0000_snapshot.json +652 -0
  86. package/template/drizzle/meta/0001_snapshot.json +735 -0
  87. package/template/drizzle/meta/0002_snapshot.json +1198 -0
  88. package/template/drizzle/meta/_journal.json +27 -0
  89. package/template/drizzle.config.ts +13 -0
  90. package/template/eslint-rules/README-no-middleware-in-routes.md +154 -0
  91. package/template/eslint-rules/__tests__/enforce-valid-method.test.ts +251 -0
  92. package/template/eslint-rules/__tests__/layer-boundary.test.ts +102 -0
  93. package/template/eslint-rules/__tests__/module-boundary.test.ts +77 -0
  94. package/template/eslint-rules/__tests__/no-direct-zod-import-in-file-routes.test.ts +45 -0
  95. package/template/eslint-rules/__tests__/no-new-old-service-naming.test.ts +76 -0
  96. package/template/eslint-rules/e2e-test-location.js +153 -0
  97. package/template/eslint-rules/enforce-valid-method.js +217 -0
  98. package/template/eslint-rules/flat-routes-services.js +69 -0
  99. package/template/eslint-rules/framework-protect.js +186 -0
  100. package/template/eslint-rules/layer-boundary.js +164 -0
  101. package/template/eslint-rules/limit-type-complexity.js +130 -0
  102. package/template/eslint-rules/middleware-location.js +162 -0
  103. package/template/eslint-rules/module-boundary.js +125 -0
  104. package/template/eslint-rules/no-ambiguous-file-paths.js +64 -0
  105. package/template/eslint-rules/no-any-on-apiclient.js +173 -0
  106. package/template/eslint-rules/no-boolean-success.js +43 -0
  107. package/template/eslint-rules/no-deep-relative-imports.js +69 -0
  108. package/template/eslint-rules/no-direct-fetch.js +122 -0
  109. package/template/eslint-rules/no-direct-ws-sse.js +57 -0
  110. package/template/eslint-rules/no-direct-zod-import-in-file-routes.js +54 -0
  111. package/template/eslint-rules/no-disable-direct-fetch.js +57 -0
  112. package/template/eslint-rules/no-disable-type-safe-client.js +58 -0
  113. package/template/eslint-rules/no-inline-schema.js +220 -0
  114. package/template/eslint-rules/no-middleware-in-routes.js +81 -0
  115. package/template/eslint-rules/no-new-old-service-naming.js +123 -0
  116. package/template/eslint-rules/no-type-assertion-in-rpc.js +99 -0
  117. package/template/eslint-rules/no-type-assertion-on-shared-types.js +109 -0
  118. package/template/eslint-rules/no-util-functions-in-service.js +128 -0
  119. package/template/eslint-rules/prefer-shared-types.js +352 -0
  120. package/template/eslint-rules/protect-ws-sse-interface.js +66 -0
  121. package/template/eslint-rules/require-antd-generic-types.js +73 -0
  122. package/template/eslint-rules/require-file-openapi-props.js +114 -0
  123. package/template/eslint-rules/require-hono-chain-syntax.js +129 -0
  124. package/template/eslint-rules/require-nullable-for-optional.js +99 -0
  125. package/template/eslint-rules/require-response-helpers.js +140 -0
  126. package/template/eslint-rules/require-type-safe-test-client.js +106 -0
  127. package/template/eslint-rules/route-location.js +72 -0
  128. package/template/eslint.config.js +231 -0
  129. package/template/index.html +17 -0
  130. package/template/lint-scripts/DIRECTORY_RULES.md +335 -0
  131. package/template/lint-scripts/README.md +299 -0
  132. package/template/lint-scripts/TESTING.md +273 -0
  133. package/template/lint-scripts/ai-context-generator.ts +159 -0
  134. package/template/lint-scripts/check-framework-modify.sh +8 -0
  135. package/template/lint-scripts/check-menu-permissions.js +242 -0
  136. package/template/lint-scripts/check-refs.ts +165 -0
  137. package/template/lint-scripts/check-route-auth-complete.js +260 -0
  138. package/template/lint-scripts/check-route-auth.js +212 -0
  139. package/template/lint-scripts/check-route-permissions.js +210 -0
  140. package/template/lint-scripts/config/project.config.ts +358 -0
  141. package/template/lint-scripts/dev-context-analyzer.ts +707 -0
  142. package/template/lint-scripts/dev-guide-generator.ts +830 -0
  143. package/template/lint-scripts/dev-server.ts +58 -0
  144. package/template/lint-scripts/eslint-route-auth.js +158 -0
  145. package/template/lint-scripts/eslint-routes-permission.js +147 -0
  146. package/template/lint-scripts/fix-route-auth.js +245 -0
  147. package/template/lint-scripts/framework/check-modify.ts +152 -0
  148. package/template/lint-scripts/framework/hash-utils.ts +180 -0
  149. package/template/lint-scripts/framework/init-baseline.ts +84 -0
  150. package/template/lint-scripts/framework/update-baseline.ts +148 -0
  151. package/template/lint-scripts/post-commit-track.ts +66 -0
  152. package/template/lint-scripts/quick-test.sh +27 -0
  153. package/template/lint-scripts/smart-test.ts +268 -0
  154. package/template/lint-scripts/test-history.ts +360 -0
  155. package/template/lint-scripts/test-tracker.ts +350 -0
  156. package/template/lint-scripts/validate-all.ts +250 -0
  157. package/template/lint-scripts/validators/api-coverage.validator.ts +355 -0
  158. package/template/lint-scripts/validators/client-rpc.validator.ts +190 -0
  159. package/template/lint-scripts/validators/client-tests.validator.ts +155 -0
  160. package/template/lint-scripts/validators/console-log.validator.ts +122 -0
  161. package/template/lint-scripts/validators/directory-structure.validator.ts +181 -0
  162. package/template/lint-scripts/validators/imports.validator.ts +180 -0
  163. package/template/lint-scripts/validators/index.ts +271 -0
  164. package/template/lint-scripts/validators/md-refs.validator.ts +165 -0
  165. package/template/lint-scripts/validators/module-tests.validator.ts +112 -0
  166. package/template/lint-scripts/validators/sensitive.validator.ts +185 -0
  167. package/template/lint-scripts/validators/server-rpc.validator.ts +141 -0
  168. package/template/lint-scripts/validators/test-quality.validator.ts +257 -0
  169. package/template/lint-scripts/validators/todos.validator.ts +126 -0
  170. package/template/lint-scripts/watch-validator.ts +131 -0
  171. package/template/modules.config.ts +71 -0
  172. package/template/package-lock.json +14554 -0
  173. package/template/package.json +158 -0
  174. package/template/patches/@hono+zod-openapi+1.2.2.patch +67 -0
  175. package/template/patches/@hono+zod-validator+0.7.6.patch +13 -0
  176. package/template/patches/hono+4.12.16.patch +246 -0
  177. package/template/patches/typescript+5.8.3.patch +26 -0
  178. package/template/playwright.config.ts +60 -0
  179. package/template/pnpm-lock.yaml +7137 -0
  180. package/template/postcss.config.js +6 -0
  181. package/template/scripts/create-template.ts +1724 -0
  182. package/template/src/admin/App.tsx +59 -0
  183. package/template/src/admin/components/AccountSwitcher.tsx +104 -0
  184. package/template/src/admin/components/CaptchaModal.tsx +150 -0
  185. package/template/src/admin/components/NotificationDrawer.tsx +213 -0
  186. package/template/src/admin/components/PageHeader.tsx +45 -0
  187. package/template/src/admin/components/PermissionConfigEditor.tsx +237 -0
  188. package/template/src/admin/components/PermissionGuard.tsx +108 -0
  189. package/template/src/admin/components/PermissionTree.tsx +193 -0
  190. package/template/src/admin/components/ProtectedRoute.tsx +33 -0
  191. package/template/src/admin/components/StatsCard.tsx +44 -0
  192. package/template/src/admin/components/UserFormModal.tsx +67 -0
  193. package/template/src/admin/components/UserTable.tsx +72 -0
  194. package/template/src/admin/components/__tests__/PageHeader.test.tsx +48 -0
  195. package/template/src/admin/components/__tests__/PermissionConfigEditor.test.tsx +147 -0
  196. package/template/src/admin/components/__tests__/PermissionGuard.test.tsx +221 -0
  197. package/template/src/admin/components/__tests__/PermissionTree.test.tsx +187 -0
  198. package/template/src/admin/components/__tests__/ProtectedRoute.test.tsx +129 -0
  199. package/template/src/admin/components/__tests__/StatsCard.test.tsx +44 -0
  200. package/template/src/admin/components/__tests__/UserFormModal.test.tsx +125 -0
  201. package/template/src/admin/components/__tests__/UserTable.test.tsx +89 -0
  202. package/template/src/admin/components/index.ts +7 -0
  203. package/template/src/admin/hooks/__tests__/useAuditLogs.test.ts +109 -0
  204. package/template/src/admin/hooks/__tests__/usePermissions.test.tsx +327 -0
  205. package/template/src/admin/hooks/__tests__/usePermissionsBranches.test.ts +198 -0
  206. package/template/src/admin/hooks/__tests__/useRoles.test.ts +261 -0
  207. package/template/src/admin/hooks/useAdminNotifications.ts +156 -0
  208. package/template/src/admin/hooks/useAuditLogs.ts +44 -0
  209. package/template/src/admin/hooks/useConfig.ts +168 -0
  210. package/template/src/admin/hooks/usePermissions.ts +156 -0
  211. package/template/src/admin/hooks/useRoles.ts +120 -0
  212. package/template/src/admin/layouts/Header.tsx +93 -0
  213. package/template/src/admin/layouts/Layout.tsx +23 -0
  214. package/template/src/admin/layouts/Sidebar.tsx +120 -0
  215. package/template/src/admin/main.tsx +18 -0
  216. package/template/src/admin/pages/ContentPage.tsx +252 -0
  217. package/template/src/admin/pages/DashboardPage.tsx +141 -0
  218. package/template/src/admin/pages/DisputesPage.tsx +261 -0
  219. package/template/src/admin/pages/LoginPage.tsx +121 -0
  220. package/template/src/admin/pages/MediaTestPage.tsx +524 -0
  221. package/template/src/admin/pages/OrdersPage.tsx +302 -0
  222. package/template/src/admin/pages/PermissionsPage.tsx +95 -0
  223. package/template/src/admin/pages/RegisterPage.tsx +103 -0
  224. package/template/src/admin/pages/RolesPage.tsx +330 -0
  225. package/template/src/admin/pages/SettingsPage.tsx +73 -0
  226. package/template/src/admin/pages/SystemLogsPage.tsx +218 -0
  227. package/template/src/admin/pages/TestCaptchaPage.tsx +120 -0
  228. package/template/src/admin/pages/TicketsPage.tsx +292 -0
  229. package/template/src/admin/pages/UsersPage.tsx +282 -0
  230. package/template/src/admin/pages/__tests__/ContentPage.test.tsx +213 -0
  231. package/template/src/admin/pages/__tests__/DashboardPage.test.tsx +153 -0
  232. package/template/src/admin/pages/__tests__/DisputesPage.test.tsx +196 -0
  233. package/template/src/admin/pages/__tests__/LoginPage.test.tsx +112 -0
  234. package/template/src/admin/pages/__tests__/OrdersPage.test.tsx +217 -0
  235. package/template/src/admin/pages/__tests__/PermissionsPage.test.tsx +119 -0
  236. package/template/src/admin/pages/__tests__/RegisterPage.test.tsx +179 -0
  237. package/template/src/admin/pages/__tests__/RolesPage.test.tsx +256 -0
  238. package/template/src/admin/pages/__tests__/SettingsPage.test.tsx +66 -0
  239. package/template/src/admin/pages/__tests__/SystemLogsPage.test.tsx +125 -0
  240. package/template/src/admin/pages/__tests__/TicketsPage.test.tsx +202 -0
  241. package/template/src/admin/pages/__tests__/UsersPage.test.tsx +229 -0
  242. package/template/src/admin/services/README.md +263 -0
  243. package/template/src/admin/services/TESTING.md +323 -0
  244. package/template/src/admin/services/__tests__/skipLoading.test.ts +146 -0
  245. package/template/src/admin/services/apiClient.ts +66 -0
  246. package/template/src/admin/services/requestInterceptor.ts +127 -0
  247. package/template/src/admin/services/types.ts +5 -0
  248. package/template/src/admin/stores/__tests__/adminStore.test.ts +184 -0
  249. package/template/src/admin/stores/__tests__/adminStoreBranches.test.ts +148 -0
  250. package/template/src/admin/stores/__tests__/captchaStore.test.ts +75 -0
  251. package/template/src/admin/stores/__tests__/captchaStoreBranches.test.ts +37 -0
  252. package/template/src/admin/stores/__tests__/loadingStore.test.ts +68 -0
  253. package/template/src/admin/stores/adminStore.ts +88 -0
  254. package/template/src/admin/stores/captchaStore.ts +47 -0
  255. package/template/src/admin/stores/loadingStore.ts +27 -0
  256. package/template/src/cli/index.ts +22 -0
  257. package/template/src/cli/modules/config/index.ts +132 -0
  258. package/template/src/cli/modules/index.ts +12 -0
  259. package/template/src/cli/modules/notification/index.ts +86 -0
  260. package/template/src/cli/modules/todo/index.ts +60 -0
  261. package/template/src/cli/rpc/client.ts +23 -0
  262. package/template/src/cli/rpc/index.ts +1 -0
  263. package/template/src/cli/utils/api.ts +17 -0
  264. package/template/src/cli/utils/auto-command.ts +229 -0
  265. package/template/src/cli/utils/index.ts +8 -0
  266. package/template/src/cli/utils/logger.ts +79 -0
  267. package/template/src/client/App.tsx +24 -0
  268. package/template/src/client/Layout.tsx +27 -0
  269. package/template/src/client/components/AuthButton.tsx +41 -0
  270. package/template/src/client/components/ConnectionStatus.tsx +75 -0
  271. package/template/src/client/components/EmptyState.tsx +26 -0
  272. package/template/src/client/components/Footer.tsx +17 -0
  273. package/template/src/client/components/LoadingSpinner.tsx +26 -0
  274. package/template/src/client/components/MessageCard.tsx +61 -0
  275. package/template/src/client/components/Navigation.tsx +65 -0
  276. package/template/src/client/components/StatusBadge.tsx +50 -0
  277. package/template/src/client/components/__tests__/App.test.tsx +79 -0
  278. package/template/src/client/components/__tests__/AuthButton.test.tsx +119 -0
  279. package/template/src/client/components/__tests__/ConnectionStatus.test.tsx +188 -0
  280. package/template/src/client/components/__tests__/EmptyState.test.tsx +70 -0
  281. package/template/src/client/components/__tests__/Footer.test.tsx +22 -0
  282. package/template/src/client/components/__tests__/LoadingSpinner.test.tsx +75 -0
  283. package/template/src/client/components/__tests__/MessageCard.test.tsx +142 -0
  284. package/template/src/client/components/__tests__/Navigation.test.tsx +40 -0
  285. package/template/src/client/components/__tests__/StatusBadge.test.tsx +107 -0
  286. package/template/src/client/components/index.ts +6 -0
  287. package/template/src/client/index.css +27 -0
  288. package/template/src/client/main.tsx +25 -0
  289. package/template/src/client/pages/ContentDetailPage.tsx +142 -0
  290. package/template/src/client/pages/ContentListPage.tsx +169 -0
  291. package/template/src/client/pages/NotificationPage.tsx +288 -0
  292. package/template/src/client/pages/TodoPage.tsx +389 -0
  293. package/template/src/client/pages/WebSocketPage.tsx +239 -0
  294. package/template/src/client/pages/__tests__/ContentDetailPage.test.tsx +176 -0
  295. package/template/src/client/pages/__tests__/ContentListPage.test.tsx +202 -0
  296. package/template/src/client/pages/__tests__/NotificationPage.test.tsx +246 -0
  297. package/template/src/client/pages/__tests__/TodoPage.test.tsx +433 -0
  298. package/template/src/client/pages/__tests__/WebSocketPage.test.tsx +378 -0
  299. package/template/src/client/services/apiClient.ts +66 -0
  300. package/template/src/client/stores/__tests__/authStore.test.ts +139 -0
  301. package/template/src/client/stores/__tests__/chatWSStore.test.ts +416 -0
  302. package/template/src/client/stores/__tests__/notificationStore.test.ts +453 -0
  303. package/template/src/client/stores/__tests__/todoStore.test.ts +509 -0
  304. package/template/src/client/stores/authStore.ts +51 -0
  305. package/template/src/client/stores/chatWSStore.ts +122 -0
  306. package/template/src/client/stores/notificationStore.ts +199 -0
  307. package/template/src/client/stores/todoStore.ts +207 -0
  308. package/template/src/server/__tests__/integration/todos-api.test.ts +138 -0
  309. package/template/src/server/app.ts +105 -0
  310. package/template/src/server/config.ts +86 -0
  311. package/template/src/server/core/__tests__/realtime-core.test.ts +329 -0
  312. package/template/src/server/core/__tests__/realtime-scanner.test.ts +210 -0
  313. package/template/src/server/core/__tests__/runtime-node.test.ts +330 -0
  314. package/template/src/server/core/__tests__/runtime.test.ts +219 -0
  315. package/template/src/server/core/__tests__/typed-runtime.test.ts +178 -0
  316. package/template/src/server/core/durable-objects/RealtimeDO.ts +206 -0
  317. package/template/src/server/core/index.ts +83 -0
  318. package/template/src/server/core/module-loader.ts +281 -0
  319. package/template/src/server/core/realtime-core.ts +152 -0
  320. package/template/src/server/core/realtime-scanner.ts +99 -0
  321. package/template/src/server/core/runtime-cloudflare.ts +207 -0
  322. package/template/src/server/core/runtime-node.ts +170 -0
  323. package/template/src/server/core/runtime.ts +129 -0
  324. package/template/src/server/core/typed-runtime.ts +80 -0
  325. package/template/src/server/db/__tests__/driver.test.ts +203 -0
  326. package/template/src/server/db/config.ts +1 -0
  327. package/template/src/server/db/driver-cloudflare.ts +50 -0
  328. package/template/src/server/db/driver.ts +116 -0
  329. package/template/src/server/db/index.ts +3 -0
  330. package/template/src/server/db/init.ts +412 -0
  331. package/template/src/server/db/schema/api-endpoints.ts +23 -0
  332. package/template/src/server/db/schema/contents.ts +31 -0
  333. package/template/src/server/db/schema/disputes.ts +39 -0
  334. package/template/src/server/db/schema/index.ts +14 -0
  335. package/template/src/server/db/schema/notifications.ts +16 -0
  336. package/template/src/server/db/schema/orders.ts +30 -0
  337. package/template/src/server/db/schema/permission-audit-logs.ts +17 -0
  338. package/template/src/server/db/schema/permission-route-mappings.ts +22 -0
  339. package/template/src/server/db/schema/permissions.ts +17 -0
  340. package/template/src/server/db/schema/role-permissions.ts +22 -0
  341. package/template/src/server/db/schema/roles.ts +17 -0
  342. package/template/src/server/db/schema/tickets.ts +62 -0
  343. package/template/src/server/db/schema/todo-attachments.ts +22 -0
  344. package/template/src/server/db/schema/todos.ts +21 -0
  345. package/template/src/server/db/schema/user-roles.ts +17 -0
  346. package/template/src/server/db/seeds/index.ts +1 -0
  347. package/template/src/server/db/seeds/permission-data.ts +354 -0
  348. package/template/src/server/db/test-setup.ts +647 -0
  349. package/template/src/server/entries/cloudflare.ts +71 -0
  350. package/template/src/server/entries/node.ts +190 -0
  351. package/template/src/server/index.ts +62 -0
  352. package/template/src/server/middleware/__tests__/auth-simple.test.ts +147 -0
  353. package/template/src/server/middleware/__tests__/auth.test.ts +276 -0
  354. package/template/src/server/middleware/__tests__/captcha.test.ts +258 -0
  355. package/template/src/server/middleware/__tests__/error-handler.test.ts +364 -0
  356. package/template/src/server/middleware/__tests__/error-response-format.test.ts +80 -0
  357. package/template/src/server/middleware/__tests__/permission.test.ts +312 -0
  358. package/template/src/server/middleware/audit-log.ts +101 -0
  359. package/template/src/server/middleware/auth.ts +235 -0
  360. package/template/src/server/middleware/captcha.ts +166 -0
  361. package/template/src/server/middleware/cors.ts +30 -0
  362. package/template/src/server/middleware/error-handler.ts +135 -0
  363. package/template/src/server/middleware/index.ts +24 -0
  364. package/template/src/server/middleware/logger.ts +73 -0
  365. package/template/src/server/middleware/permission.ts +127 -0
  366. package/template/src/server/middleware/rate-limit.ts +69 -0
  367. package/template/src/server/middleware/realtime-env.ts +12 -0
  368. package/template/src/server/module-admin/__tests__/admin-routes.test.ts +360 -0
  369. package/template/src/server/module-admin/__tests__/admin-service.test.ts +222 -0
  370. package/template/src/server/module-admin/__tests__/audit-log-routes.test.ts +261 -0
  371. package/template/src/server/module-admin/__tests__/export-routes.test.ts +160 -0
  372. package/template/src/server/module-admin/__tests__/media-routes.test.ts +122 -0
  373. package/template/src/server/module-admin/module.ts +40 -0
  374. package/template/src/server/module-admin/routes/admin-notification-routes.ts +197 -0
  375. package/template/src/server/module-admin/routes/admin-routes.ts +20 -0
  376. package/template/src/server/module-admin/routes/auth-routes.ts +86 -0
  377. package/template/src/server/module-admin/routes/export-routes.ts +207 -0
  378. package/template/src/server/module-admin/routes/media-routes.ts +78 -0
  379. package/template/src/server/module-admin/routes/system-routes.ts +89 -0
  380. package/template/src/server/module-admin/routes/user-management-routes.ts +143 -0
  381. package/template/src/server/module-admin/services/admin-service.ts +268 -0
  382. package/template/src/server/module-captcha/__tests__/captcha-route.test.ts +35 -0
  383. package/template/src/server/module-captcha/__tests__/captcha-service.test.ts +53 -0
  384. package/template/src/server/module-captcha/module.ts +35 -0
  385. package/template/src/server/module-captcha/routes/captcha-routes.ts +68 -0
  386. package/template/src/server/module-captcha/services/captcha-service.ts +3 -0
  387. package/template/src/server/module-chat/__tests__/chat-routes.test.ts +39 -0
  388. package/template/src/server/module-chat/__tests__/chat-rpc.test.ts +185 -0
  389. package/template/src/server/module-chat/__tests__/chat-service.test.ts +64 -0
  390. package/template/src/server/module-chat/module.ts +27 -0
  391. package/template/src/server/module-chat/routes/chat-routes.ts +46 -0
  392. package/template/src/server/module-chat/services/chat-service.ts +38 -0
  393. package/template/src/server/module-content/__tests__/content-route.test.ts +40 -0
  394. package/template/src/server/module-content/__tests__/content-service.test.ts +107 -0
  395. package/template/src/server/module-content/module.ts +39 -0
  396. package/template/src/server/module-content/routes/content-routes.ts +182 -0
  397. package/template/src/server/module-content/routes/public-content-routes.ts +58 -0
  398. package/template/src/server/module-content/services/content-service.ts +224 -0
  399. package/template/src/server/module-dispute/__tests__/dispute-route.test.ts +43 -0
  400. package/template/src/server/module-dispute/__tests__/dispute-service.test.ts +135 -0
  401. package/template/src/server/module-dispute/module.ts +30 -0
  402. package/template/src/server/module-dispute/routes/dispute-routes.ts +153 -0
  403. package/template/src/server/module-dispute/services/dispute-service.ts +255 -0
  404. package/template/src/server/module-file/__tests__/file-routes.test.ts +284 -0
  405. package/template/src/server/module-file/__tests__/file-storage-service.test.ts +323 -0
  406. package/template/src/server/module-file/module.ts +28 -0
  407. package/template/src/server/module-file/routes/file-routes.ts +288 -0
  408. package/template/src/server/module-notifications/__tests__/notification-route-rpc.test.ts +375 -0
  409. package/template/src/server/module-notifications/__tests__/notification-service.test.ts +241 -0
  410. package/template/src/server/module-notifications/__tests__/sse-rpc.test.ts +289 -0
  411. package/template/src/server/module-notifications/module.ts +32 -0
  412. package/template/src/server/module-notifications/routes/notification-routes.ts +190 -0
  413. package/template/src/server/module-notifications/services/notification-service.ts +104 -0
  414. package/template/src/server/module-order/__tests__/order-route.test.ts +258 -0
  415. package/template/src/server/module-order/__tests__/order-service.test.ts +222 -0
  416. package/template/src/server/module-order/module.ts +30 -0
  417. package/template/src/server/module-order/routes/order-routes.ts +202 -0
  418. package/template/src/server/module-order/services/order-service.ts +268 -0
  419. package/template/src/server/module-permission/__tests__/permission-middleware.test.ts +90 -0
  420. package/template/src/server/module-permission/__tests__/permission-routes.test.ts +330 -0
  421. package/template/src/server/module-permission/__tests__/permission-service-impl.test.ts +388 -0
  422. package/template/src/server/module-permission/__tests__/permission-service.test.ts +190 -0
  423. package/template/src/server/module-permission/__tests__/role-routes.test.ts +215 -0
  424. package/template/src/server/module-permission/module.ts +68 -0
  425. package/template/src/server/module-permission/routes/audit-log-routes.ts +76 -0
  426. package/template/src/server/module-permission/routes/permission-routes.ts +184 -0
  427. package/template/src/server/module-permission/routes/role-routes.ts +263 -0
  428. package/template/src/server/module-permission/services/audit-log-service.ts +108 -0
  429. package/template/src/server/module-permission/services/permission-service-impl.ts +233 -0
  430. package/template/src/server/module-permission/services/permission-service.ts +256 -0
  431. package/template/src/server/module-permission/services/role-service.ts +122 -0
  432. package/template/src/server/module-ticket/__tests__/ticket-route.test.ts +173 -0
  433. package/template/src/server/module-ticket/__tests__/ticket-service.test.ts +201 -0
  434. package/template/src/server/module-ticket/module.ts +30 -0
  435. package/template/src/server/module-ticket/routes/ticket-routes.ts +210 -0
  436. package/template/src/server/module-ticket/services/ticket-service.ts +297 -0
  437. package/template/src/server/module-todos/__tests__/todo-service.test.ts +196 -0
  438. package/template/src/server/module-todos/__tests__/todos-file-upload.test.ts +439 -0
  439. package/template/src/server/module-todos/__tests__/todos-route-rpc.test.ts +575 -0
  440. package/template/src/server/module-todos/module.ts +30 -0
  441. package/template/src/server/module-todos/routes/todos-routes.ts +260 -0
  442. package/template/src/server/module-todos/services/todo-service.ts +202 -0
  443. package/template/src/server/route-registry.ts +47 -0
  444. package/template/src/server/test-utils/test-client.ts +66 -0
  445. package/template/src/server/test-utils/test-server.ts +131 -0
  446. package/template/src/server/types/bindings.ts +10 -0
  447. package/template/src/server/utils/__tests__/app-error.test.ts +374 -0
  448. package/template/src/server/utils/__tests__/auth.test.ts +76 -0
  449. package/template/src/server/utils/__tests__/captcha.test.ts +80 -0
  450. package/template/src/server/utils/__tests__/file-storage.test.ts +472 -0
  451. package/template/src/server/utils/__tests__/logger.test.ts +221 -0
  452. package/template/src/server/utils/__tests__/route-helpers.test.ts +264 -0
  453. package/template/src/server/utils/app-error.ts +355 -0
  454. package/template/src/server/utils/auth.ts +65 -0
  455. package/template/src/server/utils/captcha.ts +119 -0
  456. package/template/src/server/utils/date.ts +50 -0
  457. package/template/src/server/utils/env.ts +4 -0
  458. package/template/src/server/utils/file-storage.ts +462 -0
  459. package/template/src/server/utils/generate.ts +26 -0
  460. package/template/src/server/utils/id-helpers.ts +5 -0
  461. package/template/src/server/utils/logger.ts +139 -0
  462. package/template/src/server/utils/permission-utils.ts +6 -0
  463. package/template/src/server/utils/response.ts +40 -0
  464. package/template/src/server/utils/route-helpers.ts +200 -0
  465. package/template/src/server/utils/uuid.ts +8 -0
  466. package/template/src/server/utils/ws-helper.ts +30 -0
  467. package/template/src/shared/constants/index.ts +1 -0
  468. package/template/src/shared/constants/resource-types.ts +72 -0
  469. package/template/src/shared/core/__tests__/sse-client.test.ts +376 -0
  470. package/template/src/shared/core/__tests__/ws-client.test.ts +468 -0
  471. package/template/src/shared/core/api-request.ts +192 -0
  472. package/template/src/shared/core/api-schemas.ts +41 -0
  473. package/template/src/shared/core/index.ts +37 -0
  474. package/template/src/shared/core/module-manifest.ts +120 -0
  475. package/template/src/shared/core/protocol-types.ts +26 -0
  476. package/template/src/shared/core/sse-client.ts +185 -0
  477. package/template/src/shared/core/ws-client.ts +236 -0
  478. package/template/src/shared/hooks/index.ts +2 -0
  479. package/template/src/shared/hooks/useSSE.ts +57 -0
  480. package/template/src/shared/hooks/useWebSocket.ts +66 -0
  481. package/template/src/shared/index.ts +5 -0
  482. package/template/src/shared/modules/admin/index.ts +1 -0
  483. package/template/src/shared/modules/admin/schemas.ts +100 -0
  484. package/template/src/shared/modules/audit/index.ts +1 -0
  485. package/template/src/shared/modules/audit/schemas.ts +24 -0
  486. package/template/src/shared/modules/captcha/index.ts +1 -0
  487. package/template/src/shared/modules/captcha/schemas.ts +19 -0
  488. package/template/src/shared/modules/chat/index.ts +38 -0
  489. package/template/src/shared/modules/content/index.ts +1 -0
  490. package/template/src/shared/modules/content/schemas.ts +53 -0
  491. package/template/src/shared/modules/dispute/index.ts +1 -0
  492. package/template/src/shared/modules/dispute/schemas.ts +62 -0
  493. package/template/src/shared/modules/files/index.ts +11 -0
  494. package/template/src/shared/modules/files/schemas.ts +44 -0
  495. package/template/src/shared/modules/index.ts +70 -0
  496. package/template/src/shared/modules/notifications/index.ts +26 -0
  497. package/template/src/shared/modules/notifications/schemas.ts +73 -0
  498. package/template/src/shared/modules/order/index.ts +1 -0
  499. package/template/src/shared/modules/order/schemas.ts +63 -0
  500. package/template/src/shared/modules/permission/index.ts +42 -0
  501. package/template/src/shared/modules/permission/permission-dependencies.ts +50 -0
  502. package/template/src/shared/modules/permission/permissions.ts +275 -0
  503. package/template/src/shared/modules/permission/schemas.ts +92 -0
  504. package/template/src/shared/modules/permission/types.ts +23 -0
  505. package/template/src/shared/modules/role/index.ts +1 -0
  506. package/template/src/shared/modules/role/schemas.ts +46 -0
  507. package/template/src/shared/modules/ticket/index.ts +1 -0
  508. package/template/src/shared/modules/ticket/schemas.ts +77 -0
  509. package/template/src/shared/modules/todos/index.ts +20 -0
  510. package/template/src/shared/modules/todos/schemas.ts +65 -0
  511. package/template/src/shared/schemas/index.ts +79 -0
  512. package/template/src/types/global.d.ts +14 -0
  513. package/template/src/vite-env.d.ts +21 -0
  514. package/template/tailwind.config.js +11 -0
  515. package/template/tests/e2e/admin-crud.spec.ts +81 -0
  516. package/template/tests/e2e/case-o1.spec.ts +108 -0
  517. package/template/tests/e2e/global-setup.ts +73 -0
  518. package/template/tests/e2e/global-teardown.ts +28 -0
  519. package/template/tests/e2e/notification.spec.ts +458 -0
  520. package/template/tests/e2e/todo.spec.ts +623 -0
  521. package/template/tests/e2e/websocket.spec.ts +254 -0
  522. package/template/tsconfig.json +35 -0
  523. package/template/tsup.config.ts +95 -0
  524. package/template/vite-plugins.ts +113 -0
  525. package/template/vite.config.ts +96 -0
  526. package/template/vitest.config.ts +53 -0
  527. package/template/vitest.integration.config.ts +24 -0
  528. package/template/vitest.integration.setup.ts +22 -0
  529. package/template/vitest.setup.ts +74 -0
  530. package/template/wrangler.toml +33 -0
@@ -0,0 +1,324 @@
1
+ ---
2
+ paths: src/client/stores/**/*.ts
3
+ ---
4
+
5
+ # Zustand 状态管理规范
6
+
7
+ ## 📁 目录结构
8
+
9
+ ```
10
+ src/client/stores/
11
+ ├── todoStore.ts # Todo 状态管理
12
+ ├── chatWSStore.ts # Chat WebSocket 状态管理
13
+ ├── notificationStore.ts # Notification 状态管理
14
+ └── __tests__/ # Store 测试
15
+ └── todoStore.test.ts
16
+ ```
17
+
18
+ ## 🎯 Store 设计原则
19
+
20
+ ### 1. 使用共享类型
21
+
22
+ ```typescript
23
+ // ✅ 正确 - 使用共享类型
24
+ import type { Item, CreateItemInput } from '@shared/schemas'
25
+
26
+ interface ItemState {
27
+ items: Item[]
28
+ fetchItems: () => Promise<void>
29
+ createItem: (input: CreateItemInput) => Promise<void>
30
+ }
31
+
32
+ // ❌ 错误 - 重复定义类型
33
+ interface ItemState {
34
+ items: Array<{
35
+ id: number
36
+ name: string
37
+ }>
38
+ }
39
+ ```
40
+
41
+ **ESLint 规则**: `prefer-shared-types`
42
+
43
+ **路径**: `src/client/stores/**/*.ts`
44
+
45
+ ### 2. Store 结构
46
+
47
+ ```typescript
48
+ import { create } from 'zustand'
49
+ import { apiClient } from '@client/services/apiClient'
50
+ import type { Item, CreateItemInput } from '@shared/schemas'
51
+
52
+ interface ItemState {
53
+ items: Item[]
54
+ loading: boolean
55
+ error: string | null
56
+
57
+ fetchItems: () => Promise<void>
58
+ createItem: (input: CreateItemInput) => Promise<void>
59
+ clearError: () => void
60
+ }
61
+
62
+ export const useItemStore = create<ItemState>((set, get) => ({
63
+ items: [],
64
+ loading: false,
65
+ error: null,
66
+
67
+ fetchItems: async () => {
68
+ set({ loading: true, error: null })
69
+ try {
70
+ const response = await apiClient.api.items.$get()
71
+ const result = await response.json()
72
+ if (result.success) {
73
+ set({ items: result.data, loading: false })
74
+ }
75
+ } catch (error) {
76
+ set({ error: 'Failed to fetch items', loading: false })
77
+ }
78
+ },
79
+
80
+ createItem: async (input: CreateItemInput) => {
81
+ try {
82
+ const response = await apiClient.api.items.$post({ json: input })
83
+ const result = await response.json()
84
+ if (result.success) {
85
+ set(state => ({ items: [...state.items, result.data] }))
86
+ }
87
+ } catch (error) {
88
+ set({ error: 'Failed to create item' })
89
+ }
90
+ },
91
+
92
+ clearError: () => set({ error: null }),
93
+ }))
94
+ ```
95
+
96
+ ## 🔌 WebSocket Store 集成
97
+
98
+ ### WebSocket 状态管理
99
+
100
+ ```typescript
101
+ import { create } from 'zustand'
102
+ import { apiClient } from '@client/services/apiClient'
103
+ import type { WSClient, WSStatus, ChatProtocol } from '@shared/schemas'
104
+
105
+ interface WSMessage {
106
+ type: string
107
+ payload: unknown
108
+ timestamp?: number
109
+ }
110
+
111
+ interface WSState {
112
+ status: WSStatus
113
+ messages: WSMessage[]
114
+
115
+ connect: () => void
116
+ disconnect: () => void
117
+ echo: (params: { message: string }) => Promise<void>
118
+ clearMessages: () => void
119
+ }
120
+
121
+ let wsClient: WSClient<ChatProtocol> | null = null
122
+
123
+ export const useChatWsStore = create<WSState>((set, get) => ({
124
+ status: 'closed',
125
+ messages: [],
126
+
127
+ connect: () => {
128
+ if (wsClient) return
129
+
130
+ wsClient = apiClient.api.chat.ws.$ws()
131
+
132
+ if (!wsClient) return
133
+
134
+ wsClient.onStatusChange((newStatus: WSStatus) => {
135
+ set({ status: newStatus })
136
+ })
137
+
138
+ wsClient.on('notification', payload => {
139
+ set(state => ({
140
+ messages: [...state.messages, { type: 'notification', payload }],
141
+ }))
142
+ })
143
+ },
144
+
145
+ disconnect: () => {
146
+ if (wsClient) {
147
+ wsClient.close()
148
+ wsClient = null
149
+ set({ status: 'closed' })
150
+ }
151
+ },
152
+
153
+ echo: async params => {
154
+ if (!wsClient || get().status !== 'open') return
155
+ try {
156
+ await wsClient.call('echo', params)
157
+ } catch (error) {
158
+ console.error('Echo failed:', error)
159
+ }
160
+ },
161
+
162
+ clearMessages: () => {
163
+ set({ messages: [] })
164
+ },
165
+ }))
166
+ ```
167
+
168
+ ## 🎣 组件中使用 Store
169
+
170
+ ### 选择性订阅
171
+
172
+ ```typescript
173
+ // ✅ 正确 - 选择性订阅
174
+ export const ItemList: React.FC = () => {
175
+ const items = useItemStore(state => state.items)
176
+ const loading = useItemStore(state => state.loading)
177
+ const fetchItems = useItemStore(state => state.fetchItems)
178
+
179
+ useEffect(() => {
180
+ fetchItems()
181
+ }, [fetchItems])
182
+
183
+ if (loading) return <div>Loading...</div>
184
+
185
+ return (
186
+ <div>
187
+ {items.map(item => (
188
+ <ItemCard key={item.id} item={item} />
189
+ ))}
190
+ </div>
191
+ )
192
+ }
193
+
194
+ // ❌ 错误 - 订阅整个 Store
195
+ export const ItemList: React.FC = () => {
196
+ const { items, loading, fetchItems } = useItemStore() // ❌ 任何状态变化都会重渲染
197
+
198
+ // ...
199
+ }
200
+ ```
201
+
202
+ ## 🧪 测试规范
203
+
204
+ ### Store 测试
205
+
206
+ ```typescript
207
+ // src/client/stores/__tests__/itemStore.test.ts
208
+ import { describe, it, expect, beforeEach } from 'vitest'
209
+ import { useItemStore } from '../itemStore'
210
+
211
+ describe('itemStore', () => {
212
+ beforeEach(() => {
213
+ useItemStore.setState({ items: [], loading: false, error: null })
214
+ })
215
+
216
+ it('should have initial state', () => {
217
+ const state = useItemStore.getState()
218
+ expect(state.items).toEqual([])
219
+ expect(state.loading).toBe(false)
220
+ expect(state.error).toBeNull()
221
+ })
222
+
223
+ it('should fetch items', async () => {
224
+ const { fetchItems } = useItemStore.getState()
225
+ await fetchItems()
226
+
227
+ const state = useItemStore.getState()
228
+ expect(state.items.length).toBeGreaterThan(0)
229
+ })
230
+ })
231
+ ```
232
+
233
+ ## 🚫 禁止事项
234
+
235
+ ### 1. 禁止直接调用 API
236
+
237
+ ```typescript
238
+ // ❌ 错误 - 直接使用 fetch
239
+ fetch('/api/items')
240
+ .then(res => res.json())
241
+ .then(data => set({ items: data }))
242
+
243
+ // ✅ 正确 - 使用 apiClient
244
+ const response = await apiClient.api.items.$get()
245
+ const result = await response.json()
246
+ if (result.success) {
247
+ set({ items: result.data })
248
+ }
249
+ ```
250
+
251
+ ### 2. 禁止使用 any 类型
252
+
253
+ ```typescript
254
+ // ❌ 错误 - 使用 any
255
+ interface State {
256
+ items: any[]
257
+ createItem: (input: any) => Promise<void>
258
+ }
259
+
260
+ // ✅ 正确 - 使用明确类型
261
+ interface State {
262
+ items: Item[]
263
+ createItem: (input: CreateItemInput) => Promise<void>
264
+ }
265
+ ```
266
+
267
+ ### 3. 禁止在 Store 中定义组件
268
+
269
+ ```typescript
270
+ // ❌ 错误 - 在 Store 中定义组件
271
+ export const useItemStore = create((set) => ({
272
+ ItemComponent: () => <div>...</div>, // ❌
273
+ }))
274
+
275
+ // ✅ 正确 - Store 只管理状态
276
+ export const useItemStore = create((set) => ({
277
+ items: [],
278
+ fetchItems: async () => { ... },
279
+ }))
280
+ ```
281
+
282
+ ## 📤 导出规范
283
+
284
+ ```typescript
285
+ // ✅ 正确 - 命名导出
286
+ export const useItemStore = create<ItemState>((set, get) => ({ ... }))
287
+
288
+ // ❌ 错误 - 默认导出
289
+ export default create<ItemState>((set, get) => ({ ... }))
290
+ ```
291
+
292
+ ## 🚫 Anti-Patterns
293
+
294
+ ```typescript
295
+ // ❌ 不要订阅整个 Store
296
+ const { items, loading, fetchItems } = useItemStore()
297
+
298
+ // ✅ 应该选择性订阅
299
+ const items = useItemStore(state => state.items)
300
+ const loading = useItemStore(state => state.loading)
301
+ const fetchItems = useItemStore(state => state.fetchItems)
302
+
303
+ // ❌ 不要在 Store 中直接使用 fetch
304
+ fetch('/api/items')
305
+
306
+ // ✅ 应该使用 apiClient
307
+ const response = await apiClient.api.items.$get()
308
+
309
+ // ❌ 不要使用 any 类型
310
+ interface State {
311
+ items: any[]
312
+ }
313
+
314
+ // ✅ 应该使用明确类型
315
+ interface State {
316
+ items: Item[]
317
+ }
318
+ ```
319
+
320
+ ## 📚 相关文档
321
+
322
+ - [Client Service 规范](./31-client-services.md) - API 客户端使用规范
323
+ - [Client 组件规范](./30-client-components.md) - 组件开发规范
324
+ - [Testing 规范](./60-testing-standards.md) - 测试编写规范
@@ -0,0 +1,276 @@
1
+ ---
2
+ paths: src/client/App.tsx
3
+ ---
4
+
5
+ # App 入口规范
6
+
7
+ ## 🎯 核心原则
8
+
9
+ `App.tsx` 是应用的**路由入口**,应该保持**极简**,只负责路由配置。
10
+
11
+ ## 📁 文件职责
12
+
13
+ ### App.tsx 的职责
14
+
15
+ - ✅ 配置路由(BrowserRouter, Routes, Route)
16
+ - ✅ 引用 Layout 组件
17
+ - ✅ 定义路由映射
18
+
19
+ ### App.tsx 不应该做的事
20
+
21
+ - ❌ 定义布局组件(Navigation, Footer 等)
22
+ - ❌ 定义业务逻辑
23
+ - ❌ 包含复杂的 JSX 结构
24
+ - ❌ 定义样式
25
+
26
+ ## 🏗️ 推荐结构
27
+
28
+ ### 标准结构
29
+
30
+ ```
31
+ src/client/
32
+ ├── App.tsx # 路由入口(极简)
33
+ ├── Layout.tsx # 布局组件
34
+ ├── components/ # 共享组件
35
+ │ ├── Navigation.tsx
36
+ │ └── Footer.tsx
37
+ └── pages/ # 页面组件
38
+ ├── TodoPage.tsx
39
+ └── NotificationPage.tsx
40
+ ```
41
+
42
+ ### App.tsx 示例
43
+
44
+ ```typescript
45
+ // ✅ 正确 - 极简的路由入口
46
+ import { BrowserRouter, Routes, Route, Navigate } from 'react-router-dom'
47
+ import { Layout } from './Layout'
48
+ import { TodoPage } from './pages/TodoPage'
49
+ import { NotificationPage } from './pages/NotificationPage'
50
+ import { WebSocketPage } from './pages/WebSocketPage'
51
+
52
+ export const App: React.FC = () => {
53
+ return (
54
+ <BrowserRouter>
55
+ <Layout>
56
+ <Routes>
57
+ <Route path="/" element={<Navigate to="/todos" replace />} />
58
+ <Route path="/todos" element={<TodoPage />} />
59
+ <Route path="/notifications" element={<NotificationPage />} />
60
+ <Route path="/websocket" element={<WebSocketPage />} />
61
+ </Routes>
62
+ </Layout>
63
+ </BrowserRouter>
64
+ )
65
+ }
66
+ ```
67
+
68
+ ## 📦 Layout 组件规范
69
+
70
+ ### Layout.tsx 示例
71
+
72
+ ```typescript
73
+ // src/client/Layout.tsx
74
+ import { ReactNode } from 'react'
75
+ import { Navigation } from './components/Navigation'
76
+ import { Footer } from './components/Footer'
77
+
78
+ interface LayoutProps {
79
+ children: ReactNode
80
+ }
81
+
82
+ export const Layout: React.FC<LayoutProps> = ({ children }) => {
83
+ return (
84
+ <div className="min-h-screen bg-gray-50" data-testid="app-container">
85
+ <Navigation />
86
+ <main className="py-8" data-testid="app-main">
87
+ {children}
88
+ </main>
89
+ <Footer />
90
+ </div>
91
+ )
92
+ }
93
+ ```
94
+
95
+ ## 🚫 Anti-Patterns
96
+
97
+ ```typescript
98
+ // ❌ 错误 - App.tsx 包含布局逻辑
99
+ export const App: React.FC = () => {
100
+ return (
101
+ <BrowserRouter>
102
+ <div className="min-h-screen bg-gray-50">
103
+ <nav className="bg-white border-b">
104
+ {/* 导航逻辑 */}
105
+ </nav>
106
+ <main className="py-8">
107
+ <Routes>
108
+ {/* 路由配置 */}
109
+ </Routes>
110
+ </main>
111
+ <footer className="py-8">
112
+ {/* 页脚逻辑 */}
113
+ </footer>
114
+ </div>
115
+ </BrowserRouter>
116
+ )
117
+ }
118
+
119
+ // ✅ 正确 - App.tsx 只负责路由
120
+ export const App: React.FC = () => {
121
+ return (
122
+ <BrowserRouter>
123
+ <Layout>
124
+ <Routes>
125
+ <Route path="/" element={<Navigate to="/todos" replace />} />
126
+ <Route path="/todos" element={<TodoPage />} />
127
+ </Routes>
128
+ </Layout>
129
+ </BrowserRouter>
130
+ )
131
+ }
132
+
133
+ // ❌ 错误 - App.tsx 定义组件
134
+ const Navigation: React.FC = () => {
135
+ return <nav>...</nav>
136
+ }
137
+
138
+ const Footer: React.FC = () => {
139
+ return <footer>...</footer>
140
+ }
141
+
142
+ export const App: React.FC = () => {
143
+ return (
144
+ <BrowserRouter>
145
+ <Navigation />
146
+ <Routes>...</Routes>
147
+ <Footer />
148
+ </BrowserRouter>
149
+ )
150
+ }
151
+
152
+ // ✅ 正确 - 组件放在独立文件中
153
+ // src/client/components/Navigation.tsx
154
+ export const Navigation: React.FC = () => {
155
+ return <nav>...</nav>
156
+ }
157
+
158
+ // src/client/components/Footer.tsx
159
+ export const Footer: React.FC = () => {
160
+ return <footer>...</footer>
161
+ }
162
+
163
+ // src/client/Layout.tsx
164
+ import { Navigation } from './components/Navigation'
165
+ import { Footer } from './components/Footer'
166
+
167
+ export const Layout: React.FC<LayoutProps> = ({ children }) => {
168
+ return (
169
+ <div>
170
+ <Navigation />
171
+ <main>{children}</main>
172
+ <Footer />
173
+ </div>
174
+ )
175
+ }
176
+ ```
177
+
178
+ ## 📝 路由配置规范
179
+
180
+ ### 路由映射
181
+
182
+ ```typescript
183
+ // ✅ 正确 - 使用路由映射
184
+ type RouteKey = 'todos' | 'notifications' | 'websocket'
185
+
186
+ const routes: Record<RouteKey, { path: string; element: React.ReactNode }> = {
187
+ todos: { path: '/todos', element: <TodoPage /> },
188
+ notifications: { path: '/notifications', element: <NotificationPage /> },
189
+ websocket: { path: '/websocket', element: <WebSocketPage /> },
190
+ }
191
+
192
+ export const App: React.FC = () => {
193
+ return (
194
+ <BrowserRouter>
195
+ <Layout>
196
+ <Routes>
197
+ <Route path="/" element={<Navigate to="/todos" replace />} />
198
+ {Object.values(routes).map(route => (
199
+ <Route key={route.path} path={route.path} element={route.element} />
200
+ ))}
201
+ </Routes>
202
+ </Layout>
203
+ </BrowserRouter>
204
+ )
205
+ }
206
+ ```
207
+
208
+ ### 默认路由
209
+
210
+ ```typescript
211
+ // ✅ 正确 - 使用 Navigate 重定向
212
+ <Route path="/" element={<Navigate to="/todos" replace />} />
213
+
214
+ // ❌ 错误 - 使用组件作为默认路由
215
+ <Route path="/" element={<TodoPage />} />
216
+ ```
217
+
218
+ ## 🎨 布局灵活性
219
+
220
+ ### 可调整的布局
221
+
222
+ Layout 组件应该支持灵活调整:
223
+
224
+ ```typescript
225
+ // src/client/Layout.tsx
226
+ interface LayoutProps {
227
+ children: ReactNode
228
+ className?: string
229
+ showNavigation?: boolean
230
+ showFooter?: boolean
231
+ }
232
+
233
+ export const Layout: React.FC<LayoutProps> = ({
234
+ children,
235
+ className = '',
236
+ showNavigation = true,
237
+ showFooter = true,
238
+ }) => {
239
+ return (
240
+ <div className={`min-h-screen bg-gray-50 ${className}`}>
241
+ {showNavigation && <Navigation />}
242
+ <main className="py-8">{children}</main>
243
+ {showFooter && <Footer />}
244
+ </div>
245
+ )
246
+ }
247
+ ```
248
+
249
+ ### 使用示例
250
+
251
+ ```typescript
252
+ // 默认布局
253
+ <Layout>
254
+ <Routes>...</Routes>
255
+ </Layout>
256
+
257
+ // 自定义布局
258
+ <Layout className="bg-white" showFooter={false}>
259
+ <Routes>...</Routes>
260
+ </Layout>
261
+ ```
262
+
263
+ ## 📤 导出规范
264
+
265
+ ```typescript
266
+ // ✅ 正确 - 命名导出
267
+ export const App: React.FC = () => { ... }
268
+
269
+ // ❌ 错误 - 默认导出
270
+ export default function App() { ... }
271
+ ```
272
+
273
+ ## 📚 相关文档
274
+
275
+ - [Client 组件规范](./30-client-components.md) - 组件开发规范
276
+ - [Client 服务规范](./31-client-services.md) - API 客户端使用规范