proagents 1.0.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/LICENSE +21 -0
- package/README.md +170 -0
- package/bin/proagents.js +90 -0
- package/lib/commands/feature.js +125 -0
- package/lib/commands/fix.js +60 -0
- package/lib/commands/help.js +76 -0
- package/lib/commands/init.js +64 -0
- package/lib/commands/status.js +91 -0
- package/lib/index.js +28 -0
- package/package.json +52 -0
- package/proagents/.learning/global/common-patterns.json +77 -0
- package/proagents/.learning/global/user-preferences.json +76 -0
- package/proagents/.learning/projects/example-project/corrections.json +99 -0
- package/proagents/.learning/projects/example-project/feedback.json +109 -0
- package/proagents/.learning/projects/example-project/metrics.json +101 -0
- package/proagents/.learning/projects/example-project/patterns.json +102 -0
- package/proagents/.learning/schemas/README.md +48 -0
- package/proagents/.learning/schemas/corrections-schema.json +100 -0
- package/proagents/.learning/schemas/feedback-schema.json +144 -0
- package/proagents/.learning/schemas/metrics-schema.json +96 -0
- package/proagents/.learning/schemas/patterns-schema.json +82 -0
- package/proagents/.learning/schemas/project-patterns-schema.json +125 -0
- package/proagents/.learning/schemas/user-preferences-schema.json +136 -0
- package/proagents/GETTING-STARTED-STORY.md +708 -0
- package/proagents/README.md +99 -0
- package/proagents/WORKFLOW.md +1234 -0
- package/proagents/active-features/.gitkeep +0 -0
- package/proagents/active-features/README.md +176 -0
- package/proagents/active-features/_index.json +74 -0
- package/proagents/active-features/feature-user-auth/dependencies.json +81 -0
- package/proagents/active-features/feature-user-auth/files-modified.json +126 -0
- package/proagents/active-features/feature-user-auth/status.json +122 -0
- package/proagents/active-features/schemas/dependencies-schema.json +119 -0
- package/proagents/active-features/schemas/feature-schema.json +132 -0
- package/proagents/active-features/schemas/files-schema.json +100 -0
- package/proagents/active-features/schemas/index-schema.json +95 -0
- package/proagents/adr/README.md +302 -0
- package/proagents/adr/examples/api-versioning.md +297 -0
- package/proagents/adr/examples/database-choice.md +264 -0
- package/proagents/adr/template.md +273 -0
- package/proagents/ai-models/README.md +141 -0
- package/proagents/ai-models/cost-management.md +362 -0
- package/proagents/ai-models/fallbacks.md +342 -0
- package/proagents/ai-models/model-config.md +318 -0
- package/proagents/ai-models/task-routing.md +503 -0
- package/proagents/ai-training/README.md +155 -0
- package/proagents/ai-training/continuous-learning.md +413 -0
- package/proagents/ai-training/domain-knowledge.md +378 -0
- package/proagents/ai-training/pattern-learning.md +455 -0
- package/proagents/ai-training/training-data.md +337 -0
- package/proagents/ai-training/user-preferences.md +346 -0
- package/proagents/api-versioning/README.md +257 -0
- package/proagents/api-versioning/changelog-template.md +225 -0
- package/proagents/api-versioning/deprecation-workflow.md +470 -0
- package/proagents/api-versioning/versioning-strategy.md +291 -0
- package/proagents/approval-workflows/README.md +146 -0
- package/proagents/approval-workflows/approval-config.md +332 -0
- package/proagents/approval-workflows/approval-stages.md +503 -0
- package/proagents/approval-workflows/emergency-bypass.md +351 -0
- package/proagents/approval-workflows/examples.md +859 -0
- package/proagents/approval-workflows/notifications.md +320 -0
- package/proagents/automation/README.md +38 -0
- package/proagents/automation/ai-behavior-rules.md +339 -0
- package/proagents/automation/ai-prompt-injection.md +331 -0
- package/proagents/automation/auto-decisions.md +535 -0
- package/proagents/automation/decision-defaults.yaml +317 -0
- package/proagents/cache/README.md +110 -0
- package/proagents/cache/analysis-metadata.json +76 -0
- package/proagents/cache/conventions.json +125 -0
- package/proagents/cache/dependencies.json +85 -0
- package/proagents/cache/features.json +115 -0
- package/proagents/cache/patterns.json +105 -0
- package/proagents/cache/schemas/conventions-schema.json +138 -0
- package/proagents/cache/schemas/dependencies-schema.json +95 -0
- package/proagents/cache/schemas/features-schema.json +104 -0
- package/proagents/cache/schemas/metadata-schema.json +83 -0
- package/proagents/cache/schemas/patterns-schema.json +136 -0
- package/proagents/cache/schemas/structure-schema.json +72 -0
- package/proagents/cache/structure.json +109 -0
- package/proagents/changelog/2024/01/2024-01-10-api-url-config.md +41 -0
- package/proagents/changelog/2024/01/2024-01-12-login-bug-fix.md +69 -0
- package/proagents/changelog/2024/01/2024-01-15-user-auth-feature.md +99 -0
- package/proagents/changelog/CHANGELOG.md +82 -0
- package/proagents/changelog/README.md +327 -0
- package/proagents/changelog/entry-template.md +283 -0
- package/proagents/checklists/README.md +261 -0
- package/proagents/checklists/code-quality.md +137 -0
- package/proagents/checklists/code-review.md +148 -0
- package/proagents/checklists/pr-checklist.md +78 -0
- package/proagents/checklists/pre-deployment.md +132 -0
- package/proagents/checklists/pre-implementation.md +80 -0
- package/proagents/checklists/testing.md +120 -0
- package/proagents/cicd/README.md +338 -0
- package/proagents/cicd/azure-devops.md +267 -0
- package/proagents/cicd/github-actions.md +375 -0
- package/proagents/cicd/gitlab-ci.md +278 -0
- package/proagents/cicd/jenkins.md +317 -0
- package/proagents/cli/README.md +392 -0
- package/proagents/cli/commands-reference.md +893 -0
- package/proagents/cli/ide-integration.md +584 -0
- package/proagents/cli/shortcuts.md +394 -0
- package/proagents/cli/slash-commands.md +507 -0
- package/proagents/collaboration/README.md +143 -0
- package/proagents/collaboration/roles.md +248 -0
- package/proagents/collaboration/sessions.md +390 -0
- package/proagents/collaboration/sync.md +358 -0
- package/proagents/compliance/README.md +206 -0
- package/proagents/compliance/access-control.md +310 -0
- package/proagents/compliance/audit-logging.md +444 -0
- package/proagents/compliance/compliance-frameworks.md +429 -0
- package/proagents/compliance/reports.md +491 -0
- package/proagents/compliance/retention-policies.md +454 -0
- package/proagents/config/README.md +181 -0
- package/proagents/config/integrations/README.md +68 -0
- package/proagents/config/integrations/github.yaml +211 -0
- package/proagents/config/integrations/jira.yaml +144 -0
- package/proagents/config/integrations/linear.yaml +157 -0
- package/proagents/config/integrations/notion.yaml +203 -0
- package/proagents/config/integrations/slack.yaml +230 -0
- package/proagents/config/rules/README.md +73 -0
- package/proagents/config/rules/custom-rules.template.yaml +188 -0
- package/proagents/config/rules/validation-rules.template.yaml +177 -0
- package/proagents/config/standards/README.md +58 -0
- package/proagents/config/standards/architecture-rules.template.md +124 -0
- package/proagents/config/standards/coding-standards.template.md +107 -0
- package/proagents/config/standards/naming-conventions.template.md +114 -0
- package/proagents/config/standards/testing-standards.template.md +213 -0
- package/proagents/config/templates/README.md +74 -0
- package/proagents/config/templates/api-route.template.ts +142 -0
- package/proagents/config/templates/component.template.tsx +55 -0
- package/proagents/config/templates/hook.template.ts +93 -0
- package/proagents/config/templates/test.template.ts +171 -0
- package/proagents/config-versioning/README.md +120 -0
- package/proagents/config-versioning/changelog.md +300 -0
- package/proagents/config-versioning/rollback.md +283 -0
- package/proagents/config-versioning/versioning.md +330 -0
- package/proagents/contract-testing/README.md +223 -0
- package/proagents/contract-testing/contract-testing.md +614 -0
- package/proagents/contract-testing/pact-integration.md +507 -0
- package/proagents/contract-testing/schema-validation.md +565 -0
- package/proagents/cost/README.md +48 -0
- package/proagents/cost/cost-template.md +283 -0
- package/proagents/cost/estimation-framework.md +287 -0
- package/proagents/database/README.md +72 -0
- package/proagents/database/examples/001-create-users.sql +129 -0
- package/proagents/database/examples/002-add-preferences.sql +94 -0
- package/proagents/database/examples/003-add-index.sql +105 -0
- package/proagents/database/examples/004-rename-column.sql +122 -0
- package/proagents/database/examples/005-add-foreign-key.sql +142 -0
- package/proagents/database/examples/006-data-migration.sql +196 -0
- package/proagents/database/examples/007-drop-column.sql +163 -0
- package/proagents/database/examples/README.md +89 -0
- package/proagents/database/migration-workflow.md +478 -0
- package/proagents/database/rollback-scripts.md +487 -0
- package/proagents/database/safety-checks.md +447 -0
- package/proagents/dependency-management/README.md +140 -0
- package/proagents/dependency-management/automation.md +363 -0
- package/proagents/dependency-management/compatibility.md +319 -0
- package/proagents/dependency-management/security-scanning.md +413 -0
- package/proagents/dependency-management/update-policies.md +374 -0
- package/proagents/disaster-recovery/README.md +247 -0
- package/proagents/disaster-recovery/automation.md +366 -0
- package/proagents/disaster-recovery/backup-recovery.md +571 -0
- package/proagents/disaster-recovery/incident-response.md +565 -0
- package/proagents/disaster-recovery/rollback-procedures.md +499 -0
- package/proagents/disaster-recovery/runbooks.md +603 -0
- package/proagents/disaster-recovery/scenarios.md +892 -0
- package/proagents/disaster-recovery/testing.md +438 -0
- package/proagents/environments/README.md +244 -0
- package/proagents/environments/configuration.md +437 -0
- package/proagents/environments/promotion.md +434 -0
- package/proagents/environments/setup.md +420 -0
- package/proagents/examples/README.md +55 -0
- package/proagents/examples/backend-nodejs/README.md +188 -0
- package/proagents/examples/backend-nodejs/complete-conversation.md +601 -0
- package/proagents/examples/backend-nodejs/proagents.config.yaml +415 -0
- package/proagents/examples/backend-nodejs/workflow-example.md +909 -0
- package/proagents/examples/fullstack-nextjs/README.md +155 -0
- package/proagents/examples/fullstack-nextjs/complete-conversation.md +604 -0
- package/proagents/examples/fullstack-nextjs/proagents.config.yaml +287 -0
- package/proagents/examples/fullstack-nextjs/workflow-example.md +553 -0
- package/proagents/examples/mobile-react-native/README.md +171 -0
- package/proagents/examples/mobile-react-native/complete-conversation.md +825 -0
- package/proagents/examples/mobile-react-native/proagents.config.yaml +330 -0
- package/proagents/examples/mobile-react-native/workflow-example.md +723 -0
- package/proagents/examples/web-frontend-react/README.md +125 -0
- package/proagents/examples/web-frontend-react/complete-conversation.md +556 -0
- package/proagents/examples/web-frontend-react/proagents.config.yaml +183 -0
- package/proagents/examples/web-frontend-react/workflow-example.md +603 -0
- package/proagents/existing-projects/README.md +65 -0
- package/proagents/existing-projects/challenges.md +861 -0
- package/proagents/existing-projects/coexistence-mode.md +483 -0
- package/proagents/existing-projects/compatibility-assessment.md +541 -0
- package/proagents/existing-projects/gradual-adoption.md +515 -0
- package/proagents/existing-projects/migration-strategies.md +788 -0
- package/proagents/existing-projects/pattern-reconciliation.md +489 -0
- package/proagents/existing-projects/team-onboarding.md +617 -0
- package/proagents/existing-projects/technical-debt-handling.md +644 -0
- package/proagents/feature-flags/README.md +263 -0
- package/proagents/feature-flags/ab-testing.md +413 -0
- package/proagents/feature-flags/configuration.md +420 -0
- package/proagents/feature-flags/kill-switches.md +444 -0
- package/proagents/feature-flags/rollout-strategies.md +392 -0
- package/proagents/getting-started/README.md +60 -0
- package/proagents/getting-started/ai-training-setup.md +380 -0
- package/proagents/getting-started/ide-setup.md +195 -0
- package/proagents/getting-started/mcp-setup.md +239 -0
- package/proagents/getting-started/pm-integration.md +336 -0
- package/proagents/getting-started/prompt-engineering.md +478 -0
- package/proagents/getting-started/team-onboarding.md +236 -0
- package/proagents/git/README.md +68 -0
- package/proagents/git/branch-strategy.md +164 -0
- package/proagents/git/commit-conventions.md +241 -0
- package/proagents/git/pr-workflow.md +286 -0
- package/proagents/git/rollback-procedures.md +416 -0
- package/proagents/i18n/README.md +133 -0
- package/proagents/i18n/extraction.md +433 -0
- package/proagents/i18n/tms-integration.md +332 -0
- package/proagents/i18n/translation-workflow.md +413 -0
- package/proagents/i18n/validation.md +355 -0
- package/proagents/ide-integration/README.md +124 -0
- package/proagents/ide-integration/cline-config.md +429 -0
- package/proagents/ide-integration/continue-config.md +380 -0
- package/proagents/ide-integration/cursor-rules.md +280 -0
- package/proagents/ide-integration/github-copilot.md +384 -0
- package/proagents/ide-integration/windsurf-rules.md +314 -0
- package/proagents/integrations/README.md +97 -0
- package/proagents/integrations/pm/README.md +344 -0
- package/proagents/learning/README.md +136 -0
- package/proagents/learning/adaptation.md +305 -0
- package/proagents/learning/data-collection.md +283 -0
- package/proagents/learning/implementation-guide.md +865 -0
- package/proagents/learning/reports.md +306 -0
- package/proagents/logging/README.md +276 -0
- package/proagents/logging/aggregation.md +475 -0
- package/proagents/logging/log-levels.md +376 -0
- package/proagents/logging/sensitive-data.md +423 -0
- package/proagents/logging/structured-logging.md +406 -0
- package/proagents/mcp/README.md +133 -0
- package/proagents/mcp/context-providers.md +442 -0
- package/proagents/mcp/server-config.md +306 -0
- package/proagents/mcp/tools-definition.md +513 -0
- package/proagents/metrics/README.md +174 -0
- package/proagents/metrics/code-quality-kpis.md +461 -0
- package/proagents/metrics/deployment-metrics.md +517 -0
- package/proagents/metrics/developer-productivity.md +368 -0
- package/proagents/metrics/learning-effectiveness.md +478 -0
- package/proagents/migrations/README.md +77 -0
- package/proagents/migrations/from-claude-projects.md +312 -0
- package/proagents/migrations/from-cursor-rules.md +345 -0
- package/proagents/migrations/from-custom-workflows.md +410 -0
- package/proagents/monitoring/README.md +308 -0
- package/proagents/monitoring/alerting.md +449 -0
- package/proagents/monitoring/dashboards.md +454 -0
- package/proagents/monitoring/health-checks.md +436 -0
- package/proagents/monitoring/metrics.md +434 -0
- package/proagents/multi-project/README.md +170 -0
- package/proagents/multi-project/coordinated-deploy.md +510 -0
- package/proagents/multi-project/cross-project-deps.md +395 -0
- package/proagents/multi-project/unified-changelog.md +477 -0
- package/proagents/multi-project/walkthroughs/monorepo-setup.md +787 -0
- package/proagents/multi-project/workspace-config.md +408 -0
- package/proagents/notifications/README.md +151 -0
- package/proagents/notifications/channels.md +457 -0
- package/proagents/notifications/preferences.md +415 -0
- package/proagents/notifications/routing.md +449 -0
- package/proagents/notifications/scheduling.md +425 -0
- package/proagents/notifications/templates.md +446 -0
- package/proagents/offline-mode/README.md +145 -0
- package/proagents/offline-mode/caching.md +344 -0
- package/proagents/offline-mode/offline-operations.md +312 -0
- package/proagents/offline-mode/queue-specifications.md +679 -0
- package/proagents/offline-mode/sync.md +475 -0
- package/proagents/parallel-features/README.md +85 -0
- package/proagents/parallel-features/conflict-detection.md +226 -0
- package/proagents/parallel-features/dependency-management.md +392 -0
- package/proagents/parallel-features/merge-coordination.md +506 -0
- package/proagents/parallel-features/tracking-system.md +416 -0
- package/proagents/patterns/README.md +305 -0
- package/proagents/patterns/api-errors.md +453 -0
- package/proagents/patterns/async-errors.md +521 -0
- package/proagents/patterns/error-types.md +437 -0
- package/proagents/patterns/ui-errors.md +595 -0
- package/proagents/performance/README.md +59 -0
- package/proagents/performance/bundle-analysis.md +375 -0
- package/proagents/performance/load-testing.md +563 -0
- package/proagents/performance/runtime-metrics.md +489 -0
- package/proagents/performance/web-vitals.md +425 -0
- package/proagents/plugins/README.md +139 -0
- package/proagents/plugins/creating-plugins.md +504 -0
- package/proagents/plugins/plugin-api.md +467 -0
- package/proagents/plugins/plugin-registry.md +276 -0
- package/proagents/pm-integration/README.md +151 -0
- package/proagents/pm-integration/asana.md +346 -0
- package/proagents/pm-integration/github-issues.md +308 -0
- package/proagents/pm-integration/gitlab-issues.md +482 -0
- package/proagents/pm-integration/jira.md +364 -0
- package/proagents/pm-integration/linear.md +409 -0
- package/proagents/pm-integration/notion.md +275 -0
- package/proagents/pm-integration/sync-config.md +533 -0
- package/proagents/pm-integration/trello.md +159 -0
- package/proagents/proagents.config.yaml +213 -0
- package/proagents/prompts/00-init-wizard.md +426 -0
- package/proagents/prompts/00-init.md +219 -0
- package/proagents/prompts/01-analysis.md +244 -0
- package/proagents/prompts/02-requirements.md +399 -0
- package/proagents/prompts/03-ui-design.md +493 -0
- package/proagents/prompts/04-planning.md +505 -0
- package/proagents/prompts/05-implementation.md +518 -0
- package/proagents/prompts/06-testing.md +620 -0
- package/proagents/prompts/06.5-code-review.md +512 -0
- package/proagents/prompts/07-documentation.md +673 -0
- package/proagents/prompts/08-deployment.md +539 -0
- package/proagents/prompts/09-rollback.md +554 -0
- package/proagents/prompts/README.md +51 -0
- package/proagents/prompts/accessibility/README.md +146 -0
- package/proagents/prompts/accessibility/aria.md +276 -0
- package/proagents/prompts/accessibility/audit.md +233 -0
- package/proagents/prompts/accessibility/keyboard.md +392 -0
- package/proagents/prompts/accessibility/wcag.md +189 -0
- package/proagents/prompts/debugging/README.md +51 -0
- package/proagents/prompts/debugging/error-analysis.md +385 -0
- package/proagents/prompts/debugging/performance-debug.md +381 -0
- package/proagents/prompts/debugging/systematic.md +270 -0
- package/proagents/prompts/performance/README.md +47 -0
- package/proagents/prompts/performance/analyze.md +265 -0
- package/proagents/prompts/performance/optimize.md +347 -0
- package/proagents/prompts/refactoring/README.md +51 -0
- package/proagents/prompts/refactoring/architecture.md +531 -0
- package/proagents/prompts/refactoring/code-smells.md +174 -0
- package/proagents/prompts/refactoring/patterns.md +516 -0
- package/proagents/prompts/security-audit/README.md +197 -0
- package/proagents/prompts/security-audit/code-review.md +260 -0
- package/proagents/prompts/security-audit/vulnerability-scan.md +288 -0
- package/proagents/reporting/README.md +158 -0
- package/proagents/reporting/dashboards.md +366 -0
- package/proagents/reporting/exports.md +524 -0
- package/proagents/reporting/quality-metrics.md +385 -0
- package/proagents/reporting/templates/README.md +56 -0
- package/proagents/reporting/templates/dashboard-config.json +187 -0
- package/proagents/reporting/templates/metrics-queries.md +427 -0
- package/proagents/reporting/templates/react-dashboard.tsx +544 -0
- package/proagents/reporting/templates/widgets.md +451 -0
- package/proagents/reporting/velocity-metrics.md +340 -0
- package/proagents/reverse-engineering/README.md +151 -0
- package/proagents/reverse-engineering/architecture-extraction.md +325 -0
- package/proagents/reverse-engineering/code-analysis.md +377 -0
- package/proagents/reverse-engineering/dependency-mapping.md +567 -0
- package/proagents/reverse-engineering/diagram-generation.md +586 -0
- package/proagents/reverse-engineering/documentation-generation.md +468 -0
- package/proagents/reverse-engineering/pattern-detection.md +569 -0
- package/proagents/reverse-engineering/quality-assessment.md +733 -0
- package/proagents/rules/README.md +179 -0
- package/proagents/rules/custom-rules-template.yaml +286 -0
- package/proagents/rules/custom-rules.md +754 -0
- package/proagents/rules/validation-rules-template.yaml +517 -0
- package/proagents/runbooks/README.md +219 -0
- package/proagents/runbooks/dependency-vulnerability.md +505 -0
- package/proagents/runbooks/incident-response.md +451 -0
- package/proagents/runbooks/performance-degradation.md +584 -0
- package/proagents/runbooks/production-debugging.md +489 -0
- package/proagents/scaffolding/README.md +64 -0
- package/proagents/scaffolding/nextjs/README.md +578 -0
- package/proagents/scaffolding/nextjs/templates/api-route.ts.template +185 -0
- package/proagents/scaffolding/nextjs/templates/page.tsx.template +109 -0
- package/proagents/scaffolding/nextjs/templates/server-action.ts.template +204 -0
- package/proagents/scaffolding/nodejs/README.md +558 -0
- package/proagents/scaffolding/nodejs/templates/controller.ts.template +167 -0
- package/proagents/scaffolding/nodejs/templates/repository.ts.template +155 -0
- package/proagents/scaffolding/nodejs/templates/service.ts.template +207 -0
- package/proagents/scaffolding/project-types.md +401 -0
- package/proagents/scaffolding/react/README.md +399 -0
- package/proagents/scaffolding/react/templates/component.tsx.template +88 -0
- package/proagents/scaffolding/react/templates/hook.ts.template +127 -0
- package/proagents/scaffolding/react/templates/service.ts.template +155 -0
- package/proagents/scaffolding/react/templates/test.tsx.template +149 -0
- package/proagents/scaffolding/react-native/README.md +476 -0
- package/proagents/scaffolding/react-native/templates/hook.ts.template +226 -0
- package/proagents/scaffolding/react-native/templates/screen.tsx.template +247 -0
- package/proagents/secrets/README.md +278 -0
- package/proagents/secrets/access-control.md +443 -0
- package/proagents/secrets/rotation.md +403 -0
- package/proagents/secrets/scanning.md +487 -0
- package/proagents/secrets/storage.md +394 -0
- package/proagents/security/README.md +71 -0
- package/proagents/security/owasp-checklist.md +390 -0
- package/proagents/security/sast-guide.md +473 -0
- package/proagents/security/security-report-template.md +343 -0
- package/proagents/security/vulnerability-scanning.md +329 -0
- package/proagents/slash-commands.json +161 -0
- package/proagents/standards/README.md +120 -0
- package/proagents/standards/architecture-patterns.md +728 -0
- package/proagents/standards/architecture-rules-template.md +489 -0
- package/proagents/standards/coding-standards-template.md +489 -0
- package/proagents/standards/examples/README.md +61 -0
- package/proagents/standards/examples/nodejs-api.md +560 -0
- package/proagents/standards/examples/react-nextjs.md +428 -0
- package/proagents/standards/naming-conventions-template.md +526 -0
- package/proagents/standards/override-system.md +717 -0
- package/proagents/standards/testing-standards-template.md +220 -0
- package/proagents/team/README.md +256 -0
- package/proagents/team/code-ownership.md +306 -0
- package/proagents/team/communication-templates.md +441 -0
- package/proagents/team/handoff-protocol.md +380 -0
- package/proagents/team/ide-setup/README.md +103 -0
- package/proagents/team/ide-setup/cursor.md +276 -0
- package/proagents/team/ide-setup/jetbrains.md +330 -0
- package/proagents/team/ide-setup/neovim.md +640 -0
- package/proagents/team/ide-setup/vscode.md +348 -0
- package/proagents/team/onboarding.md +278 -0
- package/proagents/templates/README.md +57 -0
- package/proagents/templates/code-review-report.md +255 -0
- package/proagents/templates/codebase-analysis-report.md +315 -0
- package/proagents/templates/deployment-checklist.md +277 -0
- package/proagents/templates/feature-requirements.md +142 -0
- package/proagents/templates/feature-status.md +231 -0
- package/proagents/templates/implementation-plan.md +373 -0
- package/proagents/templates/rollback-plan.md +331 -0
- package/proagents/templates/test-plan.md +336 -0
- package/proagents/templates/ui-specification.md +431 -0
- package/proagents/testing-standards/README.md +229 -0
- package/proagents/testing-standards/coverage-requirements.md +198 -0
- package/proagents/testing-standards/mocking-guidelines.md +478 -0
- package/proagents/testing-standards/test-naming.md +485 -0
- package/proagents/testing-standards/test-patterns.md +488 -0
- package/proagents/troubleshooting/README.md +730 -0
- package/proagents/troubleshooting/ai-issues.md +601 -0
- package/proagents/troubleshooting/workflow-issues.md +571 -0
- package/proagents/ui-integration/README.md +77 -0
- package/proagents/ui-integration/figma-guide.md +217 -0
- package/proagents/ui-integration/manual-export-guide.md +358 -0
- package/proagents/ui-integration/sketch-interpretation.md +471 -0
- package/proagents/webhooks/README.md +126 -0
- package/proagents/webhooks/endpoints.md +298 -0
- package/proagents/webhooks/events.md +316 -0
- package/proagents/webhooks/payloads.md +325 -0
- package/proagents/webhooks/reliability.md +363 -0
- package/proagents/webhooks/security.md +380 -0
- package/proagents/workflow-modes/README.md +136 -0
- package/proagents/workflow-modes/deferred-tracking.md +405 -0
- package/proagents/workflow-modes/entry-modes.md +397 -0
- package/proagents/workflow-modes/guardrails.md +405 -0
- package/proagents/workflow-modes/mode-detection.md +358 -0
- package/proagents/workflow-modes/mode-switching.md +372 -0
|
@@ -0,0 +1,399 @@
|
|
|
1
|
+
# React (Web Frontend) Scaffold
|
|
2
|
+
|
|
3
|
+
Project structure and configuration for React applications.
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## Directory Structure
|
|
8
|
+
|
|
9
|
+
```
|
|
10
|
+
project-root/
|
|
11
|
+
├── src/
|
|
12
|
+
│ ├── components/ # Reusable UI components
|
|
13
|
+
│ │ ├── ui/ # Basic UI elements (Button, Input, etc.)
|
|
14
|
+
│ │ ├── forms/ # Form components
|
|
15
|
+
│ │ ├── layout/ # Layout components (Header, Footer, etc.)
|
|
16
|
+
│ │ └── index.ts # Component exports
|
|
17
|
+
│ │
|
|
18
|
+
│ ├── pages/ # Page components (route endpoints)
|
|
19
|
+
│ │ ├── Home/
|
|
20
|
+
│ │ │ ├── Home.tsx
|
|
21
|
+
│ │ │ ├── Home.test.tsx
|
|
22
|
+
│ │ │ └── index.ts
|
|
23
|
+
│ │ └── index.ts
|
|
24
|
+
│ │
|
|
25
|
+
│ ├── hooks/ # Custom React hooks
|
|
26
|
+
│ │ ├── useAuth.ts
|
|
27
|
+
│ │ ├── useApi.ts
|
|
28
|
+
│ │ └── index.ts
|
|
29
|
+
│ │
|
|
30
|
+
│ ├── services/ # API and external service calls
|
|
31
|
+
│ │ ├── api.ts # API client configuration
|
|
32
|
+
│ │ ├── authService.ts
|
|
33
|
+
│ │ └── index.ts
|
|
34
|
+
│ │
|
|
35
|
+
│ ├── stores/ # State management (Zustand/Redux)
|
|
36
|
+
│ │ ├── authStore.ts
|
|
37
|
+
│ │ └── index.ts
|
|
38
|
+
│ │
|
|
39
|
+
│ ├── utils/ # Utility functions
|
|
40
|
+
│ │ ├── helpers.ts
|
|
41
|
+
│ │ ├── constants.ts
|
|
42
|
+
│ │ └── index.ts
|
|
43
|
+
│ │
|
|
44
|
+
│ ├── types/ # TypeScript type definitions
|
|
45
|
+
│ │ ├── api.types.ts
|
|
46
|
+
│ │ ├── user.types.ts
|
|
47
|
+
│ │ └── index.ts
|
|
48
|
+
│ │
|
|
49
|
+
│ ├── styles/ # Global styles
|
|
50
|
+
│ │ ├── globals.css
|
|
51
|
+
│ │ └── variables.css
|
|
52
|
+
│ │
|
|
53
|
+
│ ├── App.tsx # Root component
|
|
54
|
+
│ ├── main.tsx # Entry point
|
|
55
|
+
│ └── vite-env.d.ts # Vite type definitions
|
|
56
|
+
│
|
|
57
|
+
├── public/ # Static assets
|
|
58
|
+
│ ├── favicon.ico
|
|
59
|
+
│ └── robots.txt
|
|
60
|
+
│
|
|
61
|
+
├── tests/ # Test utilities and setup
|
|
62
|
+
│ ├── setup.ts
|
|
63
|
+
│ └── utils.tsx
|
|
64
|
+
│
|
|
65
|
+
├── .husky/ # Git hooks
|
|
66
|
+
│ ├── pre-commit
|
|
67
|
+
│ └── commit-msg
|
|
68
|
+
│
|
|
69
|
+
├── proagents/ # ProAgents configuration
|
|
70
|
+
│ └── ...
|
|
71
|
+
│
|
|
72
|
+
├── index.html # HTML entry point
|
|
73
|
+
├── package.json
|
|
74
|
+
├── tsconfig.json
|
|
75
|
+
├── vite.config.ts
|
|
76
|
+
├── vitest.config.ts
|
|
77
|
+
├── eslint.config.js
|
|
78
|
+
├── prettier.config.js
|
|
79
|
+
├── tailwind.config.js # If using Tailwind
|
|
80
|
+
└── proagents.config.yaml
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
---
|
|
84
|
+
|
|
85
|
+
## Configuration Files
|
|
86
|
+
|
|
87
|
+
### package.json
|
|
88
|
+
```json
|
|
89
|
+
{
|
|
90
|
+
"name": "{{project-name}}",
|
|
91
|
+
"version": "0.1.0",
|
|
92
|
+
"private": true,
|
|
93
|
+
"type": "module",
|
|
94
|
+
"scripts": {
|
|
95
|
+
"dev": "vite",
|
|
96
|
+
"build": "tsc && vite build",
|
|
97
|
+
"preview": "vite preview",
|
|
98
|
+
"test": "vitest",
|
|
99
|
+
"test:coverage": "vitest --coverage",
|
|
100
|
+
"lint": "eslint src/",
|
|
101
|
+
"lint:fix": "eslint src/ --fix",
|
|
102
|
+
"format": "prettier --write src/",
|
|
103
|
+
"type-check": "tsc --noEmit",
|
|
104
|
+
"prepare": "husky install"
|
|
105
|
+
},
|
|
106
|
+
"dependencies": {
|
|
107
|
+
"react": "^18.2.0",
|
|
108
|
+
"react-dom": "^18.2.0",
|
|
109
|
+
"react-router-dom": "^6.20.0",
|
|
110
|
+
"zustand": "^4.4.0",
|
|
111
|
+
"@tanstack/react-query": "^5.0.0",
|
|
112
|
+
"axios": "^1.6.0",
|
|
113
|
+
"clsx": "^2.0.0"
|
|
114
|
+
},
|
|
115
|
+
"devDependencies": {
|
|
116
|
+
"@types/react": "^18.2.0",
|
|
117
|
+
"@types/react-dom": "^18.2.0",
|
|
118
|
+
"@vitejs/plugin-react": "^4.2.0",
|
|
119
|
+
"typescript": "^5.3.0",
|
|
120
|
+
"vite": "^5.0.0",
|
|
121
|
+
"vitest": "^1.0.0",
|
|
122
|
+
"@testing-library/react": "^14.0.0",
|
|
123
|
+
"@testing-library/jest-dom": "^6.1.0",
|
|
124
|
+
"eslint": "^8.55.0",
|
|
125
|
+
"eslint-plugin-react": "^7.33.0",
|
|
126
|
+
"eslint-plugin-react-hooks": "^4.6.0",
|
|
127
|
+
"prettier": "^3.1.0",
|
|
128
|
+
"husky": "^8.0.0",
|
|
129
|
+
"@commitlint/cli": "^18.4.0",
|
|
130
|
+
"@commitlint/config-conventional": "^18.4.0"
|
|
131
|
+
}
|
|
132
|
+
}
|
|
133
|
+
```
|
|
134
|
+
|
|
135
|
+
### tsconfig.json
|
|
136
|
+
```json
|
|
137
|
+
{
|
|
138
|
+
"compilerOptions": {
|
|
139
|
+
"target": "ES2020",
|
|
140
|
+
"useDefineForClassFields": true,
|
|
141
|
+
"lib": ["ES2020", "DOM", "DOM.Iterable"],
|
|
142
|
+
"module": "ESNext",
|
|
143
|
+
"skipLibCheck": true,
|
|
144
|
+
"moduleResolution": "bundler",
|
|
145
|
+
"allowImportingTsExtensions": true,
|
|
146
|
+
"resolveJsonModule": true,
|
|
147
|
+
"isolatedModules": true,
|
|
148
|
+
"noEmit": true,
|
|
149
|
+
"jsx": "react-jsx",
|
|
150
|
+
"strict": true,
|
|
151
|
+
"noUnusedLocals": true,
|
|
152
|
+
"noUnusedParameters": true,
|
|
153
|
+
"noFallthroughCasesInSwitch": true,
|
|
154
|
+
"baseUrl": ".",
|
|
155
|
+
"paths": {
|
|
156
|
+
"@/*": ["src/*"],
|
|
157
|
+
"@components/*": ["src/components/*"],
|
|
158
|
+
"@hooks/*": ["src/hooks/*"],
|
|
159
|
+
"@services/*": ["src/services/*"],
|
|
160
|
+
"@stores/*": ["src/stores/*"],
|
|
161
|
+
"@utils/*": ["src/utils/*"],
|
|
162
|
+
"@types/*": ["src/types/*"]
|
|
163
|
+
}
|
|
164
|
+
},
|
|
165
|
+
"include": ["src"],
|
|
166
|
+
"references": [{ "path": "./tsconfig.node.json" }]
|
|
167
|
+
}
|
|
168
|
+
```
|
|
169
|
+
|
|
170
|
+
### vite.config.ts
|
|
171
|
+
```typescript
|
|
172
|
+
import { defineConfig } from 'vite';
|
|
173
|
+
import react from '@vitejs/plugin-react';
|
|
174
|
+
import path from 'path';
|
|
175
|
+
|
|
176
|
+
export default defineConfig({
|
|
177
|
+
plugins: [react()],
|
|
178
|
+
resolve: {
|
|
179
|
+
alias: {
|
|
180
|
+
'@': path.resolve(__dirname, './src'),
|
|
181
|
+
'@components': path.resolve(__dirname, './src/components'),
|
|
182
|
+
'@hooks': path.resolve(__dirname, './src/hooks'),
|
|
183
|
+
'@services': path.resolve(__dirname, './src/services'),
|
|
184
|
+
'@stores': path.resolve(__dirname, './src/stores'),
|
|
185
|
+
'@utils': path.resolve(__dirname, './src/utils'),
|
|
186
|
+
'@types': path.resolve(__dirname, './src/types'),
|
|
187
|
+
},
|
|
188
|
+
},
|
|
189
|
+
server: {
|
|
190
|
+
port: 3000,
|
|
191
|
+
},
|
|
192
|
+
build: {
|
|
193
|
+
sourcemap: true,
|
|
194
|
+
},
|
|
195
|
+
});
|
|
196
|
+
```
|
|
197
|
+
|
|
198
|
+
### vitest.config.ts
|
|
199
|
+
```typescript
|
|
200
|
+
import { defineConfig } from 'vitest/config';
|
|
201
|
+
import react from '@vitejs/plugin-react';
|
|
202
|
+
import path from 'path';
|
|
203
|
+
|
|
204
|
+
export default defineConfig({
|
|
205
|
+
plugins: [react()],
|
|
206
|
+
test: {
|
|
207
|
+
globals: true,
|
|
208
|
+
environment: 'jsdom',
|
|
209
|
+
setupFiles: './tests/setup.ts',
|
|
210
|
+
coverage: {
|
|
211
|
+
provider: 'v8',
|
|
212
|
+
reporter: ['text', 'html', 'lcov'],
|
|
213
|
+
exclude: ['node_modules/', 'tests/'],
|
|
214
|
+
},
|
|
215
|
+
},
|
|
216
|
+
resolve: {
|
|
217
|
+
alias: {
|
|
218
|
+
'@': path.resolve(__dirname, './src'),
|
|
219
|
+
},
|
|
220
|
+
},
|
|
221
|
+
});
|
|
222
|
+
```
|
|
223
|
+
|
|
224
|
+
---
|
|
225
|
+
|
|
226
|
+
## Starter Files
|
|
227
|
+
|
|
228
|
+
### src/App.tsx
|
|
229
|
+
```tsx
|
|
230
|
+
import { BrowserRouter, Routes, Route } from 'react-router-dom';
|
|
231
|
+
import { QueryClient, QueryClientProvider } from '@tanstack/react-query';
|
|
232
|
+
import { Home } from '@/pages/Home';
|
|
233
|
+
|
|
234
|
+
const queryClient = new QueryClient();
|
|
235
|
+
|
|
236
|
+
function App() {
|
|
237
|
+
return (
|
|
238
|
+
<QueryClientProvider client={queryClient}>
|
|
239
|
+
<BrowserRouter>
|
|
240
|
+
<Routes>
|
|
241
|
+
<Route path="/" element={<Home />} />
|
|
242
|
+
</Routes>
|
|
243
|
+
</BrowserRouter>
|
|
244
|
+
</QueryClientProvider>
|
|
245
|
+
);
|
|
246
|
+
}
|
|
247
|
+
|
|
248
|
+
export default App;
|
|
249
|
+
```
|
|
250
|
+
|
|
251
|
+
### src/main.tsx
|
|
252
|
+
```tsx
|
|
253
|
+
import React from 'react';
|
|
254
|
+
import ReactDOM from 'react-dom/client';
|
|
255
|
+
import App from './App';
|
|
256
|
+
import './styles/globals.css';
|
|
257
|
+
|
|
258
|
+
ReactDOM.createRoot(document.getElementById('root')!).render(
|
|
259
|
+
<React.StrictMode>
|
|
260
|
+
<App />
|
|
261
|
+
</React.StrictMode>
|
|
262
|
+
);
|
|
263
|
+
```
|
|
264
|
+
|
|
265
|
+
### src/pages/Home/Home.tsx
|
|
266
|
+
```tsx
|
|
267
|
+
export function Home() {
|
|
268
|
+
return (
|
|
269
|
+
<div>
|
|
270
|
+
<h1>Welcome to Your App</h1>
|
|
271
|
+
<p>Start building something amazing!</p>
|
|
272
|
+
</div>
|
|
273
|
+
);
|
|
274
|
+
}
|
|
275
|
+
```
|
|
276
|
+
|
|
277
|
+
### tests/setup.ts
|
|
278
|
+
```typescript
|
|
279
|
+
import '@testing-library/jest-dom';
|
|
280
|
+
```
|
|
281
|
+
|
|
282
|
+
---
|
|
283
|
+
|
|
284
|
+
## ProAgents Configuration
|
|
285
|
+
|
|
286
|
+
### proagents.config.yaml (React-specific)
|
|
287
|
+
```yaml
|
|
288
|
+
project:
|
|
289
|
+
name: "{{project-name}}"
|
|
290
|
+
type: "web-frontend"
|
|
291
|
+
framework: "react-vite"
|
|
292
|
+
language: "typescript"
|
|
293
|
+
|
|
294
|
+
phases:
|
|
295
|
+
analysis:
|
|
296
|
+
enabled: true
|
|
297
|
+
focus:
|
|
298
|
+
- "component-structure"
|
|
299
|
+
- "state-management"
|
|
300
|
+
- "routing"
|
|
301
|
+
ui_design:
|
|
302
|
+
enabled: true
|
|
303
|
+
guidelines: ["react-patterns", "accessibility"]
|
|
304
|
+
api_design:
|
|
305
|
+
enabled: false
|
|
306
|
+
testing:
|
|
307
|
+
coverage_target: 80
|
|
308
|
+
types: ["unit", "integration"]
|
|
309
|
+
|
|
310
|
+
patterns:
|
|
311
|
+
components:
|
|
312
|
+
style: "functional"
|
|
313
|
+
naming: "PascalCase"
|
|
314
|
+
structure: "folder-per-component"
|
|
315
|
+
state:
|
|
316
|
+
global: "zustand"
|
|
317
|
+
server: "react-query"
|
|
318
|
+
local: "useState"
|
|
319
|
+
styling:
|
|
320
|
+
approach: "tailwind" # or css-modules, styled-components
|
|
321
|
+
testing:
|
|
322
|
+
framework: "vitest"
|
|
323
|
+
library: "testing-library"
|
|
324
|
+
|
|
325
|
+
deployment:
|
|
326
|
+
target: "vercel" # or netlify, cloudflare-pages
|
|
327
|
+
build_command: "npm run build"
|
|
328
|
+
output_directory: "dist"
|
|
329
|
+
```
|
|
330
|
+
|
|
331
|
+
---
|
|
332
|
+
|
|
333
|
+
## Component Template
|
|
334
|
+
|
|
335
|
+
When creating new components, use this structure:
|
|
336
|
+
|
|
337
|
+
```
|
|
338
|
+
src/components/MyComponent/
|
|
339
|
+
├── MyComponent.tsx # Main component
|
|
340
|
+
├── MyComponent.test.tsx # Component tests
|
|
341
|
+
├── MyComponent.module.css # Styles (if using CSS modules)
|
|
342
|
+
└── index.ts # Export
|
|
343
|
+
```
|
|
344
|
+
|
|
345
|
+
### Component File Template
|
|
346
|
+
```tsx
|
|
347
|
+
import { memo } from 'react';
|
|
348
|
+
import type { FC } from 'react';
|
|
349
|
+
|
|
350
|
+
interface MyComponentProps {
|
|
351
|
+
title: string;
|
|
352
|
+
onClick?: () => void;
|
|
353
|
+
}
|
|
354
|
+
|
|
355
|
+
export const MyComponent: FC<MyComponentProps> = memo(({ title, onClick }) => {
|
|
356
|
+
return (
|
|
357
|
+
<div data-testid="my-component">
|
|
358
|
+
<h2>{title}</h2>
|
|
359
|
+
{onClick && <button onClick={onClick}>Click me</button>}
|
|
360
|
+
</div>
|
|
361
|
+
);
|
|
362
|
+
});
|
|
363
|
+
|
|
364
|
+
MyComponent.displayName = 'MyComponent';
|
|
365
|
+
```
|
|
366
|
+
|
|
367
|
+
### Test File Template
|
|
368
|
+
```tsx
|
|
369
|
+
import { render, screen, fireEvent } from '@testing-library/react';
|
|
370
|
+
import { describe, it, expect, vi } from 'vitest';
|
|
371
|
+
import { MyComponent } from './MyComponent';
|
|
372
|
+
|
|
373
|
+
describe('MyComponent', () => {
|
|
374
|
+
it('renders title correctly', () => {
|
|
375
|
+
render(<MyComponent title="Test Title" />);
|
|
376
|
+
expect(screen.getByText('Test Title')).toBeInTheDocument();
|
|
377
|
+
});
|
|
378
|
+
|
|
379
|
+
it('calls onClick when button is clicked', () => {
|
|
380
|
+
const handleClick = vi.fn();
|
|
381
|
+
render(<MyComponent title="Test" onClick={handleClick} />);
|
|
382
|
+
|
|
383
|
+
fireEvent.click(screen.getByRole('button'));
|
|
384
|
+
expect(handleClick).toHaveBeenCalledTimes(1);
|
|
385
|
+
});
|
|
386
|
+
});
|
|
387
|
+
```
|
|
388
|
+
|
|
389
|
+
---
|
|
390
|
+
|
|
391
|
+
## Slash Commands (React-specific)
|
|
392
|
+
|
|
393
|
+
| Command | Description |
|
|
394
|
+
|---------|-------------|
|
|
395
|
+
| `/component [name]` | Generate new component |
|
|
396
|
+
| `/hook [name]` | Generate custom hook |
|
|
397
|
+
| `/page [name]` | Generate page component |
|
|
398
|
+
| `/service [name]` | Generate service |
|
|
399
|
+
| `/store [name]` | Generate Zustand store |
|
|
@@ -0,0 +1,88 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* {{ComponentName}} Component
|
|
3
|
+
*
|
|
4
|
+
* {{description}}
|
|
5
|
+
*
|
|
6
|
+
* @example
|
|
7
|
+
* ```tsx
|
|
8
|
+
* <{{ComponentName}} title="Example" />
|
|
9
|
+
* ```
|
|
10
|
+
*/
|
|
11
|
+
|
|
12
|
+
import React, { memo } from 'react';
|
|
13
|
+
import type { FC } from 'react';
|
|
14
|
+
{{#if useStyles}}
|
|
15
|
+
import styles from './{{ComponentName}}.module.css';
|
|
16
|
+
{{/if}}
|
|
17
|
+
{{#if useTailwind}}
|
|
18
|
+
import { cn } from '@/lib/utils';
|
|
19
|
+
{{/if}}
|
|
20
|
+
|
|
21
|
+
// ============================================================================
|
|
22
|
+
// Types
|
|
23
|
+
// ============================================================================
|
|
24
|
+
|
|
25
|
+
export interface {{ComponentName}}Props {
|
|
26
|
+
/** Primary content or title */
|
|
27
|
+
title: string;
|
|
28
|
+
/** Optional description text */
|
|
29
|
+
description?: string;
|
|
30
|
+
/** Additional CSS classes */
|
|
31
|
+
className?: string;
|
|
32
|
+
/** Click handler */
|
|
33
|
+
onClick?: () => void;
|
|
34
|
+
/** Children elements */
|
|
35
|
+
children?: React.ReactNode;
|
|
36
|
+
}
|
|
37
|
+
|
|
38
|
+
// ============================================================================
|
|
39
|
+
// Component
|
|
40
|
+
// ============================================================================
|
|
41
|
+
|
|
42
|
+
/**
|
|
43
|
+
* {{ComponentName}}
|
|
44
|
+
*
|
|
45
|
+
* {{description}}
|
|
46
|
+
*/
|
|
47
|
+
export const {{ComponentName}}: FC<{{ComponentName}}Props> = memo(
|
|
48
|
+
({ title, description, className, onClick, children }) => {
|
|
49
|
+
// ========================================================================
|
|
50
|
+
// Render
|
|
51
|
+
// ========================================================================
|
|
52
|
+
|
|
53
|
+
return (
|
|
54
|
+
<div
|
|
55
|
+
{{#if useTailwind}}
|
|
56
|
+
className={cn('rounded-lg border p-4', className)}
|
|
57
|
+
{{else}}
|
|
58
|
+
className={`${styles.container} ${className || ''}`}
|
|
59
|
+
{{/if}}
|
|
60
|
+
onClick={onClick}
|
|
61
|
+
role={onClick ? 'button' : undefined}
|
|
62
|
+
tabIndex={onClick ? 0 : undefined}
|
|
63
|
+
onKeyDown={onClick ? (e) => e.key === 'Enter' && onClick() : undefined}
|
|
64
|
+
data-testid="{{kebabCase ComponentName}}"
|
|
65
|
+
>
|
|
66
|
+
<h3 className={{#if useTailwind}}"text-lg font-semibold"{{else}}{styles.title}{{/if}}>
|
|
67
|
+
{title}
|
|
68
|
+
</h3>
|
|
69
|
+
|
|
70
|
+
{description && (
|
|
71
|
+
<p className={{#if useTailwind}}"text-gray-600 mt-2"{{else}}{styles.description}{{/if}}>
|
|
72
|
+
{description}
|
|
73
|
+
</p>
|
|
74
|
+
)}
|
|
75
|
+
|
|
76
|
+
{children && (
|
|
77
|
+
<div className={{#if useTailwind}}"mt-4"{{else}}{styles.content}{{/if}}>
|
|
78
|
+
{children}
|
|
79
|
+
</div>
|
|
80
|
+
)}
|
|
81
|
+
</div>
|
|
82
|
+
);
|
|
83
|
+
}
|
|
84
|
+
);
|
|
85
|
+
|
|
86
|
+
{{ComponentName}}.displayName = '{{ComponentName}}';
|
|
87
|
+
|
|
88
|
+
export default {{ComponentName}};
|
|
@@ -0,0 +1,127 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* {{hookName}} Hook
|
|
3
|
+
*
|
|
4
|
+
* {{description}}
|
|
5
|
+
*
|
|
6
|
+
* @example
|
|
7
|
+
* ```tsx
|
|
8
|
+
* const { data, loading, error, refetch } = {{hookName}}(params);
|
|
9
|
+
* ```
|
|
10
|
+
*/
|
|
11
|
+
|
|
12
|
+
import { useState, useEffect, useCallback } from 'react';
|
|
13
|
+
{{#if useQuery}}
|
|
14
|
+
import { useQuery, useQueryClient } from '@tanstack/react-query';
|
|
15
|
+
{{/if}}
|
|
16
|
+
|
|
17
|
+
// ============================================================================
|
|
18
|
+
// Types
|
|
19
|
+
// ============================================================================
|
|
20
|
+
|
|
21
|
+
export interface {{HookName}}Params {
|
|
22
|
+
/** Primary identifier */
|
|
23
|
+
id?: string;
|
|
24
|
+
/** Enable/disable the hook */
|
|
25
|
+
enabled?: boolean;
|
|
26
|
+
}
|
|
27
|
+
|
|
28
|
+
export interface {{HookName}}Result<T> {
|
|
29
|
+
/** The fetched data */
|
|
30
|
+
data: T | null;
|
|
31
|
+
/** Loading state */
|
|
32
|
+
loading: boolean;
|
|
33
|
+
/** Error state */
|
|
34
|
+
error: Error | null;
|
|
35
|
+
/** Refetch function */
|
|
36
|
+
refetch: () => Promise<void>;
|
|
37
|
+
}
|
|
38
|
+
|
|
39
|
+
// ============================================================================
|
|
40
|
+
// Hook Implementation
|
|
41
|
+
// ============================================================================
|
|
42
|
+
|
|
43
|
+
/**
|
|
44
|
+
* {{hookName}}
|
|
45
|
+
*
|
|
46
|
+
* {{description}}
|
|
47
|
+
*
|
|
48
|
+
* @param params - Hook parameters
|
|
49
|
+
* @returns Hook result with data, loading, error, and refetch
|
|
50
|
+
*/
|
|
51
|
+
export function {{hookName}}<T = unknown>(
|
|
52
|
+
params: {{HookName}}Params = {}
|
|
53
|
+
): {{HookName}}Result<T> {
|
|
54
|
+
const { id, enabled = true } = params;
|
|
55
|
+
|
|
56
|
+
{{#if useQuery}}
|
|
57
|
+
// Using React Query
|
|
58
|
+
const queryClient = useQueryClient();
|
|
59
|
+
|
|
60
|
+
const {
|
|
61
|
+
data,
|
|
62
|
+
isLoading: loading,
|
|
63
|
+
error,
|
|
64
|
+
refetch: queryRefetch,
|
|
65
|
+
} = useQuery({
|
|
66
|
+
queryKey: ['{{hookName}}', id],
|
|
67
|
+
queryFn: async () => {
|
|
68
|
+
// Implement fetch logic
|
|
69
|
+
const response = await fetch(`/api/resource/${id}`);
|
|
70
|
+
if (!response.ok) {
|
|
71
|
+
throw new Error('Failed to fetch data');
|
|
72
|
+
}
|
|
73
|
+
return response.json() as Promise<T>;
|
|
74
|
+
},
|
|
75
|
+
enabled: enabled && !!id,
|
|
76
|
+
});
|
|
77
|
+
|
|
78
|
+
const refetch = useCallback(async () => {
|
|
79
|
+
await queryRefetch();
|
|
80
|
+
}, [queryRefetch]);
|
|
81
|
+
|
|
82
|
+
return {
|
|
83
|
+
data: data ?? null,
|
|
84
|
+
loading,
|
|
85
|
+
error: error as Error | null,
|
|
86
|
+
refetch,
|
|
87
|
+
};
|
|
88
|
+
{{else}}
|
|
89
|
+
// Using useState
|
|
90
|
+
const [data, setData] = useState<T | null>(null);
|
|
91
|
+
const [loading, setLoading] = useState(false);
|
|
92
|
+
const [error, setError] = useState<Error | null>(null);
|
|
93
|
+
|
|
94
|
+
const fetchData = useCallback(async () => {
|
|
95
|
+
if (!enabled || !id) return;
|
|
96
|
+
|
|
97
|
+
setLoading(true);
|
|
98
|
+
setError(null);
|
|
99
|
+
|
|
100
|
+
try {
|
|
101
|
+
// Implement fetch logic
|
|
102
|
+
const response = await fetch(`/api/resource/${id}`);
|
|
103
|
+
if (!response.ok) {
|
|
104
|
+
throw new Error('Failed to fetch data');
|
|
105
|
+
}
|
|
106
|
+
const result = await response.json();
|
|
107
|
+
setData(result);
|
|
108
|
+
} catch (err) {
|
|
109
|
+
setError(err instanceof Error ? err : new Error('Unknown error'));
|
|
110
|
+
} finally {
|
|
111
|
+
setLoading(false);
|
|
112
|
+
}
|
|
113
|
+
}, [id, enabled]);
|
|
114
|
+
|
|
115
|
+
useEffect(() => {
|
|
116
|
+
fetchData();
|
|
117
|
+
}, [fetchData]);
|
|
118
|
+
|
|
119
|
+
const refetch = useCallback(async () => {
|
|
120
|
+
await fetchData();
|
|
121
|
+
}, [fetchData]);
|
|
122
|
+
|
|
123
|
+
return { data, loading, error, refetch };
|
|
124
|
+
{{/if}}
|
|
125
|
+
}
|
|
126
|
+
|
|
127
|
+
export default {{hookName}};
|