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,133 @@
|
|
|
1
|
+
# Localization (i18n) Support
|
|
2
|
+
|
|
3
|
+
Multi-language support for international development teams and applications.
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## Overview
|
|
8
|
+
|
|
9
|
+
Integrate localization into your development workflow for seamless multi-language support.
|
|
10
|
+
|
|
11
|
+
```
|
|
12
|
+
┌─────────────────────────────────────────────────────────────┐
|
|
13
|
+
│ i18n Workflow │
|
|
14
|
+
├─────────────────────────────────────────────────────────────┤
|
|
15
|
+
│ │
|
|
16
|
+
│ Development │
|
|
17
|
+
│ ┌─────────┐ ┌─────────┐ ┌─────────┐ ┌─────────┐ │
|
|
18
|
+
│ │ Code │──►│ Extract │──►│Translate│──►│ Deploy │ │
|
|
19
|
+
│ └─────────┘ └─────────┘ └─────────┘ └─────────┘ │
|
|
20
|
+
│ │ │ │ │ │
|
|
21
|
+
│ ▼ ▼ ▼ ▼ │
|
|
22
|
+
│ Use t() keys Generate Send to TMS All languages │
|
|
23
|
+
│ Mark strings JSON/YAML or translate ready │
|
|
24
|
+
│ │
|
|
25
|
+
│ Validation: Check coverage, missing keys, plurals │
|
|
26
|
+
│ │
|
|
27
|
+
└─────────────────────────────────────────────────────────────┘
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
---
|
|
31
|
+
|
|
32
|
+
## Quick Start
|
|
33
|
+
|
|
34
|
+
### Enable i18n
|
|
35
|
+
|
|
36
|
+
```yaml
|
|
37
|
+
# proagents.config.yaml
|
|
38
|
+
|
|
39
|
+
i18n:
|
|
40
|
+
enabled: true
|
|
41
|
+
source_language: "en"
|
|
42
|
+
target_languages: ["es", "fr", "de", "ja", "zh"]
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
### Extract Strings
|
|
46
|
+
|
|
47
|
+
```bash
|
|
48
|
+
# Extract translatable strings
|
|
49
|
+
proagents i18n extract
|
|
50
|
+
|
|
51
|
+
# Check translation coverage
|
|
52
|
+
proagents i18n coverage
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
---
|
|
56
|
+
|
|
57
|
+
## Features
|
|
58
|
+
|
|
59
|
+
| Feature | Description |
|
|
60
|
+
|---------|-------------|
|
|
61
|
+
| **String Extraction** | Auto-extract translatable strings |
|
|
62
|
+
| **Coverage Reports** | Track translation completion |
|
|
63
|
+
| **Missing Key Detection** | Find untranslated strings |
|
|
64
|
+
| **Plural Validation** | Verify plural forms |
|
|
65
|
+
| **TMS Integration** | Connect to translation services |
|
|
66
|
+
| **CI/CD Checks** | Validate in pipeline |
|
|
67
|
+
|
|
68
|
+
---
|
|
69
|
+
|
|
70
|
+
## Documentation Files
|
|
71
|
+
|
|
72
|
+
| File | Description |
|
|
73
|
+
|------|-------------|
|
|
74
|
+
| [extraction.md](./extraction.md) | String extraction setup |
|
|
75
|
+
| [translation-workflow.md](./translation-workflow.md) | Translation process |
|
|
76
|
+
| [tms-integration.md](./tms-integration.md) | Translation management systems |
|
|
77
|
+
| [validation.md](./validation.md) | Quality checks |
|
|
78
|
+
|
|
79
|
+
---
|
|
80
|
+
|
|
81
|
+
## Configuration
|
|
82
|
+
|
|
83
|
+
```yaml
|
|
84
|
+
# proagents.config.yaml
|
|
85
|
+
|
|
86
|
+
i18n:
|
|
87
|
+
enabled: true
|
|
88
|
+
|
|
89
|
+
# Languages
|
|
90
|
+
source_language: "en"
|
|
91
|
+
target_languages: ["es", "fr", "de", "ja", "zh"]
|
|
92
|
+
|
|
93
|
+
# File structure
|
|
94
|
+
files:
|
|
95
|
+
format: "json" # json, yaml, po
|
|
96
|
+
directory: "src/locales"
|
|
97
|
+
naming: "{{locale}}/{{namespace}}.json"
|
|
98
|
+
|
|
99
|
+
# Extraction
|
|
100
|
+
extraction:
|
|
101
|
+
patterns:
|
|
102
|
+
- "t('...')"
|
|
103
|
+
- "i18n.t('...')"
|
|
104
|
+
- "<Trans>...</Trans>"
|
|
105
|
+
exclude:
|
|
106
|
+
- "node_modules"
|
|
107
|
+
- "**/*.test.ts"
|
|
108
|
+
|
|
109
|
+
# Validation
|
|
110
|
+
validation:
|
|
111
|
+
missing_translations: "warning"
|
|
112
|
+
unused_keys: "info"
|
|
113
|
+
placeholder_mismatch: "error"
|
|
114
|
+
|
|
115
|
+
# TMS Integration
|
|
116
|
+
tms:
|
|
117
|
+
provider: "crowdin" # crowdin, lokalise, phrase
|
|
118
|
+
project_id: "my-project"
|
|
119
|
+
auto_sync: true
|
|
120
|
+
```
|
|
121
|
+
|
|
122
|
+
---
|
|
123
|
+
|
|
124
|
+
## Commands
|
|
125
|
+
|
|
126
|
+
| Command | Description |
|
|
127
|
+
|---------|-------------|
|
|
128
|
+
| `proagents i18n extract` | Extract strings from code |
|
|
129
|
+
| `proagents i18n coverage` | Show translation coverage |
|
|
130
|
+
| `proagents i18n validate` | Validate translations |
|
|
131
|
+
| `proagents i18n sync` | Sync with TMS |
|
|
132
|
+
| `proagents i18n add-key` | Add new translation key |
|
|
133
|
+
| `proagents i18n missing` | List missing translations |
|
|
@@ -0,0 +1,433 @@
|
|
|
1
|
+
# String Extraction
|
|
2
|
+
|
|
3
|
+
Automatically extract translatable strings from your codebase.
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## Overview
|
|
8
|
+
|
|
9
|
+
```
|
|
10
|
+
┌─────────────────────────────────────────────────────────────┐
|
|
11
|
+
│ Extraction Process │
|
|
12
|
+
├─────────────────────────────────────────────────────────────┤
|
|
13
|
+
│ │
|
|
14
|
+
│ Source Code │
|
|
15
|
+
│ ┌─────────────────────────────────────────────────────┐ │
|
|
16
|
+
│ │ const message = t('welcome.title'); │ │
|
|
17
|
+
│ │ <Trans i18nKey="welcome.subtitle">Welcome!</Trans> │ │
|
|
18
|
+
│ └─────────────────────────────────────────────────────┘ │
|
|
19
|
+
│ │ │
|
|
20
|
+
│ ▼ │
|
|
21
|
+
│ ┌─────────────────┐ │
|
|
22
|
+
│ │ Extractor │ │
|
|
23
|
+
│ └────────┬────────┘ │
|
|
24
|
+
│ │ │
|
|
25
|
+
│ ▼ │
|
|
26
|
+
│ Translation Files │
|
|
27
|
+
│ ┌─────────────────────────────────────────────────────┐ │
|
|
28
|
+
│ │ { │ │
|
|
29
|
+
│ │ "welcome": { │ │
|
|
30
|
+
│ │ "title": "Welcome", │ │
|
|
31
|
+
│ │ "subtitle": "Welcome!" │ │
|
|
32
|
+
│ │ } │ │
|
|
33
|
+
│ │ } │ │
|
|
34
|
+
│ └─────────────────────────────────────────────────────┘ │
|
|
35
|
+
│ │
|
|
36
|
+
└─────────────────────────────────────────────────────────────┘
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
---
|
|
40
|
+
|
|
41
|
+
## Extraction Configuration
|
|
42
|
+
|
|
43
|
+
### Basic Setup
|
|
44
|
+
|
|
45
|
+
```yaml
|
|
46
|
+
i18n:
|
|
47
|
+
extraction:
|
|
48
|
+
# Patterns to match
|
|
49
|
+
patterns:
|
|
50
|
+
# Function calls
|
|
51
|
+
- pattern: "t\\(['\"](.+?)['\"]"
|
|
52
|
+
type: "function"
|
|
53
|
+
|
|
54
|
+
- pattern: "i18n\\.t\\(['\"](.+?)['\"]"
|
|
55
|
+
type: "function"
|
|
56
|
+
|
|
57
|
+
# React components
|
|
58
|
+
- pattern: "<Trans\\s+i18nKey=['\"](.+?)['\"]"
|
|
59
|
+
type: "component"
|
|
60
|
+
|
|
61
|
+
- pattern: "<Trans>(.+?)</Trans>"
|
|
62
|
+
type: "component_content"
|
|
63
|
+
|
|
64
|
+
# Files to scan
|
|
65
|
+
include:
|
|
66
|
+
- "src/**/*.ts"
|
|
67
|
+
- "src/**/*.tsx"
|
|
68
|
+
- "src/**/*.js"
|
|
69
|
+
- "src/**/*.jsx"
|
|
70
|
+
|
|
71
|
+
# Files to exclude
|
|
72
|
+
exclude:
|
|
73
|
+
- "**/*.test.*"
|
|
74
|
+
- "**/*.spec.*"
|
|
75
|
+
- "**/node_modules/**"
|
|
76
|
+
- "**/dist/**"
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
### Advanced Patterns
|
|
80
|
+
|
|
81
|
+
```yaml
|
|
82
|
+
i18n:
|
|
83
|
+
extraction:
|
|
84
|
+
patterns:
|
|
85
|
+
# With default value
|
|
86
|
+
- pattern: "t\\(['\"](.+?)['\"],\\s*['\"](.+?)['\"]\\)"
|
|
87
|
+
type: "function_with_default"
|
|
88
|
+
key_group: 1
|
|
89
|
+
default_group: 2
|
|
90
|
+
|
|
91
|
+
# With options
|
|
92
|
+
- pattern: "t\\(['\"](.+?)['\"],\\s*\\{[^}]*\\}\\)"
|
|
93
|
+
type: "function_with_options"
|
|
94
|
+
|
|
95
|
+
# Plurals
|
|
96
|
+
- pattern: "t\\(['\"](.+?)['\"],\\s*\\{\\s*count:"
|
|
97
|
+
type: "plural"
|
|
98
|
+
|
|
99
|
+
# Template literals
|
|
100
|
+
- pattern: "t\\(`(.+?)`\\)"
|
|
101
|
+
type: "template_literal"
|
|
102
|
+
warning: "Dynamic keys cannot be extracted"
|
|
103
|
+
```
|
|
104
|
+
|
|
105
|
+
---
|
|
106
|
+
|
|
107
|
+
## Running Extraction
|
|
108
|
+
|
|
109
|
+
### Basic Extraction
|
|
110
|
+
|
|
111
|
+
```bash
|
|
112
|
+
# Extract all strings
|
|
113
|
+
proagents i18n extract
|
|
114
|
+
|
|
115
|
+
# Extract to specific directory
|
|
116
|
+
proagents i18n extract --output src/locales
|
|
117
|
+
|
|
118
|
+
# Dry run (preview only)
|
|
119
|
+
proagents i18n extract --dry-run
|
|
120
|
+
```
|
|
121
|
+
|
|
122
|
+
### Extraction Options
|
|
123
|
+
|
|
124
|
+
```bash
|
|
125
|
+
# Extract with specific format
|
|
126
|
+
proagents i18n extract --format json
|
|
127
|
+
|
|
128
|
+
# Extract only new keys
|
|
129
|
+
proagents i18n extract --new-only
|
|
130
|
+
|
|
131
|
+
# Extract with context
|
|
132
|
+
proagents i18n extract --include-context
|
|
133
|
+
|
|
134
|
+
# Extract to specific namespace
|
|
135
|
+
proagents i18n extract --namespace common
|
|
136
|
+
```
|
|
137
|
+
|
|
138
|
+
### Output
|
|
139
|
+
|
|
140
|
+
```
|
|
141
|
+
┌─────────────────────────────────────────────────────────────┐
|
|
142
|
+
│ String Extraction Results │
|
|
143
|
+
├─────────────────────────────────────────────────────────────┤
|
|
144
|
+
│ │
|
|
145
|
+
│ Files Scanned: 145 │
|
|
146
|
+
│ Strings Extracted: 342 │
|
|
147
|
+
│ │
|
|
148
|
+
│ New Keys: 12 │
|
|
149
|
+
│ ├── common.save │
|
|
150
|
+
│ ├── common.cancel │
|
|
151
|
+
│ ├── auth.login_button │
|
|
152
|
+
│ └── ... 9 more │
|
|
153
|
+
│ │
|
|
154
|
+
│ Warnings: 3 │
|
|
155
|
+
│ ├── src/utils/format.ts:15 - Dynamic key detected │
|
|
156
|
+
│ ├── src/components/Menu.tsx:42 - Missing default value │
|
|
157
|
+
│ └── src/pages/Home.tsx:78 - Duplicate key │
|
|
158
|
+
│ │
|
|
159
|
+
│ Output: src/locales/en/extracted.json │
|
|
160
|
+
│ │
|
|
161
|
+
└─────────────────────────────────────────────────────────────┘
|
|
162
|
+
```
|
|
163
|
+
|
|
164
|
+
---
|
|
165
|
+
|
|
166
|
+
## Key Naming
|
|
167
|
+
|
|
168
|
+
### Naming Convention
|
|
169
|
+
|
|
170
|
+
```yaml
|
|
171
|
+
i18n:
|
|
172
|
+
key_naming:
|
|
173
|
+
# Convention
|
|
174
|
+
style: "dot_notation" # dot_notation, snake_case, camelCase
|
|
175
|
+
|
|
176
|
+
# Auto-generate key from content
|
|
177
|
+
auto_generate:
|
|
178
|
+
enabled: true
|
|
179
|
+
max_length: 40
|
|
180
|
+
hash_suffix: false
|
|
181
|
+
|
|
182
|
+
# Namespace from file path
|
|
183
|
+
namespace_from_path:
|
|
184
|
+
enabled: true
|
|
185
|
+
base_path: "src"
|
|
186
|
+
mapping:
|
|
187
|
+
"components": "common"
|
|
188
|
+
"pages": "pages"
|
|
189
|
+
"features": "features"
|
|
190
|
+
```
|
|
191
|
+
|
|
192
|
+
### Examples
|
|
193
|
+
|
|
194
|
+
```typescript
|
|
195
|
+
// File: src/components/Button.tsx
|
|
196
|
+
t('common.button.submit') // Namespace: common
|
|
197
|
+
|
|
198
|
+
// File: src/pages/Login.tsx
|
|
199
|
+
t('pages.login.title') // Namespace: pages
|
|
200
|
+
|
|
201
|
+
// File: src/features/checkout/Cart.tsx
|
|
202
|
+
t('features.checkout.cart.empty') // Namespace: features
|
|
203
|
+
```
|
|
204
|
+
|
|
205
|
+
---
|
|
206
|
+
|
|
207
|
+
## Default Values
|
|
208
|
+
|
|
209
|
+
### Extract with Defaults
|
|
210
|
+
|
|
211
|
+
```yaml
|
|
212
|
+
i18n:
|
|
213
|
+
extraction:
|
|
214
|
+
default_values:
|
|
215
|
+
enabled: true
|
|
216
|
+
source: "code" # code, comment, second_argument
|
|
217
|
+
|
|
218
|
+
# From code content
|
|
219
|
+
patterns:
|
|
220
|
+
- "<Trans>(.+?)</Trans>"
|
|
221
|
+
|
|
222
|
+
# From comments
|
|
223
|
+
comment_pattern: "// i18n: (.+)"
|
|
224
|
+
```
|
|
225
|
+
|
|
226
|
+
### In Code
|
|
227
|
+
|
|
228
|
+
```typescript
|
|
229
|
+
// Default from second argument
|
|
230
|
+
t('welcome.title', 'Welcome to our app')
|
|
231
|
+
|
|
232
|
+
// Default from component content
|
|
233
|
+
<Trans i18nKey="welcome.subtitle">
|
|
234
|
+
Welcome to our amazing application!
|
|
235
|
+
</Trans>
|
|
236
|
+
|
|
237
|
+
// Default from comment
|
|
238
|
+
// i18n: Click here to continue
|
|
239
|
+
t('common.continue')
|
|
240
|
+
```
|
|
241
|
+
|
|
242
|
+
---
|
|
243
|
+
|
|
244
|
+
## Namespace Management
|
|
245
|
+
|
|
246
|
+
### Multiple Namespaces
|
|
247
|
+
|
|
248
|
+
```yaml
|
|
249
|
+
i18n:
|
|
250
|
+
namespaces:
|
|
251
|
+
# Define namespaces
|
|
252
|
+
list:
|
|
253
|
+
- name: "common"
|
|
254
|
+
description: "Shared UI strings"
|
|
255
|
+
files: "src/components/**"
|
|
256
|
+
|
|
257
|
+
- name: "pages"
|
|
258
|
+
description: "Page-specific strings"
|
|
259
|
+
files: "src/pages/**"
|
|
260
|
+
|
|
261
|
+
- name: "errors"
|
|
262
|
+
description: "Error messages"
|
|
263
|
+
files: "src/errors/**"
|
|
264
|
+
|
|
265
|
+
- name: "validation"
|
|
266
|
+
description: "Form validation"
|
|
267
|
+
files: "src/validation/**"
|
|
268
|
+
```
|
|
269
|
+
|
|
270
|
+
### Output Structure
|
|
271
|
+
|
|
272
|
+
```
|
|
273
|
+
src/locales/
|
|
274
|
+
├── en/
|
|
275
|
+
│ ├── common.json
|
|
276
|
+
│ ├── pages.json
|
|
277
|
+
│ ├── errors.json
|
|
278
|
+
│ └── validation.json
|
|
279
|
+
├── es/
|
|
280
|
+
│ ├── common.json
|
|
281
|
+
│ └── ...
|
|
282
|
+
└── fr/
|
|
283
|
+
└── ...
|
|
284
|
+
```
|
|
285
|
+
|
|
286
|
+
---
|
|
287
|
+
|
|
288
|
+
## Incremental Extraction
|
|
289
|
+
|
|
290
|
+
### Track Changes
|
|
291
|
+
|
|
292
|
+
```yaml
|
|
293
|
+
i18n:
|
|
294
|
+
extraction:
|
|
295
|
+
incremental:
|
|
296
|
+
enabled: true
|
|
297
|
+
tracking_file: ".proagents/i18n-state.json"
|
|
298
|
+
|
|
299
|
+
# Only extract from changed files
|
|
300
|
+
changed_files_only: true
|
|
301
|
+
|
|
302
|
+
# Add new keys without removing old
|
|
303
|
+
merge_strategy: "add_only"
|
|
304
|
+
|
|
305
|
+
# Remove unused keys
|
|
306
|
+
remove_unused:
|
|
307
|
+
enabled: false
|
|
308
|
+
after_days: 30
|
|
309
|
+
```
|
|
310
|
+
|
|
311
|
+
### Commands
|
|
312
|
+
|
|
313
|
+
```bash
|
|
314
|
+
# Extract only from changed files
|
|
315
|
+
proagents i18n extract --incremental
|
|
316
|
+
|
|
317
|
+
# Extract and remove unused
|
|
318
|
+
proagents i18n extract --prune-unused
|
|
319
|
+
|
|
320
|
+
# Full re-extraction
|
|
321
|
+
proagents i18n extract --full
|
|
322
|
+
```
|
|
323
|
+
|
|
324
|
+
---
|
|
325
|
+
|
|
326
|
+
## Context and Comments
|
|
327
|
+
|
|
328
|
+
### Add Context for Translators
|
|
329
|
+
|
|
330
|
+
```typescript
|
|
331
|
+
// Add context as comment
|
|
332
|
+
// i18n-context: Button shown after successful payment
|
|
333
|
+
t('checkout.success_button')
|
|
334
|
+
|
|
335
|
+
// Or in options
|
|
336
|
+
t('checkout.success_button', {
|
|
337
|
+
context: 'Button shown after successful payment'
|
|
338
|
+
})
|
|
339
|
+
```
|
|
340
|
+
|
|
341
|
+
### Extract Context
|
|
342
|
+
|
|
343
|
+
```yaml
|
|
344
|
+
i18n:
|
|
345
|
+
extraction:
|
|
346
|
+
context:
|
|
347
|
+
enabled: true
|
|
348
|
+
sources:
|
|
349
|
+
- "comment" # // i18n-context: ...
|
|
350
|
+
- "option" # t('key', { context: '...' })
|
|
351
|
+
- "jsdoc" # /** @i18n-context ... */
|
|
352
|
+
|
|
353
|
+
output:
|
|
354
|
+
include_in_json: true
|
|
355
|
+
separate_file: false
|
|
356
|
+
```
|
|
357
|
+
|
|
358
|
+
### Output with Context
|
|
359
|
+
|
|
360
|
+
```json
|
|
361
|
+
{
|
|
362
|
+
"checkout": {
|
|
363
|
+
"success_button": {
|
|
364
|
+
"value": "Continue Shopping",
|
|
365
|
+
"context": "Button shown after successful payment",
|
|
366
|
+
"source": "src/pages/Checkout.tsx:145"
|
|
367
|
+
}
|
|
368
|
+
}
|
|
369
|
+
}
|
|
370
|
+
```
|
|
371
|
+
|
|
372
|
+
---
|
|
373
|
+
|
|
374
|
+
## Validation During Extraction
|
|
375
|
+
|
|
376
|
+
### Validate Keys
|
|
377
|
+
|
|
378
|
+
```yaml
|
|
379
|
+
i18n:
|
|
380
|
+
extraction:
|
|
381
|
+
validation:
|
|
382
|
+
# Check for duplicate keys
|
|
383
|
+
duplicates: "error"
|
|
384
|
+
|
|
385
|
+
# Check for invalid characters
|
|
386
|
+
invalid_chars: "error"
|
|
387
|
+
|
|
388
|
+
# Check key length
|
|
389
|
+
max_key_length: 100
|
|
390
|
+
|
|
391
|
+
# Check for dynamic keys
|
|
392
|
+
dynamic_keys: "warning"
|
|
393
|
+
|
|
394
|
+
# Check for missing defaults
|
|
395
|
+
missing_defaults: "warning"
|
|
396
|
+
```
|
|
397
|
+
|
|
398
|
+
### Validation Output
|
|
399
|
+
|
|
400
|
+
```
|
|
401
|
+
┌─────────────────────────────────────────────────────────────┐
|
|
402
|
+
│ Extraction Validation │
|
|
403
|
+
├─────────────────────────────────────────────────────────────┤
|
|
404
|
+
│ │
|
|
405
|
+
│ Errors (2): │
|
|
406
|
+
│ ├── src/components/Menu.tsx:42 │
|
|
407
|
+
│ │ Duplicate key: 'common.menu.home' │
|
|
408
|
+
│ │ First occurrence: src/components/Header.tsx:15 │
|
|
409
|
+
│ │ │
|
|
410
|
+
│ └── src/pages/Settings.tsx:78 │
|
|
411
|
+
│ Invalid characters in key: 'settings.user name' │
|
|
412
|
+
│ Suggestion: 'settings.user_name' │
|
|
413
|
+
│ │
|
|
414
|
+
│ Warnings (3): │
|
|
415
|
+
│ ├── Dynamic key detected (cannot extract) │
|
|
416
|
+
│ └── Missing default value (2 occurrences) │
|
|
417
|
+
│ │
|
|
418
|
+
│ Extraction blocked due to errors. Fix and retry. │
|
|
419
|
+
│ │
|
|
420
|
+
└─────────────────────────────────────────────────────────────┘
|
|
421
|
+
```
|
|
422
|
+
|
|
423
|
+
---
|
|
424
|
+
|
|
425
|
+
## Best Practices
|
|
426
|
+
|
|
427
|
+
1. **Consistent Naming**: Use a consistent key naming convention
|
|
428
|
+
2. **Provide Defaults**: Always include default English text
|
|
429
|
+
3. **Add Context**: Help translators understand usage
|
|
430
|
+
4. **Use Namespaces**: Organize keys by feature/page
|
|
431
|
+
5. **Avoid Dynamic Keys**: Extract only static keys
|
|
432
|
+
6. **Run Regularly**: Extract as part of development workflow
|
|
433
|
+
7. **Review Changes**: Check extracted keys before sending for translation
|