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.
- package/README.md +154 -0
- package/dist/cli/index.d.ts +2 -0
- package/dist/cli/index.js +439 -0
- package/dist/cli/index.js.map +1 -0
- package/package.json +171 -0
- package/template/.agents/skills/writing-hookify-rules/SKILL.md +408 -0
- package/template/.ai-context.md +368 -0
- package/template/.claude/hookify.block-dangerous-commands.local.md +41 -0
- package/template/.claude/hookify.check-api-types.local.md +111 -0
- package/template/.claude/hookify.check-duplicate-types.local.md +287 -0
- package/template/.claude/hookify.check-test-assertions.local.md +93 -0
- package/template/.claude/hookify.remind-add-tests.local.md +209 -0
- package/template/.claude/hookify.remind-db-migration.local.md +58 -0
- package/template/.claude/hookify.remind-run-tests.local.md +52 -0
- package/template/.claude/hookify.warn-any-type.local.md +203 -0
- package/template/.claude/hookify.warn-console-log.local.md +73 -0
- package/template/.claude/rules/00-project-config.md +147 -0
- package/template/.claude/rules/01-file-types.md +127 -0
- package/template/.claude/rules/02-git-workflow.md +167 -0
- package/template/.claude/rules/10-api-type-inference.md +555 -0
- package/template/.claude/rules/20-server-api.md +349 -0
- package/template/.claude/rules/21-server-entrypoint.md +257 -0
- package/template/.claude/rules/30-client-components.md +314 -0
- package/template/.claude/rules/31-client-services.md +768 -0
- package/template/.claude/rules/32-client-state-zustand.md +324 -0
- package/template/.claude/rules/33-client-app-entry.md +276 -0
- package/template/.claude/rules/34-client-admin-module.md +445 -0
- package/template/.claude/rules/35-cli-module.md +259 -0
- package/template/.claude/rules/40-admin-module.md +495 -0
- package/template/.claude/rules/40-shared-types.md +450 -0
- package/template/.claude/rules/50-websocket.md +245 -0
- package/template/.claude/rules/51-sse.md +372 -0
- package/template/.claude/rules/52-cloudflare-realtime.md +384 -0
- package/template/.claude/rules/60-testing-standards.md +245 -0
- package/template/.claude/rules/61-hono-testing.md +200 -0
- package/template/.claude/scripts/README.md +187 -0
- package/template/.claude/scripts/check-duplicate-types.ts +188 -0
- package/template/.claude/scripts/post-edit-check-incremental.sh +61 -0
- package/template/.claude/scripts/post-edit-check.sh +22 -0
- package/template/.claude/scripts/pre-tool-use-check.sh +86 -0
- package/template/.claude/scripts/test-pre-tool-use.sh +73 -0
- package/template/.claude/scripts/validate-git-changes.sh +38 -0
- package/template/.claude/settings.json +32 -0
- package/template/.claude/skills/writing-hookify-rules/SKILL.md +408 -0
- package/template/.dev-context-compact.md +54 -0
- package/template/.dev-context.md +621 -0
- package/template/.dev-guide.md +243 -0
- package/template/.env.example +60 -0
- package/template/.eslintrc.routes.json +39 -0
- package/template/.husky/_/husky.sh +27 -0
- package/template/.husky/commit-msg +4 -0
- package/template/.husky/post-commit +4 -0
- package/template/.husky/pre-commit +19 -0
- package/template/.husky/pre-push +12 -0
- package/template/.prettierignore +22 -0
- package/template/.prettierrc +8 -0
- package/template/.sessions/3/2026-03-26T05-41-09-154Z_03bb597f-3898-4a2e-8c08-5746bbe8d95e.jsonl +18 -0
- package/template/.sessions/3/2026-03-26T05-48-30-052Z_12de4774-9cb3-494c-9852-bd1e6b0003c3.jsonl +6 -0
- package/template/.vscode/extensions.json +8 -0
- package/template/.vscode/settings.json +4 -0
- package/template/.workspaces/3/hello.py +1 -0
- package/template/.wrangler/state/v3/d1/miniflare-D1DatabaseObject/803c2e37182b913f8857edf6d8776515cef4af6d48fcb25913e457f4b14ffa97.sqlite +0 -0
- package/template/.wrangler/state/v3/d1/miniflare-D1DatabaseObject/803c2e37182b913f8857edf6d8776515cef4af6d48fcb25913e457f4b14ffa97.sqlite-shm +0 -0
- package/template/.wrangler/state/v3/d1/miniflare-D1DatabaseObject/803c2e37182b913f8857edf6d8776515cef4af6d48fcb25913e457f4b14ffa97.sqlite-wal +0 -0
- package/template/CLAUDE.md +296 -0
- package/template/DESIGN.md +260 -0
- package/template/DEV_CONTEXT_GUIDE.md +366 -0
- package/template/DEV_TOOLS_README.md +396 -0
- package/template/FRAMEWORK_HISTORY.md +34 -0
- package/template/PROJECT_SUMMARY.md +325 -0
- package/template/QUICKSTART.md +305 -0
- package/template/README.md +154 -0
- package/template/STRUCTURE.txt +81 -0
- package/template/admin.html +13 -0
- package/template/auth-inject.html +33 -0
- package/template/commitlint.config.js +12 -0
- package/template/docs/PERMISSION_ARCHITECTURE.md +279 -0
- package/template/docs/PERMISSION_EXAMPLES.md +230 -0
- package/template/docs/PERMISSION_SYSTEM.md +301 -0
- package/template/docs/SMART_TEST.md +171 -0
- package/template/docs/runtime-abstract.md +253 -0
- package/template/drizzle/0000_rainy_boomer.sql +101 -0
- package/template/drizzle/0001_add_todo_attachments.sql +12 -0
- package/template/drizzle/0002_chilly_magneto.sql +89 -0
- package/template/drizzle/meta/0000_snapshot.json +652 -0
- package/template/drizzle/meta/0001_snapshot.json +735 -0
- package/template/drizzle/meta/0002_snapshot.json +1198 -0
- package/template/drizzle/meta/_journal.json +27 -0
- package/template/drizzle.config.ts +13 -0
- package/template/eslint-rules/README-no-middleware-in-routes.md +154 -0
- package/template/eslint-rules/__tests__/enforce-valid-method.test.ts +251 -0
- package/template/eslint-rules/__tests__/layer-boundary.test.ts +102 -0
- package/template/eslint-rules/__tests__/module-boundary.test.ts +77 -0
- package/template/eslint-rules/__tests__/no-direct-zod-import-in-file-routes.test.ts +45 -0
- package/template/eslint-rules/__tests__/no-new-old-service-naming.test.ts +76 -0
- package/template/eslint-rules/e2e-test-location.js +153 -0
- package/template/eslint-rules/enforce-valid-method.js +217 -0
- package/template/eslint-rules/flat-routes-services.js +69 -0
- package/template/eslint-rules/framework-protect.js +186 -0
- package/template/eslint-rules/layer-boundary.js +164 -0
- package/template/eslint-rules/limit-type-complexity.js +130 -0
- package/template/eslint-rules/middleware-location.js +162 -0
- package/template/eslint-rules/module-boundary.js +125 -0
- package/template/eslint-rules/no-ambiguous-file-paths.js +64 -0
- package/template/eslint-rules/no-any-on-apiclient.js +173 -0
- package/template/eslint-rules/no-boolean-success.js +43 -0
- package/template/eslint-rules/no-deep-relative-imports.js +69 -0
- package/template/eslint-rules/no-direct-fetch.js +122 -0
- package/template/eslint-rules/no-direct-ws-sse.js +57 -0
- package/template/eslint-rules/no-direct-zod-import-in-file-routes.js +54 -0
- package/template/eslint-rules/no-disable-direct-fetch.js +57 -0
- package/template/eslint-rules/no-disable-type-safe-client.js +58 -0
- package/template/eslint-rules/no-inline-schema.js +220 -0
- package/template/eslint-rules/no-middleware-in-routes.js +81 -0
- package/template/eslint-rules/no-new-old-service-naming.js +123 -0
- package/template/eslint-rules/no-type-assertion-in-rpc.js +99 -0
- package/template/eslint-rules/no-type-assertion-on-shared-types.js +109 -0
- package/template/eslint-rules/no-util-functions-in-service.js +128 -0
- package/template/eslint-rules/prefer-shared-types.js +352 -0
- package/template/eslint-rules/protect-ws-sse-interface.js +66 -0
- package/template/eslint-rules/require-antd-generic-types.js +73 -0
- package/template/eslint-rules/require-file-openapi-props.js +114 -0
- package/template/eslint-rules/require-hono-chain-syntax.js +129 -0
- package/template/eslint-rules/require-nullable-for-optional.js +99 -0
- package/template/eslint-rules/require-response-helpers.js +140 -0
- package/template/eslint-rules/require-type-safe-test-client.js +106 -0
- package/template/eslint-rules/route-location.js +72 -0
- package/template/eslint.config.js +231 -0
- package/template/index.html +17 -0
- package/template/lint-scripts/DIRECTORY_RULES.md +335 -0
- package/template/lint-scripts/README.md +299 -0
- package/template/lint-scripts/TESTING.md +273 -0
- package/template/lint-scripts/ai-context-generator.ts +159 -0
- package/template/lint-scripts/check-framework-modify.sh +8 -0
- package/template/lint-scripts/check-menu-permissions.js +242 -0
- package/template/lint-scripts/check-refs.ts +165 -0
- package/template/lint-scripts/check-route-auth-complete.js +260 -0
- package/template/lint-scripts/check-route-auth.js +212 -0
- package/template/lint-scripts/check-route-permissions.js +210 -0
- package/template/lint-scripts/config/project.config.ts +358 -0
- package/template/lint-scripts/dev-context-analyzer.ts +707 -0
- package/template/lint-scripts/dev-guide-generator.ts +830 -0
- package/template/lint-scripts/dev-server.ts +58 -0
- package/template/lint-scripts/eslint-route-auth.js +158 -0
- package/template/lint-scripts/eslint-routes-permission.js +147 -0
- package/template/lint-scripts/fix-route-auth.js +245 -0
- package/template/lint-scripts/framework/check-modify.ts +152 -0
- package/template/lint-scripts/framework/hash-utils.ts +180 -0
- package/template/lint-scripts/framework/init-baseline.ts +84 -0
- package/template/lint-scripts/framework/update-baseline.ts +148 -0
- package/template/lint-scripts/post-commit-track.ts +66 -0
- package/template/lint-scripts/quick-test.sh +27 -0
- package/template/lint-scripts/smart-test.ts +268 -0
- package/template/lint-scripts/test-history.ts +360 -0
- package/template/lint-scripts/test-tracker.ts +350 -0
- package/template/lint-scripts/validate-all.ts +250 -0
- package/template/lint-scripts/validators/api-coverage.validator.ts +355 -0
- package/template/lint-scripts/validators/client-rpc.validator.ts +190 -0
- package/template/lint-scripts/validators/client-tests.validator.ts +155 -0
- package/template/lint-scripts/validators/console-log.validator.ts +122 -0
- package/template/lint-scripts/validators/directory-structure.validator.ts +181 -0
- package/template/lint-scripts/validators/imports.validator.ts +180 -0
- package/template/lint-scripts/validators/index.ts +271 -0
- package/template/lint-scripts/validators/md-refs.validator.ts +165 -0
- package/template/lint-scripts/validators/module-tests.validator.ts +112 -0
- package/template/lint-scripts/validators/sensitive.validator.ts +185 -0
- package/template/lint-scripts/validators/server-rpc.validator.ts +141 -0
- package/template/lint-scripts/validators/test-quality.validator.ts +257 -0
- package/template/lint-scripts/validators/todos.validator.ts +126 -0
- package/template/lint-scripts/watch-validator.ts +131 -0
- package/template/modules.config.ts +71 -0
- package/template/package-lock.json +14554 -0
- package/template/package.json +158 -0
- package/template/patches/@hono+zod-openapi+1.2.2.patch +67 -0
- package/template/patches/@hono+zod-validator+0.7.6.patch +13 -0
- package/template/patches/hono+4.12.16.patch +246 -0
- package/template/patches/typescript+5.8.3.patch +26 -0
- package/template/playwright.config.ts +60 -0
- package/template/pnpm-lock.yaml +7137 -0
- package/template/postcss.config.js +6 -0
- package/template/scripts/create-template.ts +1724 -0
- package/template/src/admin/App.tsx +59 -0
- package/template/src/admin/components/AccountSwitcher.tsx +104 -0
- package/template/src/admin/components/CaptchaModal.tsx +150 -0
- package/template/src/admin/components/NotificationDrawer.tsx +213 -0
- package/template/src/admin/components/PageHeader.tsx +45 -0
- package/template/src/admin/components/PermissionConfigEditor.tsx +237 -0
- package/template/src/admin/components/PermissionGuard.tsx +108 -0
- package/template/src/admin/components/PermissionTree.tsx +193 -0
- package/template/src/admin/components/ProtectedRoute.tsx +33 -0
- package/template/src/admin/components/StatsCard.tsx +44 -0
- package/template/src/admin/components/UserFormModal.tsx +67 -0
- package/template/src/admin/components/UserTable.tsx +72 -0
- package/template/src/admin/components/__tests__/PageHeader.test.tsx +48 -0
- package/template/src/admin/components/__tests__/PermissionConfigEditor.test.tsx +147 -0
- package/template/src/admin/components/__tests__/PermissionGuard.test.tsx +221 -0
- package/template/src/admin/components/__tests__/PermissionTree.test.tsx +187 -0
- package/template/src/admin/components/__tests__/ProtectedRoute.test.tsx +129 -0
- package/template/src/admin/components/__tests__/StatsCard.test.tsx +44 -0
- package/template/src/admin/components/__tests__/UserFormModal.test.tsx +125 -0
- package/template/src/admin/components/__tests__/UserTable.test.tsx +89 -0
- package/template/src/admin/components/index.ts +7 -0
- package/template/src/admin/hooks/__tests__/useAuditLogs.test.ts +109 -0
- package/template/src/admin/hooks/__tests__/usePermissions.test.tsx +327 -0
- package/template/src/admin/hooks/__tests__/usePermissionsBranches.test.ts +198 -0
- package/template/src/admin/hooks/__tests__/useRoles.test.ts +261 -0
- package/template/src/admin/hooks/useAdminNotifications.ts +156 -0
- package/template/src/admin/hooks/useAuditLogs.ts +44 -0
- package/template/src/admin/hooks/useConfig.ts +168 -0
- package/template/src/admin/hooks/usePermissions.ts +156 -0
- package/template/src/admin/hooks/useRoles.ts +120 -0
- package/template/src/admin/layouts/Header.tsx +93 -0
- package/template/src/admin/layouts/Layout.tsx +23 -0
- package/template/src/admin/layouts/Sidebar.tsx +120 -0
- package/template/src/admin/main.tsx +18 -0
- package/template/src/admin/pages/ContentPage.tsx +252 -0
- package/template/src/admin/pages/DashboardPage.tsx +141 -0
- package/template/src/admin/pages/DisputesPage.tsx +261 -0
- package/template/src/admin/pages/LoginPage.tsx +121 -0
- package/template/src/admin/pages/MediaTestPage.tsx +524 -0
- package/template/src/admin/pages/OrdersPage.tsx +302 -0
- package/template/src/admin/pages/PermissionsPage.tsx +95 -0
- package/template/src/admin/pages/RegisterPage.tsx +103 -0
- package/template/src/admin/pages/RolesPage.tsx +330 -0
- package/template/src/admin/pages/SettingsPage.tsx +73 -0
- package/template/src/admin/pages/SystemLogsPage.tsx +218 -0
- package/template/src/admin/pages/TestCaptchaPage.tsx +120 -0
- package/template/src/admin/pages/TicketsPage.tsx +292 -0
- package/template/src/admin/pages/UsersPage.tsx +282 -0
- package/template/src/admin/pages/__tests__/ContentPage.test.tsx +213 -0
- package/template/src/admin/pages/__tests__/DashboardPage.test.tsx +153 -0
- package/template/src/admin/pages/__tests__/DisputesPage.test.tsx +196 -0
- package/template/src/admin/pages/__tests__/LoginPage.test.tsx +112 -0
- package/template/src/admin/pages/__tests__/OrdersPage.test.tsx +217 -0
- package/template/src/admin/pages/__tests__/PermissionsPage.test.tsx +119 -0
- package/template/src/admin/pages/__tests__/RegisterPage.test.tsx +179 -0
- package/template/src/admin/pages/__tests__/RolesPage.test.tsx +256 -0
- package/template/src/admin/pages/__tests__/SettingsPage.test.tsx +66 -0
- package/template/src/admin/pages/__tests__/SystemLogsPage.test.tsx +125 -0
- package/template/src/admin/pages/__tests__/TicketsPage.test.tsx +202 -0
- package/template/src/admin/pages/__tests__/UsersPage.test.tsx +229 -0
- package/template/src/admin/services/README.md +263 -0
- package/template/src/admin/services/TESTING.md +323 -0
- package/template/src/admin/services/__tests__/skipLoading.test.ts +146 -0
- package/template/src/admin/services/apiClient.ts +66 -0
- package/template/src/admin/services/requestInterceptor.ts +127 -0
- package/template/src/admin/services/types.ts +5 -0
- package/template/src/admin/stores/__tests__/adminStore.test.ts +184 -0
- package/template/src/admin/stores/__tests__/adminStoreBranches.test.ts +148 -0
- package/template/src/admin/stores/__tests__/captchaStore.test.ts +75 -0
- package/template/src/admin/stores/__tests__/captchaStoreBranches.test.ts +37 -0
- package/template/src/admin/stores/__tests__/loadingStore.test.ts +68 -0
- package/template/src/admin/stores/adminStore.ts +88 -0
- package/template/src/admin/stores/captchaStore.ts +47 -0
- package/template/src/admin/stores/loadingStore.ts +27 -0
- package/template/src/cli/index.ts +22 -0
- package/template/src/cli/modules/config/index.ts +132 -0
- package/template/src/cli/modules/index.ts +12 -0
- package/template/src/cli/modules/notification/index.ts +86 -0
- package/template/src/cli/modules/todo/index.ts +60 -0
- package/template/src/cli/rpc/client.ts +23 -0
- package/template/src/cli/rpc/index.ts +1 -0
- package/template/src/cli/utils/api.ts +17 -0
- package/template/src/cli/utils/auto-command.ts +229 -0
- package/template/src/cli/utils/index.ts +8 -0
- package/template/src/cli/utils/logger.ts +79 -0
- package/template/src/client/App.tsx +24 -0
- package/template/src/client/Layout.tsx +27 -0
- package/template/src/client/components/AuthButton.tsx +41 -0
- package/template/src/client/components/ConnectionStatus.tsx +75 -0
- package/template/src/client/components/EmptyState.tsx +26 -0
- package/template/src/client/components/Footer.tsx +17 -0
- package/template/src/client/components/LoadingSpinner.tsx +26 -0
- package/template/src/client/components/MessageCard.tsx +61 -0
- package/template/src/client/components/Navigation.tsx +65 -0
- package/template/src/client/components/StatusBadge.tsx +50 -0
- package/template/src/client/components/__tests__/App.test.tsx +79 -0
- package/template/src/client/components/__tests__/AuthButton.test.tsx +119 -0
- package/template/src/client/components/__tests__/ConnectionStatus.test.tsx +188 -0
- package/template/src/client/components/__tests__/EmptyState.test.tsx +70 -0
- package/template/src/client/components/__tests__/Footer.test.tsx +22 -0
- package/template/src/client/components/__tests__/LoadingSpinner.test.tsx +75 -0
- package/template/src/client/components/__tests__/MessageCard.test.tsx +142 -0
- package/template/src/client/components/__tests__/Navigation.test.tsx +40 -0
- package/template/src/client/components/__tests__/StatusBadge.test.tsx +107 -0
- package/template/src/client/components/index.ts +6 -0
- package/template/src/client/index.css +27 -0
- package/template/src/client/main.tsx +25 -0
- package/template/src/client/pages/ContentDetailPage.tsx +142 -0
- package/template/src/client/pages/ContentListPage.tsx +169 -0
- package/template/src/client/pages/NotificationPage.tsx +288 -0
- package/template/src/client/pages/TodoPage.tsx +389 -0
- package/template/src/client/pages/WebSocketPage.tsx +239 -0
- package/template/src/client/pages/__tests__/ContentDetailPage.test.tsx +176 -0
- package/template/src/client/pages/__tests__/ContentListPage.test.tsx +202 -0
- package/template/src/client/pages/__tests__/NotificationPage.test.tsx +246 -0
- package/template/src/client/pages/__tests__/TodoPage.test.tsx +433 -0
- package/template/src/client/pages/__tests__/WebSocketPage.test.tsx +378 -0
- package/template/src/client/services/apiClient.ts +66 -0
- package/template/src/client/stores/__tests__/authStore.test.ts +139 -0
- package/template/src/client/stores/__tests__/chatWSStore.test.ts +416 -0
- package/template/src/client/stores/__tests__/notificationStore.test.ts +453 -0
- package/template/src/client/stores/__tests__/todoStore.test.ts +509 -0
- package/template/src/client/stores/authStore.ts +51 -0
- package/template/src/client/stores/chatWSStore.ts +122 -0
- package/template/src/client/stores/notificationStore.ts +199 -0
- package/template/src/client/stores/todoStore.ts +207 -0
- package/template/src/server/__tests__/integration/todos-api.test.ts +138 -0
- package/template/src/server/app.ts +105 -0
- package/template/src/server/config.ts +86 -0
- package/template/src/server/core/__tests__/realtime-core.test.ts +329 -0
- package/template/src/server/core/__tests__/realtime-scanner.test.ts +210 -0
- package/template/src/server/core/__tests__/runtime-node.test.ts +330 -0
- package/template/src/server/core/__tests__/runtime.test.ts +219 -0
- package/template/src/server/core/__tests__/typed-runtime.test.ts +178 -0
- package/template/src/server/core/durable-objects/RealtimeDO.ts +206 -0
- package/template/src/server/core/index.ts +83 -0
- package/template/src/server/core/module-loader.ts +281 -0
- package/template/src/server/core/realtime-core.ts +152 -0
- package/template/src/server/core/realtime-scanner.ts +99 -0
- package/template/src/server/core/runtime-cloudflare.ts +207 -0
- package/template/src/server/core/runtime-node.ts +170 -0
- package/template/src/server/core/runtime.ts +129 -0
- package/template/src/server/core/typed-runtime.ts +80 -0
- package/template/src/server/db/__tests__/driver.test.ts +203 -0
- package/template/src/server/db/config.ts +1 -0
- package/template/src/server/db/driver-cloudflare.ts +50 -0
- package/template/src/server/db/driver.ts +116 -0
- package/template/src/server/db/index.ts +3 -0
- package/template/src/server/db/init.ts +412 -0
- package/template/src/server/db/schema/api-endpoints.ts +23 -0
- package/template/src/server/db/schema/contents.ts +31 -0
- package/template/src/server/db/schema/disputes.ts +39 -0
- package/template/src/server/db/schema/index.ts +14 -0
- package/template/src/server/db/schema/notifications.ts +16 -0
- package/template/src/server/db/schema/orders.ts +30 -0
- package/template/src/server/db/schema/permission-audit-logs.ts +17 -0
- package/template/src/server/db/schema/permission-route-mappings.ts +22 -0
- package/template/src/server/db/schema/permissions.ts +17 -0
- package/template/src/server/db/schema/role-permissions.ts +22 -0
- package/template/src/server/db/schema/roles.ts +17 -0
- package/template/src/server/db/schema/tickets.ts +62 -0
- package/template/src/server/db/schema/todo-attachments.ts +22 -0
- package/template/src/server/db/schema/todos.ts +21 -0
- package/template/src/server/db/schema/user-roles.ts +17 -0
- package/template/src/server/db/seeds/index.ts +1 -0
- package/template/src/server/db/seeds/permission-data.ts +354 -0
- package/template/src/server/db/test-setup.ts +647 -0
- package/template/src/server/entries/cloudflare.ts +71 -0
- package/template/src/server/entries/node.ts +190 -0
- package/template/src/server/index.ts +62 -0
- package/template/src/server/middleware/__tests__/auth-simple.test.ts +147 -0
- package/template/src/server/middleware/__tests__/auth.test.ts +276 -0
- package/template/src/server/middleware/__tests__/captcha.test.ts +258 -0
- package/template/src/server/middleware/__tests__/error-handler.test.ts +364 -0
- package/template/src/server/middleware/__tests__/error-response-format.test.ts +80 -0
- package/template/src/server/middleware/__tests__/permission.test.ts +312 -0
- package/template/src/server/middleware/audit-log.ts +101 -0
- package/template/src/server/middleware/auth.ts +235 -0
- package/template/src/server/middleware/captcha.ts +166 -0
- package/template/src/server/middleware/cors.ts +30 -0
- package/template/src/server/middleware/error-handler.ts +135 -0
- package/template/src/server/middleware/index.ts +24 -0
- package/template/src/server/middleware/logger.ts +73 -0
- package/template/src/server/middleware/permission.ts +127 -0
- package/template/src/server/middleware/rate-limit.ts +69 -0
- package/template/src/server/middleware/realtime-env.ts +12 -0
- package/template/src/server/module-admin/__tests__/admin-routes.test.ts +360 -0
- package/template/src/server/module-admin/__tests__/admin-service.test.ts +222 -0
- package/template/src/server/module-admin/__tests__/audit-log-routes.test.ts +261 -0
- package/template/src/server/module-admin/__tests__/export-routes.test.ts +160 -0
- package/template/src/server/module-admin/__tests__/media-routes.test.ts +122 -0
- package/template/src/server/module-admin/module.ts +40 -0
- package/template/src/server/module-admin/routes/admin-notification-routes.ts +197 -0
- package/template/src/server/module-admin/routes/admin-routes.ts +20 -0
- package/template/src/server/module-admin/routes/auth-routes.ts +86 -0
- package/template/src/server/module-admin/routes/export-routes.ts +207 -0
- package/template/src/server/module-admin/routes/media-routes.ts +78 -0
- package/template/src/server/module-admin/routes/system-routes.ts +89 -0
- package/template/src/server/module-admin/routes/user-management-routes.ts +143 -0
- package/template/src/server/module-admin/services/admin-service.ts +268 -0
- package/template/src/server/module-captcha/__tests__/captcha-route.test.ts +35 -0
- package/template/src/server/module-captcha/__tests__/captcha-service.test.ts +53 -0
- package/template/src/server/module-captcha/module.ts +35 -0
- package/template/src/server/module-captcha/routes/captcha-routes.ts +68 -0
- package/template/src/server/module-captcha/services/captcha-service.ts +3 -0
- package/template/src/server/module-chat/__tests__/chat-routes.test.ts +39 -0
- package/template/src/server/module-chat/__tests__/chat-rpc.test.ts +185 -0
- package/template/src/server/module-chat/__tests__/chat-service.test.ts +64 -0
- package/template/src/server/module-chat/module.ts +27 -0
- package/template/src/server/module-chat/routes/chat-routes.ts +46 -0
- package/template/src/server/module-chat/services/chat-service.ts +38 -0
- package/template/src/server/module-content/__tests__/content-route.test.ts +40 -0
- package/template/src/server/module-content/__tests__/content-service.test.ts +107 -0
- package/template/src/server/module-content/module.ts +39 -0
- package/template/src/server/module-content/routes/content-routes.ts +182 -0
- package/template/src/server/module-content/routes/public-content-routes.ts +58 -0
- package/template/src/server/module-content/services/content-service.ts +224 -0
- package/template/src/server/module-dispute/__tests__/dispute-route.test.ts +43 -0
- package/template/src/server/module-dispute/__tests__/dispute-service.test.ts +135 -0
- package/template/src/server/module-dispute/module.ts +30 -0
- package/template/src/server/module-dispute/routes/dispute-routes.ts +153 -0
- package/template/src/server/module-dispute/services/dispute-service.ts +255 -0
- package/template/src/server/module-file/__tests__/file-routes.test.ts +284 -0
- package/template/src/server/module-file/__tests__/file-storage-service.test.ts +323 -0
- package/template/src/server/module-file/module.ts +28 -0
- package/template/src/server/module-file/routes/file-routes.ts +288 -0
- package/template/src/server/module-notifications/__tests__/notification-route-rpc.test.ts +375 -0
- package/template/src/server/module-notifications/__tests__/notification-service.test.ts +241 -0
- package/template/src/server/module-notifications/__tests__/sse-rpc.test.ts +289 -0
- package/template/src/server/module-notifications/module.ts +32 -0
- package/template/src/server/module-notifications/routes/notification-routes.ts +190 -0
- package/template/src/server/module-notifications/services/notification-service.ts +104 -0
- package/template/src/server/module-order/__tests__/order-route.test.ts +258 -0
- package/template/src/server/module-order/__tests__/order-service.test.ts +222 -0
- package/template/src/server/module-order/module.ts +30 -0
- package/template/src/server/module-order/routes/order-routes.ts +202 -0
- package/template/src/server/module-order/services/order-service.ts +268 -0
- package/template/src/server/module-permission/__tests__/permission-middleware.test.ts +90 -0
- package/template/src/server/module-permission/__tests__/permission-routes.test.ts +330 -0
- package/template/src/server/module-permission/__tests__/permission-service-impl.test.ts +388 -0
- package/template/src/server/module-permission/__tests__/permission-service.test.ts +190 -0
- package/template/src/server/module-permission/__tests__/role-routes.test.ts +215 -0
- package/template/src/server/module-permission/module.ts +68 -0
- package/template/src/server/module-permission/routes/audit-log-routes.ts +76 -0
- package/template/src/server/module-permission/routes/permission-routes.ts +184 -0
- package/template/src/server/module-permission/routes/role-routes.ts +263 -0
- package/template/src/server/module-permission/services/audit-log-service.ts +108 -0
- package/template/src/server/module-permission/services/permission-service-impl.ts +233 -0
- package/template/src/server/module-permission/services/permission-service.ts +256 -0
- package/template/src/server/module-permission/services/role-service.ts +122 -0
- package/template/src/server/module-ticket/__tests__/ticket-route.test.ts +173 -0
- package/template/src/server/module-ticket/__tests__/ticket-service.test.ts +201 -0
- package/template/src/server/module-ticket/module.ts +30 -0
- package/template/src/server/module-ticket/routes/ticket-routes.ts +210 -0
- package/template/src/server/module-ticket/services/ticket-service.ts +297 -0
- package/template/src/server/module-todos/__tests__/todo-service.test.ts +196 -0
- package/template/src/server/module-todos/__tests__/todos-file-upload.test.ts +439 -0
- package/template/src/server/module-todos/__tests__/todos-route-rpc.test.ts +575 -0
- package/template/src/server/module-todos/module.ts +30 -0
- package/template/src/server/module-todos/routes/todos-routes.ts +260 -0
- package/template/src/server/module-todos/services/todo-service.ts +202 -0
- package/template/src/server/route-registry.ts +47 -0
- package/template/src/server/test-utils/test-client.ts +66 -0
- package/template/src/server/test-utils/test-server.ts +131 -0
- package/template/src/server/types/bindings.ts +10 -0
- package/template/src/server/utils/__tests__/app-error.test.ts +374 -0
- package/template/src/server/utils/__tests__/auth.test.ts +76 -0
- package/template/src/server/utils/__tests__/captcha.test.ts +80 -0
- package/template/src/server/utils/__tests__/file-storage.test.ts +472 -0
- package/template/src/server/utils/__tests__/logger.test.ts +221 -0
- package/template/src/server/utils/__tests__/route-helpers.test.ts +264 -0
- package/template/src/server/utils/app-error.ts +355 -0
- package/template/src/server/utils/auth.ts +65 -0
- package/template/src/server/utils/captcha.ts +119 -0
- package/template/src/server/utils/date.ts +50 -0
- package/template/src/server/utils/env.ts +4 -0
- package/template/src/server/utils/file-storage.ts +462 -0
- package/template/src/server/utils/generate.ts +26 -0
- package/template/src/server/utils/id-helpers.ts +5 -0
- package/template/src/server/utils/logger.ts +139 -0
- package/template/src/server/utils/permission-utils.ts +6 -0
- package/template/src/server/utils/response.ts +40 -0
- package/template/src/server/utils/route-helpers.ts +200 -0
- package/template/src/server/utils/uuid.ts +8 -0
- package/template/src/server/utils/ws-helper.ts +30 -0
- package/template/src/shared/constants/index.ts +1 -0
- package/template/src/shared/constants/resource-types.ts +72 -0
- package/template/src/shared/core/__tests__/sse-client.test.ts +376 -0
- package/template/src/shared/core/__tests__/ws-client.test.ts +468 -0
- package/template/src/shared/core/api-request.ts +192 -0
- package/template/src/shared/core/api-schemas.ts +41 -0
- package/template/src/shared/core/index.ts +37 -0
- package/template/src/shared/core/module-manifest.ts +120 -0
- package/template/src/shared/core/protocol-types.ts +26 -0
- package/template/src/shared/core/sse-client.ts +185 -0
- package/template/src/shared/core/ws-client.ts +236 -0
- package/template/src/shared/hooks/index.ts +2 -0
- package/template/src/shared/hooks/useSSE.ts +57 -0
- package/template/src/shared/hooks/useWebSocket.ts +66 -0
- package/template/src/shared/index.ts +5 -0
- package/template/src/shared/modules/admin/index.ts +1 -0
- package/template/src/shared/modules/admin/schemas.ts +100 -0
- package/template/src/shared/modules/audit/index.ts +1 -0
- package/template/src/shared/modules/audit/schemas.ts +24 -0
- package/template/src/shared/modules/captcha/index.ts +1 -0
- package/template/src/shared/modules/captcha/schemas.ts +19 -0
- package/template/src/shared/modules/chat/index.ts +38 -0
- package/template/src/shared/modules/content/index.ts +1 -0
- package/template/src/shared/modules/content/schemas.ts +53 -0
- package/template/src/shared/modules/dispute/index.ts +1 -0
- package/template/src/shared/modules/dispute/schemas.ts +62 -0
- package/template/src/shared/modules/files/index.ts +11 -0
- package/template/src/shared/modules/files/schemas.ts +44 -0
- package/template/src/shared/modules/index.ts +70 -0
- package/template/src/shared/modules/notifications/index.ts +26 -0
- package/template/src/shared/modules/notifications/schemas.ts +73 -0
- package/template/src/shared/modules/order/index.ts +1 -0
- package/template/src/shared/modules/order/schemas.ts +63 -0
- package/template/src/shared/modules/permission/index.ts +42 -0
- package/template/src/shared/modules/permission/permission-dependencies.ts +50 -0
- package/template/src/shared/modules/permission/permissions.ts +275 -0
- package/template/src/shared/modules/permission/schemas.ts +92 -0
- package/template/src/shared/modules/permission/types.ts +23 -0
- package/template/src/shared/modules/role/index.ts +1 -0
- package/template/src/shared/modules/role/schemas.ts +46 -0
- package/template/src/shared/modules/ticket/index.ts +1 -0
- package/template/src/shared/modules/ticket/schemas.ts +77 -0
- package/template/src/shared/modules/todos/index.ts +20 -0
- package/template/src/shared/modules/todos/schemas.ts +65 -0
- package/template/src/shared/schemas/index.ts +79 -0
- package/template/src/types/global.d.ts +14 -0
- package/template/src/vite-env.d.ts +21 -0
- package/template/tailwind.config.js +11 -0
- package/template/tests/e2e/admin-crud.spec.ts +81 -0
- package/template/tests/e2e/case-o1.spec.ts +108 -0
- package/template/tests/e2e/global-setup.ts +73 -0
- package/template/tests/e2e/global-teardown.ts +28 -0
- package/template/tests/e2e/notification.spec.ts +458 -0
- package/template/tests/e2e/todo.spec.ts +623 -0
- package/template/tests/e2e/websocket.spec.ts +254 -0
- package/template/tsconfig.json +35 -0
- package/template/tsup.config.ts +95 -0
- package/template/vite-plugins.ts +113 -0
- package/template/vite.config.ts +96 -0
- package/template/vitest.config.ts +53 -0
- package/template/vitest.integration.config.ts +24 -0
- package/template/vitest.integration.setup.ts +22 -0
- package/template/vitest.setup.ts +74 -0
- package/template/wrangler.toml +33 -0
|
@@ -0,0 +1,830 @@
|
|
|
1
|
+
#!/usr/bin/env node
|
|
2
|
+
|
|
3
|
+
import { readFileSync, existsSync, writeFileSync } from 'fs'
|
|
4
|
+
import { join, basename } from 'path'
|
|
5
|
+
import { execSync } from 'child_process'
|
|
6
|
+
|
|
7
|
+
interface DevelopmentGuide {
|
|
8
|
+
title: string
|
|
9
|
+
description: string
|
|
10
|
+
steps: DevelopmentStep[]
|
|
11
|
+
codeExamples: CodeExample[]
|
|
12
|
+
relatedFiles: string[]
|
|
13
|
+
testingGuide: string[]
|
|
14
|
+
commonMistakes: string[]
|
|
15
|
+
}
|
|
16
|
+
|
|
17
|
+
interface DevelopmentStep {
|
|
18
|
+
order: number
|
|
19
|
+
title: string
|
|
20
|
+
description: string
|
|
21
|
+
files: string[]
|
|
22
|
+
checklist: string[]
|
|
23
|
+
codeSnippet?: string
|
|
24
|
+
}
|
|
25
|
+
|
|
26
|
+
interface CodeExample {
|
|
27
|
+
title: string
|
|
28
|
+
code: string
|
|
29
|
+
explanation: string
|
|
30
|
+
}
|
|
31
|
+
|
|
32
|
+
const PROJECT_ROOT = process.cwd()
|
|
33
|
+
|
|
34
|
+
class DevelopmentGuideGenerator {
|
|
35
|
+
private rules: Map<string, string> = new Map()
|
|
36
|
+
|
|
37
|
+
constructor() {
|
|
38
|
+
this.loadRules()
|
|
39
|
+
}
|
|
40
|
+
|
|
41
|
+
private loadRules(): void {
|
|
42
|
+
const rulesPath = join(PROJECT_ROOT, '.claude/rules')
|
|
43
|
+
if (!existsSync(rulesPath)) return
|
|
44
|
+
|
|
45
|
+
const ruleFiles = [
|
|
46
|
+
'20-server-api.md',
|
|
47
|
+
'31-client-services.md',
|
|
48
|
+
'40-shared-types.md',
|
|
49
|
+
'60-testing-standards.md',
|
|
50
|
+
'10-api-type-inference.md',
|
|
51
|
+
]
|
|
52
|
+
|
|
53
|
+
for (const file of ruleFiles) {
|
|
54
|
+
const filePath = join(rulesPath, file)
|
|
55
|
+
if (existsSync(filePath)) {
|
|
56
|
+
const content = readFileSync(filePath, 'utf-8')
|
|
57
|
+
this.rules.set(file, content)
|
|
58
|
+
}
|
|
59
|
+
}
|
|
60
|
+
}
|
|
61
|
+
|
|
62
|
+
generateGuide(taskDescription: string): DevelopmentGuide {
|
|
63
|
+
const taskType = this.detectTaskType(taskDescription)
|
|
64
|
+
|
|
65
|
+
switch (taskType) {
|
|
66
|
+
case 'api':
|
|
67
|
+
return this.generateAPIGuide(taskDescription)
|
|
68
|
+
case 'frontend':
|
|
69
|
+
return this.generateFrontendGuide(taskDescription)
|
|
70
|
+
case 'database':
|
|
71
|
+
return this.generateDatabaseGuide(taskDescription)
|
|
72
|
+
case 'websocket':
|
|
73
|
+
return this.generateWebSocketGuide(taskDescription)
|
|
74
|
+
case 'sse':
|
|
75
|
+
return this.generateSSEGuide(taskDescription)
|
|
76
|
+
default:
|
|
77
|
+
return this.generateGeneralGuide(taskDescription)
|
|
78
|
+
}
|
|
79
|
+
}
|
|
80
|
+
|
|
81
|
+
private detectTaskType(description: string): string {
|
|
82
|
+
const desc = description.toLowerCase()
|
|
83
|
+
|
|
84
|
+
if (desc.includes('接口') || desc.includes('api') || desc.includes('路由')) {
|
|
85
|
+
return 'api'
|
|
86
|
+
}
|
|
87
|
+
if (desc.includes('前端') || desc.includes('页面') || desc.includes('组件')) {
|
|
88
|
+
return 'frontend'
|
|
89
|
+
}
|
|
90
|
+
if (desc.includes('数据库') || desc.includes('表') || desc.includes('db')) {
|
|
91
|
+
return 'database'
|
|
92
|
+
}
|
|
93
|
+
if (desc.includes('websocket') || desc.includes('ws') || desc.includes('实时')) {
|
|
94
|
+
return 'websocket'
|
|
95
|
+
}
|
|
96
|
+
if (desc.includes('sse') || desc.includes('推送') || desc.includes('通知')) {
|
|
97
|
+
return 'sse'
|
|
98
|
+
}
|
|
99
|
+
|
|
100
|
+
return 'general'
|
|
101
|
+
}
|
|
102
|
+
|
|
103
|
+
private generateAPIGuide(description: string): DevelopmentGuide {
|
|
104
|
+
const featureName = this.extractFeatureName(description)
|
|
105
|
+
|
|
106
|
+
return {
|
|
107
|
+
title: `开发 ${featureName} API 接口`,
|
|
108
|
+
description: `完整的服务端 API 开发流程,包括路由定义、服务实现、类型定义和测试`,
|
|
109
|
+
steps: [
|
|
110
|
+
{
|
|
111
|
+
order: 1,
|
|
112
|
+
title: '定义共享类型 (Schema)',
|
|
113
|
+
description: '在 shared/modules 中定义请求和响应的 Schema',
|
|
114
|
+
files: [`src/shared/modules/${featureName}/schemas.ts`],
|
|
115
|
+
checklist: [
|
|
116
|
+
'创建请求 Schema (CreateInput, UpdateInput)',
|
|
117
|
+
'创建响应 Schema (ItemSchema, ListSchema)',
|
|
118
|
+
'导出到 src/shared/modules/index.ts',
|
|
119
|
+
'确保使用 Zod 定义类型',
|
|
120
|
+
],
|
|
121
|
+
codeSnippet: this.getSchemaExample(featureName),
|
|
122
|
+
},
|
|
123
|
+
{
|
|
124
|
+
order: 2,
|
|
125
|
+
title: '创建数据库表(如需要)',
|
|
126
|
+
description: '在 server/db/schema 中定义数据库表结构',
|
|
127
|
+
files: [`src/server/db/schema/${featureName}.ts`],
|
|
128
|
+
checklist: [
|
|
129
|
+
'定义表结构 (pgTable)',
|
|
130
|
+
'定义关系 (relations)',
|
|
131
|
+
'导出到 src/server/db/schema/index.ts',
|
|
132
|
+
'运行 db:generate 生成迁移',
|
|
133
|
+
],
|
|
134
|
+
codeSnippet: this.getDatabaseExample(featureName),
|
|
135
|
+
},
|
|
136
|
+
{
|
|
137
|
+
order: 3,
|
|
138
|
+
title: '实现服务层',
|
|
139
|
+
description: '在 module 中实现业务逻辑',
|
|
140
|
+
files: [`src/server/module-${featureName}/services/${featureName}-service.ts`],
|
|
141
|
+
checklist: [
|
|
142
|
+
'实现 CRUD 操作',
|
|
143
|
+
'处理业务逻辑',
|
|
144
|
+
'使用类型安全的数据库查询',
|
|
145
|
+
'不要在 service 中定义工具函数',
|
|
146
|
+
],
|
|
147
|
+
codeSnippet: this.getServiceExample(featureName),
|
|
148
|
+
},
|
|
149
|
+
{
|
|
150
|
+
order: 4,
|
|
151
|
+
title: '定义路由',
|
|
152
|
+
description: '使用 Hono OpenAPI 定义类型安全的路由',
|
|
153
|
+
files: [`src/server/module-${featureName}/routes/${featureName}-routes.ts`],
|
|
154
|
+
checklist: [
|
|
155
|
+
'使用 createRoute 定义路由',
|
|
156
|
+
'使用链式语法 .openapi()',
|
|
157
|
+
'调用 service 层方法',
|
|
158
|
+
'使用 successResponse/errorResponse',
|
|
159
|
+
],
|
|
160
|
+
codeSnippet: this.getRouteExample(featureName),
|
|
161
|
+
},
|
|
162
|
+
{
|
|
163
|
+
order: 5,
|
|
164
|
+
title: '注册路由到应用',
|
|
165
|
+
description: '在 app.ts 中注册新路由',
|
|
166
|
+
files: ['src/server/app.ts'],
|
|
167
|
+
checklist: ['导入路由', '使用 .route() 注册', '确保在中间件之后注册'],
|
|
168
|
+
codeSnippet: this.getAppRegistrationExample(featureName),
|
|
169
|
+
},
|
|
170
|
+
{
|
|
171
|
+
order: 6,
|
|
172
|
+
title: '编写测试',
|
|
173
|
+
description: '编写单元测试和集成测试',
|
|
174
|
+
files: [
|
|
175
|
+
`src/server/module-${featureName}/__tests__/${featureName}-service.test.ts`,
|
|
176
|
+
`src/server/module-${featureName}/__tests__/${featureName}-routes.test.ts`,
|
|
177
|
+
],
|
|
178
|
+
checklist: [
|
|
179
|
+
'测试 service 层方法',
|
|
180
|
+
'测试 API 端点',
|
|
181
|
+
'使用 testClient 进行集成测试',
|
|
182
|
+
'覆盖成功和失败场景',
|
|
183
|
+
],
|
|
184
|
+
codeSnippet: this.getTestExample(featureName),
|
|
185
|
+
},
|
|
186
|
+
],
|
|
187
|
+
codeExamples: [
|
|
188
|
+
{
|
|
189
|
+
title: '完整的 API 开发示例',
|
|
190
|
+
code: this.getFullAPIExample(featureName),
|
|
191
|
+
explanation: '展示了从 Schema 到路由的完整流程',
|
|
192
|
+
},
|
|
193
|
+
],
|
|
194
|
+
relatedFiles: [
|
|
195
|
+
'.claude/rules/20-server-api.md',
|
|
196
|
+
'.claude/rules/40-shared-types.md',
|
|
197
|
+
'.claude/rules/60-testing-standards.md',
|
|
198
|
+
],
|
|
199
|
+
testingGuide: [
|
|
200
|
+
'运行单元测试: npm test',
|
|
201
|
+
'运行集成测试: npm run test:integration',
|
|
202
|
+
'运行特定测试: npm test <test-file>',
|
|
203
|
+
'查看测试覆盖率: npm run test:coverage',
|
|
204
|
+
],
|
|
205
|
+
commonMistakes: [
|
|
206
|
+
'❌ 在路由文件中应用中间件(应在 app.ts 中)',
|
|
207
|
+
'❌ 在 service 中定义工具函数(应放在 utils/)',
|
|
208
|
+
'❌ 使用 any 类型(应使用 Zod Schema)',
|
|
209
|
+
'❌ 直接在路由中实现业务逻辑(应调用 service)',
|
|
210
|
+
'❌ 忘记导出 Schema 到 shared/modules/index.ts',
|
|
211
|
+
],
|
|
212
|
+
}
|
|
213
|
+
}
|
|
214
|
+
|
|
215
|
+
private generateFrontendGuide(description: string): DevelopmentGuide {
|
|
216
|
+
const featureName = this.extractFeatureName(description)
|
|
217
|
+
|
|
218
|
+
return {
|
|
219
|
+
title: `开发 ${featureName} 前端功能`,
|
|
220
|
+
description: `完整的前端开发流程,包括组件、状态管理和 API 集成`,
|
|
221
|
+
steps: [
|
|
222
|
+
{
|
|
223
|
+
order: 1,
|
|
224
|
+
title: '创建 API 客户端',
|
|
225
|
+
description: '在 services 中创建类型安全的 API 客户端',
|
|
226
|
+
files: [`src/client/services/apiClient.ts`],
|
|
227
|
+
checklist: ['使用 Hono RPC 客户端', '确保类型推导正确', '处理错误响应'],
|
|
228
|
+
codeSnippet: this.getAPIClientExample(featureName),
|
|
229
|
+
},
|
|
230
|
+
{
|
|
231
|
+
order: 2,
|
|
232
|
+
title: '创建状态管理',
|
|
233
|
+
description: '使用 Zustand 创建状态管理',
|
|
234
|
+
files: [`src/client/stores/${featureName}Store.ts`],
|
|
235
|
+
checklist: ['定义状态接口', '实现 actions', '处理异步操作', '导出到 stores/index.ts'],
|
|
236
|
+
codeSnippet: this.getZustandExample(featureName),
|
|
237
|
+
},
|
|
238
|
+
{
|
|
239
|
+
order: 3,
|
|
240
|
+
title: '创建 UI 组件',
|
|
241
|
+
description: '创建功能组件',
|
|
242
|
+
files: [`src/client/components/${featureName}/`],
|
|
243
|
+
checklist: ['创建展示组件', '使用 antd 组件', '处理加载和错误状态', '编写组件测试'],
|
|
244
|
+
codeSnippet: this.getComponentExample(featureName),
|
|
245
|
+
},
|
|
246
|
+
{
|
|
247
|
+
order: 4,
|
|
248
|
+
title: '创建页面',
|
|
249
|
+
description: '创建页面组件并集成功能',
|
|
250
|
+
files: [`src/client/pages/${featureName}Page.tsx`],
|
|
251
|
+
checklist: ['集成组件和状态', '处理路由参数', '添加页面测试'],
|
|
252
|
+
codeSnippet: this.getPageExample(featureName),
|
|
253
|
+
},
|
|
254
|
+
],
|
|
255
|
+
codeExamples: [],
|
|
256
|
+
relatedFiles: [
|
|
257
|
+
'.claude/rules/30-client-components.md',
|
|
258
|
+
'.claude/rules/31-client-services.md',
|
|
259
|
+
'.claude/rules/32-client-state-zustand.md',
|
|
260
|
+
],
|
|
261
|
+
testingGuide: [
|
|
262
|
+
'测试组件: npm test <component>.test.tsx',
|
|
263
|
+
'测试 Store: npm test <store>.test.ts',
|
|
264
|
+
'使用 @testing-library/react',
|
|
265
|
+
],
|
|
266
|
+
commonMistakes: [
|
|
267
|
+
'❌ 直接使用 fetch(应使用 apiClient)',
|
|
268
|
+
'❌ 在组件中直接调用 API(应通过 Store)',
|
|
269
|
+
'❌ 使用 useState 管理复杂状态(应使用 Zustand)',
|
|
270
|
+
],
|
|
271
|
+
}
|
|
272
|
+
}
|
|
273
|
+
|
|
274
|
+
private generateDatabaseGuide(description: string): DevelopmentGuide {
|
|
275
|
+
const featureName = this.extractFeatureName(description)
|
|
276
|
+
|
|
277
|
+
return {
|
|
278
|
+
title: `开发 ${featureName} 数据库功能`,
|
|
279
|
+
description: '数据库表定义、迁移和查询',
|
|
280
|
+
steps: [
|
|
281
|
+
{
|
|
282
|
+
order: 1,
|
|
283
|
+
title: '定义表结构',
|
|
284
|
+
description: '使用 Drizzle ORM 定义表',
|
|
285
|
+
files: [`src/server/db/schema/${featureName}.ts`],
|
|
286
|
+
checklist: ['定义主表', '定义关系', '添加索引', '导出到 index.ts'],
|
|
287
|
+
codeSnippet: this.getDatabaseExample(featureName),
|
|
288
|
+
},
|
|
289
|
+
{
|
|
290
|
+
order: 2,
|
|
291
|
+
title: '生成迁移',
|
|
292
|
+
description: '生成数据库迁移文件',
|
|
293
|
+
files: [],
|
|
294
|
+
checklist: ['运行 npm run db:generate', '检查生成的 SQL', '运行 npm run db:migrate'],
|
|
295
|
+
codeSnippet: 'npm run db:generate\nnpm run db:migrate',
|
|
296
|
+
},
|
|
297
|
+
],
|
|
298
|
+
codeExamples: [],
|
|
299
|
+
relatedFiles: ['drizzle.config.ts'],
|
|
300
|
+
testingGuide: ['使用测试数据库', '清理测试数据'],
|
|
301
|
+
commonMistakes: ['❌ 直接修改迁移文件', '❌ 忘记导出表定义'],
|
|
302
|
+
}
|
|
303
|
+
}
|
|
304
|
+
|
|
305
|
+
private generateWebSocketGuide(description: string): DevelopmentGuide {
|
|
306
|
+
const featureName = this.extractFeatureName(description)
|
|
307
|
+
|
|
308
|
+
return {
|
|
309
|
+
title: `开发 ${featureName} WebSocket 功能`,
|
|
310
|
+
description: '实时双向通信功能',
|
|
311
|
+
steps: [
|
|
312
|
+
{
|
|
313
|
+
order: 1,
|
|
314
|
+
title: '定义协议',
|
|
315
|
+
description: '定义 WebSocket 消息协议',
|
|
316
|
+
files: [`src/shared/modules/${featureName}/index.ts`],
|
|
317
|
+
checklist: ['定义消息类型', '使用 Zod Schema', '导出协议'],
|
|
318
|
+
codeSnippet: this.getWebSocketProtocolExample(featureName),
|
|
319
|
+
},
|
|
320
|
+
{
|
|
321
|
+
order: 2,
|
|
322
|
+
title: '实现服务端',
|
|
323
|
+
description: '实现 WebSocket 处理器',
|
|
324
|
+
files: [`src/server/module-${featureName}/services/${featureName}-service.ts`],
|
|
325
|
+
checklist: ['使用 runtime.registerRPC', '处理连接和消息', '广播消息'],
|
|
326
|
+
codeSnippet: this.getWebSocketServiceExample(featureName),
|
|
327
|
+
},
|
|
328
|
+
{
|
|
329
|
+
order: 3,
|
|
330
|
+
title: '创建客户端',
|
|
331
|
+
description: '创建 WebSocket 客户端',
|
|
332
|
+
files: [`src/shared/core/ws-client.ts`],
|
|
333
|
+
checklist: ['使用 WSClient 类', '处理重连', '类型安全调用'],
|
|
334
|
+
codeSnippet: this.getWebSocketClientExample(featureName),
|
|
335
|
+
},
|
|
336
|
+
],
|
|
337
|
+
codeExamples: [],
|
|
338
|
+
relatedFiles: ['.claude/rules/50-websocket.md'],
|
|
339
|
+
testingGuide: ['使用 testServer', '测试连接和消息'],
|
|
340
|
+
commonMistakes: ['❌ 直接使用原生 WebSocket', '❌ 不处理重连'],
|
|
341
|
+
}
|
|
342
|
+
}
|
|
343
|
+
|
|
344
|
+
private generateSSEGuide(description: string): DevelopmentGuide {
|
|
345
|
+
const featureName = this.extractFeatureName(description)
|
|
346
|
+
|
|
347
|
+
return {
|
|
348
|
+
title: `开发 ${featureName} SSE 功能`,
|
|
349
|
+
description: '服务器推送事件',
|
|
350
|
+
steps: [
|
|
351
|
+
{
|
|
352
|
+
order: 1,
|
|
353
|
+
title: '定义事件类型',
|
|
354
|
+
description: '定义 SSE 事件 Schema',
|
|
355
|
+
files: [`src/shared/modules/${featureName}/schemas.ts`],
|
|
356
|
+
checklist: ['定义事件类型', '使用 Zod Schema'],
|
|
357
|
+
codeSnippet: this.getSSESchemaExample(featureName),
|
|
358
|
+
},
|
|
359
|
+
{
|
|
360
|
+
order: 2,
|
|
361
|
+
title: '实现 SSE 路由',
|
|
362
|
+
description: '实现 SSE 端点',
|
|
363
|
+
files: [`src/server/module-${featureName}/routes/${featureName}-routes.ts`],
|
|
364
|
+
checklist: ['使用 $sse() 方法', '返回事件流', '处理错误'],
|
|
365
|
+
codeSnippet: this.getSSERouteExample(featureName),
|
|
366
|
+
},
|
|
367
|
+
{
|
|
368
|
+
order: 3,
|
|
369
|
+
title: '创建客户端',
|
|
370
|
+
description: '创建 SSE 客户端',
|
|
371
|
+
files: [`src/shared/core/sse-client.ts`],
|
|
372
|
+
checklist: ['使用 SSEClient 类', '处理重连', '类型安全'],
|
|
373
|
+
codeSnippet: this.getSSEClientExample(featureName),
|
|
374
|
+
},
|
|
375
|
+
],
|
|
376
|
+
codeExamples: [],
|
|
377
|
+
relatedFiles: ['.claude/rules/51-sse.md'],
|
|
378
|
+
testingGuide: ['不需要服务器', '使用 fakeServer'],
|
|
379
|
+
commonMistakes: ['❌ 直接使用 EventSource', '❌ 不处理重连'],
|
|
380
|
+
}
|
|
381
|
+
}
|
|
382
|
+
|
|
383
|
+
private generateGeneralGuide(description: string): DevelopmentGuide {
|
|
384
|
+
return {
|
|
385
|
+
title: '通用开发指引',
|
|
386
|
+
description: '根据任务描述生成开发步骤',
|
|
387
|
+
steps: [
|
|
388
|
+
{
|
|
389
|
+
order: 1,
|
|
390
|
+
title: '分析需求',
|
|
391
|
+
description: '理解任务需求和技术栈',
|
|
392
|
+
files: [],
|
|
393
|
+
checklist: ['确定技术栈', '识别依赖关系', '规划开发步骤'],
|
|
394
|
+
},
|
|
395
|
+
{
|
|
396
|
+
order: 2,
|
|
397
|
+
title: '查看相关规则',
|
|
398
|
+
description: '阅读开发规范文档',
|
|
399
|
+
files: ['.claude/rules/*.md'],
|
|
400
|
+
checklist: ['查看架构规范', '了解最佳实践', '避免常见错误'],
|
|
401
|
+
},
|
|
402
|
+
{
|
|
403
|
+
order: 3,
|
|
404
|
+
title: '参考现有代码',
|
|
405
|
+
description: '查看类似功能的实现',
|
|
406
|
+
files: [],
|
|
407
|
+
checklist: ['找到参考模块', '理解实现模式', '复用代码结构'],
|
|
408
|
+
},
|
|
409
|
+
],
|
|
410
|
+
codeExamples: [],
|
|
411
|
+
relatedFiles: ['.claude/rules/'],
|
|
412
|
+
testingGuide: ['编写单元测试', '编写集成测试'],
|
|
413
|
+
commonMistakes: ['跳过测试', '不遵循规范'],
|
|
414
|
+
}
|
|
415
|
+
}
|
|
416
|
+
|
|
417
|
+
private extractFeatureName(description: string): string {
|
|
418
|
+
const keywords = description.toLowerCase()
|
|
419
|
+
const patterns = [
|
|
420
|
+
/todo/i,
|
|
421
|
+
/notification/i,
|
|
422
|
+
/chat/i,
|
|
423
|
+
/order/i,
|
|
424
|
+
/user/i,
|
|
425
|
+
/admin/i,
|
|
426
|
+
/permission/i,
|
|
427
|
+
/content/i,
|
|
428
|
+
/dispute/i,
|
|
429
|
+
/ticket/i,
|
|
430
|
+
/captcha/i,
|
|
431
|
+
]
|
|
432
|
+
|
|
433
|
+
for (const pattern of patterns) {
|
|
434
|
+
if (pattern.test(keywords)) {
|
|
435
|
+
return pattern.source.toLowerCase()
|
|
436
|
+
}
|
|
437
|
+
}
|
|
438
|
+
|
|
439
|
+
return 'feature'
|
|
440
|
+
}
|
|
441
|
+
|
|
442
|
+
private getSchemaExample(feature: string): string {
|
|
443
|
+
return `// src/shared/modules/${feature}/schemas.ts
|
|
444
|
+
import { z } from '@hono/zod-openapi'
|
|
445
|
+
|
|
446
|
+
export const ${feature}Schema = z.object({
|
|
447
|
+
id: z.number(),
|
|
448
|
+
title: z.string(),
|
|
449
|
+
createdAt: z.string(),
|
|
450
|
+
})
|
|
451
|
+
|
|
452
|
+
export const create${feature.charAt(0).toUpperCase() + feature.slice(1)}Schema = z.object({
|
|
453
|
+
title: z.string().min(1),
|
|
454
|
+
})
|
|
455
|
+
|
|
456
|
+
export type ${feature.charAt(0).toUpperCase() + feature.slice(1)} = z.infer<typeof ${feature}Schema>
|
|
457
|
+
export type Create${feature.charAt(0).toUpperCase() + feature.slice(1)} = z.infer<typeof create${feature.charAt(0).toUpperCase() + feature.slice(1)}Schema>`
|
|
458
|
+
}
|
|
459
|
+
|
|
460
|
+
private getDatabaseExample(feature: string): string {
|
|
461
|
+
return `// src/server/db/schema/${feature}.ts
|
|
462
|
+
import { pgTable, serial, varchar, timestamp } from 'drizzle-orm/pg-core'
|
|
463
|
+
|
|
464
|
+
export const ${feature} = pgTable('${feature}', {
|
|
465
|
+
id: serial('id').primaryKey(),
|
|
466
|
+
title: varchar('title', { length: 255 }).notNull(),
|
|
467
|
+
createdAt: timestamp('created_at').defaultNow().notNull(),
|
|
468
|
+
})`
|
|
469
|
+
}
|
|
470
|
+
|
|
471
|
+
private getServiceExample(feature: string): string {
|
|
472
|
+
return `// src/server/module-${feature}/services/${feature}-service.ts
|
|
473
|
+
import { getDb } from '@server/db'
|
|
474
|
+
import { ${feature} } from '@server/db/schema'
|
|
475
|
+
import type { Create${feature.charAt(0).toUpperCase() + feature.slice(1)} } from '@shared/modules/${feature}/schemas'
|
|
476
|
+
|
|
477
|
+
export async function list${feature.charAt(0).toUpperCase() + feature.slice(1)}s() {
|
|
478
|
+
const db = await getDb()
|
|
479
|
+
return db.select().from(${feature})
|
|
480
|
+
}
|
|
481
|
+
|
|
482
|
+
export async function create${feature.charAt(0).toUpperCase() + feature.slice(1)}(input: Create${feature.charAt(0).toUpperCase() + feature.slice(1)}) {
|
|
483
|
+
const db = await getDb()
|
|
484
|
+
const result = await db.insert(${feature}).values(input).returning()
|
|
485
|
+
return result[0]
|
|
486
|
+
}`
|
|
487
|
+
}
|
|
488
|
+
|
|
489
|
+
private getRouteExample(feature: string): string {
|
|
490
|
+
return `// src/server/module-${feature}/routes/${feature}-routes.ts
|
|
491
|
+
import { OpenAPIHono, createRoute } from '@hono/zod-openapi'
|
|
492
|
+
import { ${feature}Schema, create${feature.charAt(0).toUpperCase() + feature.slice(1)}Schema } from '@shared/modules/${feature}/schemas'
|
|
493
|
+
import { successResponse, errorResponse } from '@server/utils/route-helpers'
|
|
494
|
+
import { list${feature.charAt(0).toUpperCase() + feature.slice(1)}s, create${feature.charAt(0).toUpperCase() + feature.slice(1)} } from '../services/${feature}-service'
|
|
495
|
+
|
|
496
|
+
const listRoute = createRoute({
|
|
497
|
+
method: 'get',
|
|
498
|
+
path: '/${feature}s',
|
|
499
|
+
responses: {
|
|
500
|
+
200: successResponse(z.array(${feature}Schema), '获取列表'),
|
|
501
|
+
},
|
|
502
|
+
})
|
|
503
|
+
|
|
504
|
+
const createRoute = createRoute({
|
|
505
|
+
method: 'post',
|
|
506
|
+
path: '/${feature}s',
|
|
507
|
+
request: {
|
|
508
|
+
body: {
|
|
509
|
+
content: {
|
|
510
|
+
'application/json': { schema: create${feature.charAt(0).toUpperCase() + feature.slice(1)}Schema },
|
|
511
|
+
},
|
|
512
|
+
},
|
|
513
|
+
},
|
|
514
|
+
responses: {
|
|
515
|
+
201: successResponse(${feature}Schema, '创建成功'),
|
|
516
|
+
400: errorResponse('参数错误'),
|
|
517
|
+
},
|
|
518
|
+
})
|
|
519
|
+
|
|
520
|
+
export const apiRoutes = new OpenAPIHono()
|
|
521
|
+
.openapi(listRoute, async c => {
|
|
522
|
+
const items = await list${feature.charAt(0).toUpperCase() + feature.slice(1)}s()
|
|
523
|
+
return c.json({ success: true, data: items })
|
|
524
|
+
})
|
|
525
|
+
.openapi(createRoute, async c => {
|
|
526
|
+
const data = c.req.valid('json')
|
|
527
|
+
const item = await create${feature.charAt(0).toUpperCase() + feature.slice(1)}(data)
|
|
528
|
+
return c.json({ success: true, data: item }, 201)
|
|
529
|
+
})`
|
|
530
|
+
}
|
|
531
|
+
|
|
532
|
+
private getAppRegistrationExample(feature: string): string {
|
|
533
|
+
return `// src/server/app.ts
|
|
534
|
+
import { ${feature}Routes } from './module-${feature}/routes/${feature}-routes'
|
|
535
|
+
|
|
536
|
+
export function createApp() {
|
|
537
|
+
return new OpenAPIHono()
|
|
538
|
+
.use('*', errorHandlerMiddleware())
|
|
539
|
+
.route('/api', ${feature}Routes) // 添加这一行
|
|
540
|
+
}`
|
|
541
|
+
}
|
|
542
|
+
|
|
543
|
+
private getTestExample(feature: string): string {
|
|
544
|
+
return `// src/server/module-${feature}/__tests__/${feature}-routes.test.ts
|
|
545
|
+
import { describe, it, expect } from 'vitest'
|
|
546
|
+
import { testClient } from '@server/test-utils/test-client'
|
|
547
|
+
import app from '@server/app'
|
|
548
|
+
|
|
549
|
+
describe('${feature} API', () => {
|
|
550
|
+
it('should list ${feature}s', async () => {
|
|
551
|
+
const client = testClient(app)
|
|
552
|
+
const res = await client.api['${feature}s'].$get()
|
|
553
|
+
const data = await res.json()
|
|
554
|
+
expect(data.success).toBe(true)
|
|
555
|
+
})
|
|
556
|
+
})`
|
|
557
|
+
}
|
|
558
|
+
|
|
559
|
+
private getFullAPIExample(feature: string): string {
|
|
560
|
+
return `${this.getSchemaExample(feature)}
|
|
561
|
+
|
|
562
|
+
${this.getServiceExample(feature)}
|
|
563
|
+
|
|
564
|
+
${this.getRouteExample(feature)}`
|
|
565
|
+
}
|
|
566
|
+
|
|
567
|
+
private getAPIClientExample(feature: string): string {
|
|
568
|
+
return `// src/client/services/apiClient.ts
|
|
569
|
+
import { hc } from 'hono/client'
|
|
570
|
+
import type { AppType } from '@server/app'
|
|
571
|
+
|
|
572
|
+
export const apiClient = hc<AppType>('/api')`
|
|
573
|
+
}
|
|
574
|
+
|
|
575
|
+
private getZustandExample(feature: string): string {
|
|
576
|
+
return `// src/client/stores/${feature}Store.ts
|
|
577
|
+
import { create } from 'zustand'
|
|
578
|
+
import type { ${feature.charAt(0).toUpperCase() + feature.slice(1)} } from '@shared/modules/${feature}/schemas'
|
|
579
|
+
|
|
580
|
+
interface ${feature.charAt(0).toUpperCase() + feature.slice(1)}State {
|
|
581
|
+
items: ${feature.charAt(0).toUpperCase() + feature.slice(1)}[]
|
|
582
|
+
loading: boolean
|
|
583
|
+
fetchItems: () => Promise<void>
|
|
584
|
+
}
|
|
585
|
+
|
|
586
|
+
export const use${feature.charAt(0).toUpperCase() + feature.slice(1)}Store = create<${feature.charAt(0).toUpperCase() + feature.slice(1)}State>(set => ({
|
|
587
|
+
items: [],
|
|
588
|
+
loading: false,
|
|
589
|
+
fetchItems: async () => {
|
|
590
|
+
set({ loading: true })
|
|
591
|
+
const res = await apiClient.api['${feature}s'].$get()
|
|
592
|
+
const data = await res.json()
|
|
593
|
+
set({ items: data.data, loading: false })
|
|
594
|
+
},
|
|
595
|
+
}))`
|
|
596
|
+
}
|
|
597
|
+
|
|
598
|
+
private getComponentExample(feature: string): string {
|
|
599
|
+
return `// src/client/components/${feature}/${feature.charAt(0).toUpperCase() + feature.slice(1)}List.tsx
|
|
600
|
+
import { use${feature.charAt(0).toUpperCase() + feature.slice(1)}Store } from '@client/stores/${feature}Store'
|
|
601
|
+
|
|
602
|
+
export function ${feature.charAt(0).toUpperCase() + feature.slice(1)}List() {
|
|
603
|
+
const { items, loading, fetchItems } = use${feature.charAt(0).toUpperCase() + feature.slice(1)}Store()
|
|
604
|
+
|
|
605
|
+
useEffect(() => {
|
|
606
|
+
fetchItems()
|
|
607
|
+
}, [])
|
|
608
|
+
|
|
609
|
+
if (loading) return <div>Loading...</div>
|
|
610
|
+
|
|
611
|
+
return (
|
|
612
|
+
<ul>
|
|
613
|
+
{items.map(item => (
|
|
614
|
+
<li key={item.id}>{item.title}</li>
|
|
615
|
+
))}
|
|
616
|
+
</ul>
|
|
617
|
+
)
|
|
618
|
+
}`
|
|
619
|
+
}
|
|
620
|
+
|
|
621
|
+
private getPageExample(feature: string): string {
|
|
622
|
+
return `// src/client/pages/${feature.charAt(0).toUpperCase() + feature.slice(1)}Page.tsx
|
|
623
|
+
import { ${feature.charAt(0).toUpperCase() + feature.slice(1)}List } from '@client/components/${feature}/${feature.charAt(0).toUpperCase() + feature.slice(1)}List'
|
|
624
|
+
|
|
625
|
+
export function ${feature.charAt(0).toUpperCase() + feature.slice(1)}Page() {
|
|
626
|
+
return (
|
|
627
|
+
<div>
|
|
628
|
+
<h1>${feature.charAt(0).toUpperCase() + feature.slice(1)}</h1>
|
|
629
|
+
<${feature.charAt(0).toUpperCase() + feature.slice(1)}List />
|
|
630
|
+
</div>
|
|
631
|
+
)
|
|
632
|
+
}`
|
|
633
|
+
}
|
|
634
|
+
|
|
635
|
+
private getWebSocketProtocolExample(feature: string): string {
|
|
636
|
+
return `// src/shared/modules/${feature}/index.ts
|
|
637
|
+
import { z } from '@hono/zod-openapi'
|
|
638
|
+
|
|
639
|
+
export const ${feature}MessageSchema = z.object({
|
|
640
|
+
type: z.literal('${feature}'),
|
|
641
|
+
data: z.any(),
|
|
642
|
+
})
|
|
643
|
+
|
|
644
|
+
export type ${feature.charAt(0).toUpperCase() + feature.slice(1)}Message = z.infer<typeof ${feature}MessageSchema>`
|
|
645
|
+
}
|
|
646
|
+
|
|
647
|
+
private getWebSocketServiceExample(feature: string): string {
|
|
648
|
+
return `// 在路由中注册 RPC 方法
|
|
649
|
+
.openapi(wsRoute, async c => {
|
|
650
|
+
const ws = await c.env.runtime.$ws(c)
|
|
651
|
+
|
|
652
|
+
ws.on('message', async (data) => {
|
|
653
|
+
// 处理消息
|
|
654
|
+
})
|
|
655
|
+
})`
|
|
656
|
+
}
|
|
657
|
+
|
|
658
|
+
private getWebSocketClientExample(feature: string): string {
|
|
659
|
+
return `// 使用 WebSocket 客户端
|
|
660
|
+
import { WSClient } from '@shared/core/ws-client'
|
|
661
|
+
|
|
662
|
+
const ws = new WSClient('ws://localhost:3010/api/${feature}/ws')
|
|
663
|
+
await ws.call('${feature}Method', { data: 'test' })`
|
|
664
|
+
}
|
|
665
|
+
|
|
666
|
+
private getSSESchemaExample(feature: string): string {
|
|
667
|
+
return `// src/shared/modules/${feature}/schemas.ts
|
|
668
|
+
export const ${feature}EventSchema = z.object({
|
|
669
|
+
id: z.string(),
|
|
670
|
+
message: z.string(),
|
|
671
|
+
timestamp: z.number(),
|
|
672
|
+
})`
|
|
673
|
+
}
|
|
674
|
+
|
|
675
|
+
private getSSERouteExample(feature: string): string {
|
|
676
|
+
return `// SSE 路由
|
|
677
|
+
.openapi(sseRoute, async c => {
|
|
678
|
+
return c.env.runtime.$sse(c, async (stream) => {
|
|
679
|
+
await stream.write({ event: '${feature}', data: { message: 'Hello' } })
|
|
680
|
+
})
|
|
681
|
+
})`
|
|
682
|
+
}
|
|
683
|
+
|
|
684
|
+
private getSSEClientExample(feature: string): string {
|
|
685
|
+
return `// 使用 SSE 客户端
|
|
686
|
+
import { SSEClient } from '@shared/core/sse-client'
|
|
687
|
+
|
|
688
|
+
const sse = new SSEClient('/api/${feature}/stream')
|
|
689
|
+
sse.on('${feature}', (data) => {
|
|
690
|
+
console.log('Event:', data)
|
|
691
|
+
})`
|
|
692
|
+
}
|
|
693
|
+
|
|
694
|
+
printGuide(guide: DevelopmentGuide): void {
|
|
695
|
+
console.log('\n' + '='.repeat(70))
|
|
696
|
+
console.log(`📖 ${guide.title}`)
|
|
697
|
+
console.log('='.repeat(70))
|
|
698
|
+
console.log(`\n${guide.description}\n`)
|
|
699
|
+
|
|
700
|
+
console.log('📋 开发步骤:\n')
|
|
701
|
+
for (const step of guide.steps) {
|
|
702
|
+
console.log(`${step.order}. ${step.title}`)
|
|
703
|
+
console.log(` ${step.description}`)
|
|
704
|
+
if (step.files.length > 0) {
|
|
705
|
+
console.log(' 文件:')
|
|
706
|
+
step.files.forEach(f => console.log(` - ${f}`))
|
|
707
|
+
}
|
|
708
|
+
if (step.checklist.length > 0) {
|
|
709
|
+
console.log(' 检查清单:')
|
|
710
|
+
step.checklist.forEach(c => console.log(` ☐ ${c}`))
|
|
711
|
+
}
|
|
712
|
+
if (step.codeSnippet) {
|
|
713
|
+
console.log('\n 代码示例:')
|
|
714
|
+
console.log(' ' + step.codeSnippet.split('\n').join('\n '))
|
|
715
|
+
}
|
|
716
|
+
console.log('')
|
|
717
|
+
}
|
|
718
|
+
|
|
719
|
+
if (guide.commonMistakes.length > 0) {
|
|
720
|
+
console.log('⚠️ 常见错误:\n')
|
|
721
|
+
guide.commonMistakes.forEach(m => console.log(` ${m}`))
|
|
722
|
+
console.log('')
|
|
723
|
+
}
|
|
724
|
+
|
|
725
|
+
if (guide.testingGuide.length > 0) {
|
|
726
|
+
console.log('🧪 测试指南:\n')
|
|
727
|
+
guide.testingGuide.forEach(t => console.log(` • ${t}`))
|
|
728
|
+
console.log('')
|
|
729
|
+
}
|
|
730
|
+
|
|
731
|
+
if (guide.relatedFiles.length > 0) {
|
|
732
|
+
console.log('📚 相关文档:\n')
|
|
733
|
+
guide.relatedFiles.forEach(f => console.log(` • ${f}`))
|
|
734
|
+
console.log('')
|
|
735
|
+
}
|
|
736
|
+
}
|
|
737
|
+
|
|
738
|
+
saveGuide(guide: DevelopmentGuide, outputPath: string): void {
|
|
739
|
+
const lines: string[] = [
|
|
740
|
+
`# ${guide.title}`,
|
|
741
|
+
'',
|
|
742
|
+
`> ${guide.description}`,
|
|
743
|
+
'',
|
|
744
|
+
'## 📋 开发步骤',
|
|
745
|
+
'',
|
|
746
|
+
]
|
|
747
|
+
|
|
748
|
+
for (const step of guide.steps) {
|
|
749
|
+
lines.push(`### ${step.order}. ${step.title}`)
|
|
750
|
+
lines.push('')
|
|
751
|
+
lines.push(step.description)
|
|
752
|
+
lines.push('')
|
|
753
|
+
|
|
754
|
+
if (step.files.length > 0) {
|
|
755
|
+
lines.push('**相关文件**:')
|
|
756
|
+
lines.push('')
|
|
757
|
+
step.files.forEach(f => lines.push(`- \`${f}\``))
|
|
758
|
+
lines.push('')
|
|
759
|
+
}
|
|
760
|
+
|
|
761
|
+
if (step.checklist.length > 0) {
|
|
762
|
+
lines.push('**检查清单**:')
|
|
763
|
+
lines.push('')
|
|
764
|
+
step.checklist.forEach(c => lines.push(`- [ ] ${c}`))
|
|
765
|
+
lines.push('')
|
|
766
|
+
}
|
|
767
|
+
|
|
768
|
+
if (step.codeSnippet) {
|
|
769
|
+
lines.push('**代码示例**:')
|
|
770
|
+
lines.push('')
|
|
771
|
+
lines.push('```typescript')
|
|
772
|
+
lines.push(step.codeSnippet)
|
|
773
|
+
lines.push('```')
|
|
774
|
+
lines.push('')
|
|
775
|
+
}
|
|
776
|
+
}
|
|
777
|
+
|
|
778
|
+
if (guide.commonMistakes.length > 0) {
|
|
779
|
+
lines.push('## ⚠️ 常见错误')
|
|
780
|
+
lines.push('')
|
|
781
|
+
guide.commonMistakes.forEach(m => lines.push(m))
|
|
782
|
+
lines.push('')
|
|
783
|
+
}
|
|
784
|
+
|
|
785
|
+
if (guide.testingGuide.length > 0) {
|
|
786
|
+
lines.push('## 🧪 测试指南')
|
|
787
|
+
lines.push('')
|
|
788
|
+
guide.testingGuide.forEach(t => lines.push(`- ${t}`))
|
|
789
|
+
lines.push('')
|
|
790
|
+
}
|
|
791
|
+
|
|
792
|
+
if (guide.relatedFiles.length > 0) {
|
|
793
|
+
lines.push('## 📚 相关文档')
|
|
794
|
+
lines.push('')
|
|
795
|
+
guide.relatedFiles.forEach(f => lines.push(`- [${basename(f)}](${f})`))
|
|
796
|
+
lines.push('')
|
|
797
|
+
}
|
|
798
|
+
|
|
799
|
+
writeFileSync(outputPath, lines.join('\n'), 'utf-8')
|
|
800
|
+
console.log(`\n✅ 开发指引已保存到: ${outputPath}\n`)
|
|
801
|
+
}
|
|
802
|
+
}
|
|
803
|
+
|
|
804
|
+
function main(): void {
|
|
805
|
+
const args = process.argv.slice(2)
|
|
806
|
+
const taskDescription = args.join(' ')
|
|
807
|
+
|
|
808
|
+
if (!taskDescription) {
|
|
809
|
+
console.log('用法: npm run dev:guide "任务描述"')
|
|
810
|
+
console.log('示例: npm run dev:guide "我要开发一个用户管理接口"')
|
|
811
|
+
process.exit(1)
|
|
812
|
+
}
|
|
813
|
+
|
|
814
|
+
const generator = new DevelopmentGuideGenerator()
|
|
815
|
+
const guide = generator.generateGuide(taskDescription)
|
|
816
|
+
|
|
817
|
+
generator.printGuide(guide)
|
|
818
|
+
|
|
819
|
+
const outputPath = join(PROJECT_ROOT, '.dev-guide.md')
|
|
820
|
+
generator.saveGuide(guide, outputPath)
|
|
821
|
+
|
|
822
|
+
console.log('💡 提示:')
|
|
823
|
+
console.log(' 1. 查看完整指引: cat .dev-guide.md')
|
|
824
|
+
console.log(' 2. 按照步骤逐一完成开发')
|
|
825
|
+
console.log(' 3. 每完成一步,勾选检查清单')
|
|
826
|
+
console.log(' 4. 参考代码示例进行实现')
|
|
827
|
+
console.log(' 5. 避免常见错误\n')
|
|
828
|
+
}
|
|
829
|
+
|
|
830
|
+
main()
|