@teevee98/synapse-hub 0.0.0-stage → 3.8.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (369) hide show
  1. package/.agents/agents/api-engineer.md +67 -0
  2. package/.agents/agents/failure-analyst.md +75 -0
  3. package/.agents/agents/live-explorer.md +70 -0
  4. package/.agents/agents/orchestrator.md +104 -0
  5. package/.agents/agents/perf-engineer.md +74 -0
  6. package/.agents/agents/pom-crafter.md +112 -0
  7. package/.agents/agents/quality-gatekeeper.md +87 -0
  8. package/.agents/agents/test-designer.md +73 -0
  9. package/.agents/agents/test-runner.md +67 -0
  10. package/.agents/rules/author-integrity-guard.md +33 -0
  11. package/.agents/rules/communication-style.md +18 -0
  12. package/.agents/rules/context-engineering.md +37 -0
  13. package/.agents/rules/git-push-protocol.md +33 -0
  14. package/.agents/rules/graphify.md +14 -0
  15. package/.agents/rules/lessons-learned.md +25 -0
  16. package/.agents/rules/mandatory-playwright-live.md +25 -0
  17. package/.agents/rules/mobile_appium_rules.md +43 -0
  18. package/.agents/rules/performance_testing_rules.md +35 -0
  19. package/.agents/rules/skill-precedence.md +29 -0
  20. package/.agents/rules/systematic-debugging.md +36 -0
  21. package/.agents/skills/actor-qa-swarm/SKILL.md +77 -0
  22. package/.agents/skills/actor-qa-swarm/examples/broker_sharding_sample.json +12 -0
  23. package/.agents/skills/agent-orchestration-multi-agent-optimize/SKILL.md +88 -0
  24. package/.agents/skills/agent-orchestration-multi-agent-optimize/examples/swarm_workload_config.json +15 -0
  25. package/.agents/skills/agentless-qa-repair/SKILL.md +69 -0
  26. package/.agents/skills/agentless-qa-repair/examples/healing_report_sample.json +17 -0
  27. package/.agents/skills/agentless-qa-repair/examples/three_phase_repair_workflow.md +40 -0
  28. package/.agents/skills/antigravity-test-sentinel/SKILL.md +63 -0
  29. package/.agents/skills/antigravity-test-sentinel/examples/dod_gate_policy.json +11 -0
  30. package/.agents/skills/antigravity-test-sentinel/examples/sprint_dod_enforcement.md +47 -0
  31. package/.agents/skills/api-network-mocking-interception/SKILL.md +142 -0
  32. package/.agents/skills/api-network-mocking-interception/examples/network_route_stub.json +9 -0
  33. package/.agents/skills/api-spec-to-e2e-matrix/SKILL.md +80 -0
  34. package/.agents/skills/api-spec-to-e2e-matrix/examples/sample_openapi.json +19 -0
  35. package/.agents/skills/architecture-decision-records/SKILL.md +64 -0
  36. package/.agents/skills/architecture-decision-records/examples/0001-record-architecture-decisions.md +12 -0
  37. package/.agents/skills/auth-session-and-cookie-manager/SKILL.md +75 -0
  38. package/.agents/skills/auth-session-and-cookie-manager/examples/multi_role_auth_matrix.md +70 -0
  39. package/.agents/skills/auth-session-and-cookie-manager/examples/storage_state_sample.json +11 -0
  40. package/.agents/skills/backend-load-and-stress-patterns/SKILL.md +85 -0
  41. package/.agents/skills/backend-load-and-stress-patterns/examples/k6_load_test_sample.js +13 -0
  42. package/.agents/skills/backend-load-and-stress-patterns/references/k6_load_template.js +82 -0
  43. package/.agents/skills/bats-testing-patterns/SKILL.md +100 -0
  44. package/.agents/skills/bats-testing-patterns/examples/cli_runner_test.bats +6 -0
  45. package/.agents/skills/bats-testing-patterns/resources/implementation-playbook.md +614 -0
  46. package/.agents/skills/clean-pom-crafter/SKILL.md +110 -0
  47. package/.agents/skills/clean-pom-crafter/examples/standard_test_case.groovy +28 -0
  48. package/.agents/skills/clean-pom-crafter/references/pom_patterns.groovy +138 -0
  49. package/.agents/skills/code-refactoring-refactor-clean/SKILL.md +64 -0
  50. package/.agents/skills/code-refactoring-refactor-clean/examples/refactored_page_sample.groovy +9 -0
  51. package/.agents/skills/code-refactoring-refactor-clean/examples/refactored_playwright_pom.ts +52 -0
  52. package/.agents/skills/code-refactoring-refactor-clean/resources/implementation-playbook.md +881 -0
  53. package/.agents/skills/consumer-driven-contract-testing/SKILL.md +147 -0
  54. package/.agents/skills/consumer-driven-contract-testing/examples/order_service_pact.json +45 -0
  55. package/.agents/skills/db-state-verifier-and-seeder/SKILL.md +123 -0
  56. package/.agents/skills/db-state-verifier-and-seeder/examples/db_fixture_seed.json +12 -0
  57. package/.agents/skills/e2e-testing-patterns/SKILL.md +103 -0
  58. package/.agents/skills/e2e-testing-patterns/examples/playwright_sharded_config.ts +12 -0
  59. package/.agents/skills/e2e-testing-patterns/resources/implementation-playbook.md +522 -0
  60. package/.agents/skills/event-stream-qa-orchestrator/SKILL.md +79 -0
  61. package/.agents/skills/event-stream-qa-orchestrator/examples/timeline_sample.jsonl +2 -0
  62. package/.agents/skills/failure-autopsy-and-healing/SKILL.md +66 -0
  63. package/.agents/skills/failure-autopsy-and-healing/examples/closed_loop_healing_walkthrough.md +48 -0
  64. package/.agents/skills/failure-autopsy-and-healing/examples/sample_junit_failure.xml +8 -0
  65. package/.agents/skills/failure-autopsy-and-healing/references/healing_matrix.md +64 -0
  66. package/.agents/skills/failure-autopsy-and-healing/references/qa_investigation_protocol.md +56 -0
  67. package/.agents/skills/failure-autopsy-and-healing/scripts/triage_failures.sh +83 -0
  68. package/.agents/skills/file-and-report-validator/SKILL.md +90 -0
  69. package/.agents/skills/file-and-report-validator/examples/sample_export_schema.json +14 -0
  70. package/.agents/skills/flaky-test-sentinel-and-quarantine/SKILL.md +114 -0
  71. package/.agents/skills/flaky-test-sentinel-and-quarantine/examples/quarantine_registry.json +11 -0
  72. package/.agents/skills/gherkin-to-suite/SKILL.md +103 -0
  73. package/.agents/skills/gherkin-to-suite/examples/checkout.feature +39 -0
  74. package/.agents/skills/gherkin-to-suite/examples/suite_report_sample.json +334 -0
  75. package/.agents/skills/github-actions-templates/SKILL.md +77 -0
  76. package/.agents/skills/github-actions-templates/examples/matrix_test_pipeline.yml +8 -0
  77. package/.agents/skills/graphify-impact-analyzer/SKILL.md +76 -0
  78. package/.agents/skills/graphify-impact-analyzer/examples/dependency_blast_radius.json +8 -0
  79. package/.agents/skills/katalon-cli-runner/SKILL.md +76 -0
  80. package/.agents/skills/katalon-cli-runner/examples/headless_kre_exec.sh +3 -0
  81. package/.agents/skills/katalon-cli-runner/references/groovy-patterns.md +209 -0
  82. package/.agents/skills/katalon-cli-runner/references/katalon-api.md +155 -0
  83. package/.agents/skills/katalon-cli-runner/references/runner_commands.md +67 -0
  84. package/.agents/skills/lam-script-generator/SKILL.md +123 -0
  85. package/.agents/skills/lam-script-generator/examples/user_story_sample.md +8 -0
  86. package/.agents/skills/lean-code-ladder/SKILL.md +94 -0
  87. package/.agents/skills/lean-code-ladder/examples/ladder_walkthrough.md +37 -0
  88. package/.agents/skills/lean-impact-scoreboard/SKILL.md +48 -0
  89. package/.agents/skills/lean-impact-scoreboard/examples/sample_benchmark_gain.md +20 -0
  90. package/.agents/skills/lean-impact-scoreboard/examples/sample_scoreboard.md +15 -0
  91. package/.agents/skills/meta-prompt-crafter/SKILL.md +107 -0
  92. package/.agents/skills/meta-prompt-crafter/examples/qa_prompt_template.md +35 -0
  93. package/.agents/skills/mipro-prompt-compiler/SKILL.md +59 -0
  94. package/.agents/skills/mipro-prompt-compiler/examples/compiled_module_sample.json +22 -0
  95. package/.agents/skills/mipro-prompt-compiler/examples/dspy_assertion_optimizer_case.md +46 -0
  96. package/.agents/skills/mobile-appium-som/SKILL.md +88 -0
  97. package/.agents/skills/mobile-appium-som/examples/BaseScreen.java +88 -0
  98. package/.agents/skills/mobile-appium-som/examples/LoginScreen.java +46 -0
  99. package/.agents/skills/mobile-appium-som/examples/TC_MobileLogin.java +43 -0
  100. package/.agents/skills/persistent-planning-files/SKILL.md +108 -0
  101. package/.agents/skills/persistent-planning-files/examples/task_plan_example.md +56 -0
  102. package/.agents/skills/playwright-live-interaction/SKILL.md +131 -0
  103. package/.agents/skills/playwright-live-interaction/examples/live_probe_script.js +5 -0
  104. package/.agents/skills/playwright-live-interaction/references/advanced_superpowers.md +160 -0
  105. package/.agents/skills/playwright-live-interaction/references/compact_accessibility_snapshots.md +75 -0
  106. package/.agents/skills/playwright-live-interaction/references/recipes.md +388 -0
  107. package/.agents/skills/playwright-live-interaction/references/swarm_orchestration.md +134 -0
  108. package/.agents/skills/playwright-webapp-testing/SKILL.md +93 -0
  109. package/.agents/skills/playwright-webapp-testing/examples/server_lifecycle_playwright.py +63 -0
  110. package/.agents/skills/qa-aci-interface/SKILL.md +67 -0
  111. package/.agents/skills/qa-aci-interface/examples/surgical_code_window_walkthrough.md +40 -0
  112. package/.agents/skills/qa-aci-interface/examples/surgical_edit_sample.json +12 -0
  113. package/.agents/skills/qa-memory-os/SKILL.md +80 -0
  114. package/.agents/skills/qa-memory-os/examples/archival_memory_sample.json +21 -0
  115. package/.agents/skills/rbt-manual-testing/SKILL.md +137 -0
  116. package/.agents/skills/rbt-manual-testing/examples/checkout_rbt_manual_suite.md +25 -0
  117. package/.agents/skills/rbt-manual-testing/references/field_validation_checklist.md +29 -0
  118. package/.agents/skills/repo-quality-audit/SKILL.md +68 -0
  119. package/.agents/skills/repo-quality-audit/examples/sample_audit_walkthrough.md +15 -0
  120. package/.agents/skills/repo-quality-audit/examples/sample_repo_audit.md +33 -0
  121. package/.agents/skills/review-spec/SKILL.md +60 -0
  122. package/.agents/skills/review-spec/examples/pocock_grilling_decision_rubric.md +40 -0
  123. package/.agents/skills/review-spec/examples/sample_spec_review.md +33 -0
  124. package/.agents/skills/security-dast-sentinel/SKILL.md +119 -0
  125. package/.agents/skills/security-dast-sentinel/examples/dast_scan_config.json +10 -0
  126. package/.agents/skills/security-dast-sentinel/references/AI-AND-LLM.md +113 -0
  127. package/.agents/skills/security-dast-sentinel/references/ATTACK-CLASSES.md +89 -0
  128. package/.agents/skills/security-dast-sentinel/references/dast_recipes.ts +33 -0
  129. package/.agents/skills/self-healing-locator/SKILL.md +86 -0
  130. package/.agents/skills/self-healing-locator/examples/aom_diff_sample.json +16 -0
  131. package/.agents/skills/senior-code-review/SKILL.md +108 -0
  132. package/.agents/skills/senior-code-review/examples/sample_review_walkthrough.md +29 -0
  133. package/.agents/skills/skillspector-security-guard/SKILL.md +57 -0
  134. package/.agents/skills/skillspector-security-guard/examples/audit_threat_vectors_report.json +35 -0
  135. package/.agents/skills/skillspector-security-guard/examples/safe_mcp_config.json +12 -0
  136. package/.agents/skills/surgical-coding-principles/SKILL.md +89 -0
  137. package/.agents/skills/surgical-coding-principles/examples/surgical_vs_scope_creep.md +46 -0
  138. package/.agents/skills/synthetic-test-data-generator/SKILL.md +135 -0
  139. package/.agents/skills/synthetic-test-data-generator/examples/idempotent_data_recipe.json +9 -0
  140. package/.agents/skills/systematic-debugging/SKILL.md +100 -0
  141. package/.agents/skills/systematic-debugging/examples/four_phase_case.md +44 -0
  142. package/.agents/skills/technical-debt-harvester/SKILL.md +70 -0
  143. package/.agents/skills/technical-debt-harvester/examples/sample_debt_ledger.md +25 -0
  144. package/.agents/skills/technical-debt-harvester/examples/sample_ledger_output.md +20 -0
  145. package/.agents/skills/test-driven-development/SKILL.md +114 -0
  146. package/.agents/skills/test-driven-development/examples/red_green_refactor_qa.md +78 -0
  147. package/.agents/skills/token-and-context-optimizer/SKILL.md +70 -0
  148. package/.agents/skills/token-and-context-optimizer/examples/distilled_log_sample.txt +3 -0
  149. package/.agents/skills/token-and-context-optimizer/references/context_engineering_guide.md +49 -0
  150. package/.agents/skills/tot-exploratory-testing/SKILL.md +59 -0
  151. package/.agents/skills/tot-exploratory-testing/examples/payment_gateway_tot_tree.json +62 -0
  152. package/.agents/skills/tot-exploratory-testing/examples/tot_graph_sample.json +35 -0
  153. package/.agents/skills/verification-before-completion/SKILL.md +100 -0
  154. package/.agents/skills/verification-before-completion/examples/evidence_log_example.md +46 -0
  155. package/.agents/skills/visual-regression-sentinel/SKILL.md +82 -0
  156. package/.agents/skills/visual-regression-sentinel/examples/visual_mask_rules.json +9 -0
  157. package/.agents/skills/wcag-audit-patterns/SKILL.md +77 -0
  158. package/.agents/skills/wcag-audit-patterns/examples/wcag_compliance_checklist.json +10 -0
  159. package/.agents/skills/wcag-audit-patterns/resources/implementation-playbook.md +541 -0
  160. package/.agents/skills/web-agent-gym-benchmarking/SKILL.md +62 -0
  161. package/.agents/skills/web-agent-gym-benchmarking/examples/benchmark_report_sample.json +22 -0
  162. package/.agents/skills/web-agent-gym-benchmarking/examples/enterprise_tasks_suite.json +38 -0
  163. package/.agents/skills/web-vitals-and-performance-profiler/SKILL.md +65 -0
  164. package/.agents/skills/web-vitals-and-performance-profiler/examples/cwv_budget_policy.json +6 -0
  165. package/.agents/skills/web-vitals-and-performance-profiler/examples/playwright_cwv_profiler_fixture.ts +118 -0
  166. package/.agents/templates/completion_report.md +57 -0
  167. package/.agents/workflows/analyze_requirement_document.md +18 -0
  168. package/.agents/workflows/export_testcases_excel.md +32 -0
  169. package/.agents/workflows/generate_combinatorial_test_data.md +28 -0
  170. package/.agents/workflows/generate_cross_module_test_plan.md +37 -0
  171. package/.agents/workflows/generate_manual_testcases_rbt.md +56 -0
  172. package/.agents/workflows/generate_requirements_from_website.md +25 -0
  173. package/.agents/workflows/generate_testcases_from_requirements.md +21 -0
  174. package/.agents/workflows/graphify.md +10 -0
  175. package/.agents/workflows/test-impact.md +15 -0
  176. package/.agents/workflows/verify.md +34 -0
  177. package/.cursor/rules/agents.mdc +16 -0
  178. package/.cursor/rules/language.mdc +7 -0
  179. package/.cursor/rules/synapse-qa.mdc +24 -0
  180. package/.cursorrules +27 -0
  181. package/.dockerignore +53 -0
  182. package/.pre-commit-hooks.yaml +14 -0
  183. package/.windsurfrules +26 -0
  184. package/AGENTS.md +86 -0
  185. package/CLAUDE.md +54 -0
  186. package/Dockerfile +81 -0
  187. package/LICENSE +52 -0
  188. package/NOTICE +264 -0
  189. package/README.en.md +172 -0
  190. package/README.md +171 -2
  191. package/action.yml +51 -0
  192. package/agentskills.json +16 -0
  193. package/bin/agent-qa.js +138 -0
  194. package/docker-compose.yml +74 -0
  195. package/docs/ARCHITECTURE.en.md +197 -0
  196. package/docs/ARCHITECTURE.md +198 -0
  197. package/docs/CI_CD_INTEGRATION.en.md +170 -0
  198. package/docs/CI_CD_INTEGRATION.md +170 -0
  199. package/docs/CLI_REFERENCE.en.md +175 -0
  200. package/docs/CLI_REFERENCE.md +177 -0
  201. package/docs/CONTRIBUTING.en.md +49 -0
  202. package/docs/CONTRIBUTING.md +49 -0
  203. package/docs/PERFORMANCE_AUDIT_REPORT.md +784 -0
  204. package/docs/PLUGIN_DEVELOPMENT_GUIDE.md +127 -0
  205. package/docs/QUALITY_GATES.en.md +121 -0
  206. package/docs/QUALITY_GATES.md +121 -0
  207. package/docs/TOKEN_QUOTA_PLAYBOOK.md +41 -0
  208. package/docs/TOOL_CATALOG.md +129 -0
  209. package/docs/adopted-ecosystem-tools.md +96 -0
  210. package/docs/research/EXTERNAL_AGENT_SKILLS_SURVEY.md +1062 -0
  211. package/docs/research/agent_skill_training_analysis.md +1359 -0
  212. package/docs/schemas/synapse.config.schema.json +87 -0
  213. package/package.json +94 -4
  214. package/plugin.json +31 -0
  215. package/scripts/generate_skill_examples.py +244 -0
  216. package/scripts/install.ps1 +112 -0
  217. package/scripts/install_global_plugin.ps1 +94 -0
  218. package/scripts/install_global_plugin.sh +49 -0
  219. package/scripts/lint_skills.ps1 +57 -0
  220. package/scripts/package_dist.py +337 -0
  221. package/scripts/setup.sh +59 -0
  222. package/scripts/update_hub.ps1 +19 -0
  223. package/scripts/update_hub.sh +15 -0
  224. package/skills_manifest.json +854 -0
  225. package/synapse.config.json +32 -0
  226. package/templates/PROJECT_AI_GUIDE_TEMPLATE.md +111 -0
  227. package/templates/PROJECT_STATE_TEMPLATE.md +20 -0
  228. package/templates/ai_bridges/CLAUDE.md +54 -0
  229. package/templates/ai_bridges/copilot-instructions.md +20 -0
  230. package/templates/ai_bridges/cursor_synapse_qa.mdc +24 -0
  231. package/templates/ai_bridges/windsurfrules +26 -0
  232. package/templates/ci/github-actions-synapse.yml +95 -0
  233. package/templates/ci/gitlab-ci-synapse.yml +16 -0
  234. package/templates/ui/index.html +1069 -0
  235. package/templates/welcome.html.tmpl +2079 -0
  236. package/tools/.infer_baseline.json +30 -0
  237. package/tools/TOOLS_RUNBOOK.md +1553 -0
  238. package/tools/TOOL_CATALOG.json +1769 -0
  239. package/tools/__init__.py +43 -0
  240. package/tools/_openapi_parser.py +158 -0
  241. package/tools/agent_canary.py +525 -0
  242. package/tools/agentless_patcher.py +417 -0
  243. package/tools/analyze_project.py +258 -0
  244. package/tools/api_drift_sentinel.py +208 -0
  245. package/tools/api_fuzzer.py +762 -0
  246. package/tools/author_integrity.py +184 -0
  247. package/tools/auto_heal.py +271 -0
  248. package/tools/auto_heal_reflexion.py +532 -0
  249. package/tools/autogen_qa_broker.py +844 -0
  250. package/tools/benchmark_swarm_context.py +394 -0
  251. package/tools/browser_helpers.js +746 -0
  252. package/tools/browsergym_eval.py +236 -0
  253. package/tools/bug_reporter.py +252 -0
  254. package/tools/bump_version.py +423 -0
  255. package/tools/cache_resolver.py +1214 -0
  256. package/tools/check_env.py +426 -0
  257. package/tools/check_version_sync.py +256 -0
  258. package/tools/ci_healing_hook.py +126 -0
  259. package/tools/cli.py +1598 -0
  260. package/tools/config_decoupler.py +253 -0
  261. package/tools/contract_validator.py +141 -0
  262. package/tools/core/__init__.py +70 -0
  263. package/tools/core/adapters.py +431 -0
  264. package/tools/core/circuit_breaker.py +263 -0
  265. package/tools/core/cli_runtime.py +66 -0
  266. package/tools/core/file_lock.py +159 -0
  267. package/tools/core/i18n.py +394 -0
  268. package/tools/core/memory_bus.py +905 -0
  269. package/tools/core/process_supervisor.py +332 -0
  270. package/tools/core/telemetry.py +329 -0
  271. package/tools/count_tokens.py +1267 -0
  272. package/tools/create_mock_docx.py +104 -0
  273. package/tools/dashboard_generator.py +2419 -0
  274. package/tools/db_sandbox.py +675 -0
  275. package/tools/debt_harvester.py +237 -0
  276. package/tools/distill_log.py +161 -0
  277. package/tools/dspy_qa_signatures.py +356 -0
  278. package/tools/e2e_flow_prober.py +132 -0
  279. package/tools/export_postman_collection.py +945 -0
  280. package/tools/flaky_detector.py +389 -0
  281. package/tools/fsm_enforcer.py +450 -0
  282. package/tools/fsm_middleware.py +401 -0
  283. package/tools/fuzz_payloads.py +197 -0
  284. package/tools/generate_allure_report.py +88 -0
  285. package/tools/generate_api_matrix.py +193 -0
  286. package/tools/generate_jmx_plan.py +1322 -0
  287. package/tools/generate_sbom.py +252 -0
  288. package/tools/generate_tc_from_story.py +203 -0
  289. package/tools/generate_test_reports.py +133 -0
  290. package/tools/generate_tool_catalog.py +482 -0
  291. package/tools/gherkin_suite.py +758 -0
  292. package/tools/git_pre_commit_guard.py +298 -0
  293. package/tools/goldfish_review.py +366 -0
  294. package/tools/heal/__init__.py +28 -0
  295. package/tools/heal_pr_automator.py +220 -0
  296. package/tools/heuristic_locator_matcher.py +351 -0
  297. package/tools/hub_publisher.py +623 -0
  298. package/tools/humanize_linter.py +438 -0
  299. package/tools/infer_linter.py +977 -0
  300. package/tools/init_config.py +307 -0
  301. package/tools/interview_story.py +116 -0
  302. package/tools/jira_sync.py +566 -0
  303. package/tools/jtl_analyzer.py +474 -0
  304. package/tools/lint/__init__.py +30 -0
  305. package/tools/lint_ai_docs.py +374 -0
  306. package/tools/lookup_tc.py +165 -0
  307. package/tools/lookup_xpath.py +167 -0
  308. package/tools/matrix_sharder.py +148 -0
  309. package/tools/mcp/__init__.py +18 -0
  310. package/tools/mcp_docx_server.ps1 +13 -0
  311. package/tools/mcp_docx_server.py +851 -0
  312. package/tools/mcp_excel_server.ps1 +13 -0
  313. package/tools/mcp_excel_server.py +441 -0
  314. package/tools/mcp_server.py +724 -0
  315. package/tools/md_to_xlsx.py +327 -0
  316. package/tools/micro_mutator.py +887 -0
  317. package/tools/mipro_assertion_tuner.py +210 -0
  318. package/tools/network_mock_shield.py +311 -0
  319. package/tools/newman_analyzer.py +384 -0
  320. package/tools/omni_emitter.py +579 -0
  321. package/tools/omni_parser.py +450 -0
  322. package/tools/omni_transpiler.py +168 -0
  323. package/tools/openxml_guard.py +438 -0
  324. package/tools/output_formatter.py +182 -0
  325. package/tools/package_release.py +325 -0
  326. package/tools/perf/__init__.py +24 -0
  327. package/tools/pinpoint_failure.py +190 -0
  328. package/tools/project_state.py +171 -0
  329. package/tools/qa_event_stream.py +358 -0
  330. package/tools/repo_map.py +346 -0
  331. package/tools/report/__init__.py +32 -0
  332. package/tools/reversible_sandbox.py +344 -0
  333. package/tools/safety_firewall.py +437 -0
  334. package/tools/security_coverage_ledger.py +538 -0
  335. package/tools/security_scanner.py +229 -0
  336. package/tools/senior_code_review.py +393 -0
  337. package/tools/setup_project.py +770 -0
  338. package/tools/skill_collision_guard.py +304 -0
  339. package/tools/skill_profiles.py +217 -0
  340. package/tools/skill_vault.py +481 -0
  341. package/tools/skillspector.py +1278 -0
  342. package/tools/smart_visual_masker.py +132 -0
  343. package/tools/spec_drift_sentinel.py +438 -0
  344. package/tools/swe_qa_aci.py +369 -0
  345. package/tools/synapse_observer.py +485 -0
  346. package/tools/synapse_qa_bench.py +190 -0
  347. package/tools/sync_agent_rules.py +274 -0
  348. package/tools/telemetry_correlator.py +397 -0
  349. package/tools/template_excel_exporter.py +514 -0
  350. package/tools/templates/jmeter-distributed/README.md +54 -0
  351. package/tools/templates/jmeter-distributed/docker-compose.yml +83 -0
  352. package/tools/test_impact.py +419 -0
  353. package/tools/test_memory_os.py +462 -0
  354. package/tools/textgrad_mutation_optimizer.py +237 -0
  355. package/tools/tms_sync_bridge.py +834 -0
  356. package/tools/tot_exploratory_tester.py +239 -0
  357. package/tools/trace_data_flow.py +240 -0
  358. package/tools/traffic_session_converter.py +256 -0
  359. package/tools/trend_analytics.py +314 -0
  360. package/tools/ui_server.py +401 -0
  361. package/tools/universal_ir.py +488 -0
  362. package/tools/update_sentinel.py +383 -0
  363. package/tools/validate_groovy_scripts.py +173 -0
  364. package/tools/verify_all.py +1259 -0
  365. package/tools/visual_diff_canvas.py +143 -0
  366. package/tools/visual_som_helper.py +550 -0
  367. package/tools/watch_mode.py +308 -0
  368. package/tools/wcag_audit.py +239 -0
  369. package/tools/welcome_page.py +290 -0
@@ -0,0 +1,881 @@
1
+ # Refactor and Clean Code Implementation Playbook
2
+
3
+ This file contains detailed patterns, checklists, and code samples referenced by the skill.
4
+
5
+ ## Instructions
6
+
7
+ ### 1. Code Analysis
8
+ First, analyze the current code for:
9
+ - **Code Smells**
10
+ - Long methods/functions (>20 lines)
11
+ - Large classes (>200 lines)
12
+ - Duplicate code blocks
13
+ - Dead code and unused variables
14
+ - Complex conditionals and nested loops
15
+ - Magic numbers and hardcoded values
16
+ - Poor naming conventions
17
+ - Tight coupling between components
18
+ - Missing abstractions
19
+
20
+ - **SOLID Violations**
21
+ - Single Responsibility Principle violations
22
+ - Open/Closed Principle issues
23
+ - Liskov Substitution problems
24
+ - Interface Segregation concerns
25
+ - Dependency Inversion violations
26
+
27
+ - **Performance Issues**
28
+ - Inefficient algorithms (O(n²) or worse)
29
+ - Unnecessary object creation
30
+ - Memory leaks potential
31
+ - Blocking operations
32
+ - Missing caching opportunities
33
+
34
+ ### 2. Refactoring Strategy
35
+
36
+ Create a prioritized refactoring plan:
37
+
38
+ **Immediate Fixes (High Impact, Low Effort)**
39
+ - Extract magic numbers to constants
40
+ - Improve variable and function names
41
+ - Remove dead code
42
+ - Simplify boolean expressions
43
+ - Extract duplicate code to functions
44
+
45
+ **Method Extraction**
46
+ ```
47
+ # Before
48
+ def process_order(order):
49
+ # 50 lines of validation
50
+ # 30 lines of calculation
51
+ # 40 lines of notification
52
+
53
+ # After
54
+ def process_order(order):
55
+ validate_order(order)
56
+ total = calculate_order_total(order)
57
+ send_order_notifications(order, total)
58
+ ```
59
+
60
+ **Class Decomposition**
61
+ - Extract responsibilities to separate classes
62
+ - Create interfaces for dependencies
63
+ - Implement dependency injection
64
+ - Use composition over inheritance
65
+
66
+ **Pattern Application**
67
+ - Factory pattern for object creation
68
+ - Strategy pattern for algorithm variants
69
+ - Observer pattern for event handling
70
+ - Repository pattern for data access
71
+ - Decorator pattern for extending behavior
72
+
73
+ ### 3. SOLID Principles in Action
74
+
75
+ Provide concrete examples of applying each SOLID principle:
76
+
77
+ **Single Responsibility Principle (SRP)**
78
+ ```python
79
+ # BEFORE: Multiple responsibilities in one class
80
+ class UserManager:
81
+ def create_user(self, data):
82
+ # Validate data
83
+ # Save to database
84
+ # Send welcome email
85
+ # Log activity
86
+ # Update cache
87
+ pass
88
+
89
+ # AFTER: Each class has one responsibility
90
+ class UserValidator:
91
+ def validate(self, data): pass
92
+
93
+ class UserRepository:
94
+ def save(self, user): pass
95
+
96
+ class EmailService:
97
+ def send_welcome_email(self, user): pass
98
+
99
+ class UserActivityLogger:
100
+ def log_creation(self, user): pass
101
+
102
+ class UserService:
103
+ def __init__(self, validator, repository, email_service, logger):
104
+ self.validator = validator
105
+ self.repository = repository
106
+ self.email_service = email_service
107
+ self.logger = logger
108
+
109
+ def create_user(self, data):
110
+ self.validator.validate(data)
111
+ user = self.repository.save(data)
112
+ self.email_service.send_welcome_email(user)
113
+ self.logger.log_creation(user)
114
+ return user
115
+ ```
116
+
117
+ **Open/Closed Principle (OCP)**
118
+ ```python
119
+ # BEFORE: Modification required for new discount types
120
+ class DiscountCalculator:
121
+ def calculate(self, order, discount_type):
122
+ if discount_type == "percentage":
123
+ return order.total * 0.1
124
+ elif discount_type == "fixed":
125
+ return 10
126
+ elif discount_type == "tiered":
127
+ # More logic
128
+ pass
129
+
130
+ # AFTER: Open for extension, closed for modification
131
+ from abc import ABC, abstractmethod
132
+
133
+ class DiscountStrategy(ABC):
134
+ @abstractmethod
135
+ def calculate(self, order): pass
136
+
137
+ class PercentageDiscount(DiscountStrategy):
138
+ def __init__(self, percentage):
139
+ self.percentage = percentage
140
+
141
+ def calculate(self, order):
142
+ return order.total * self.percentage
143
+
144
+ class FixedDiscount(DiscountStrategy):
145
+ def __init__(self, amount):
146
+ self.amount = amount
147
+
148
+ def calculate(self, order):
149
+ return self.amount
150
+
151
+ class TieredDiscount(DiscountStrategy):
152
+ def calculate(self, order):
153
+ if order.total > 1000: return order.total * 0.15
154
+ if order.total > 500: return order.total * 0.10
155
+ return order.total * 0.05
156
+
157
+ class DiscountCalculator:
158
+ def calculate(self, order, strategy: DiscountStrategy):
159
+ return strategy.calculate(order)
160
+ ```
161
+
162
+ **Liskov Substitution Principle (LSP)**
163
+ ```typescript
164
+ // BEFORE: Violates LSP - Square changes Rectangle behavior
165
+ class Rectangle {
166
+ constructor(protected width: number, protected height: number) {}
167
+
168
+ setWidth(width: number) { this.width = width; }
169
+ setHeight(height: number) { this.height = height; }
170
+ area(): number { return this.width * this.height; }
171
+ }
172
+
173
+ class Square extends Rectangle {
174
+ setWidth(width: number) {
175
+ this.width = width;
176
+ this.height = width; // Breaks LSP
177
+ }
178
+ setHeight(height: number) {
179
+ this.width = height;
180
+ this.height = height; // Breaks LSP
181
+ }
182
+ }
183
+
184
+ // AFTER: Proper abstraction respects LSP
185
+ interface Shape {
186
+ area(): number;
187
+ }
188
+
189
+ class Rectangle implements Shape {
190
+ constructor(private width: number, private height: number) {}
191
+ area(): number { return this.width * this.height; }
192
+ }
193
+
194
+ class Square implements Shape {
195
+ constructor(private side: number) {}
196
+ area(): number { return this.side * this.side; }
197
+ }
198
+ ```
199
+
200
+ **Interface Segregation Principle (ISP)**
201
+ ```java
202
+ // BEFORE: Fat interface forces unnecessary implementations
203
+ interface Worker {
204
+ void work();
205
+ void eat();
206
+ void sleep();
207
+ }
208
+
209
+ class Robot implements Worker {
210
+ public void work() { /* work */ }
211
+ public void eat() { /* robots don't eat! */ }
212
+ public void sleep() { /* robots don't sleep! */ }
213
+ }
214
+
215
+ // AFTER: Segregated interfaces
216
+ interface Workable {
217
+ void work();
218
+ }
219
+
220
+ interface Eatable {
221
+ void eat();
222
+ }
223
+
224
+ interface Sleepable {
225
+ void sleep();
226
+ }
227
+
228
+ class Human implements Workable, Eatable, Sleepable {
229
+ public void work() { /* work */ }
230
+ public void eat() { /* eat */ }
231
+ public void sleep() { /* sleep */ }
232
+ }
233
+
234
+ class Robot implements Workable {
235
+ public void work() { /* work */ }
236
+ }
237
+ ```
238
+
239
+ **Dependency Inversion Principle (DIP)**
240
+ ```go
241
+ // BEFORE: High-level module depends on low-level module
242
+ type MySQLDatabase struct{}
243
+
244
+ func (db *MySQLDatabase) Save(data string) {}
245
+
246
+ type UserService struct {
247
+ db *MySQLDatabase // Tight coupling
248
+ }
249
+
250
+ func (s *UserService) CreateUser(name string) {
251
+ s.db.Save(name)
252
+ }
253
+
254
+ // AFTER: Both depend on abstraction
255
+ type Database interface {
256
+ Save(data string)
257
+ }
258
+
259
+ type MySQLDatabase struct{}
260
+ func (db *MySQLDatabase) Save(data string) {}
261
+
262
+ type PostgresDatabase struct{}
263
+ func (db *PostgresDatabase) Save(data string) {}
264
+
265
+ type UserService struct {
266
+ db Database // Depends on abstraction
267
+ }
268
+
269
+ func NewUserService(db Database) *UserService {
270
+ return &UserService{db: db}
271
+ }
272
+
273
+ func (s *UserService) CreateUser(name string) {
274
+ s.db.Save(name)
275
+ }
276
+ ```
277
+
278
+ ### 4. Complete Refactoring Scenarios
279
+
280
+ **Scenario 1: Legacy Monolith to Clean Modular Architecture**
281
+
282
+ ```python
283
+ # BEFORE: 500-line monolithic file
284
+ class OrderSystem:
285
+ def process_order(self, order_data):
286
+ # Validation (100 lines)
287
+ if not order_data.get('customer_id'):
288
+ return {'error': 'No customer'}
289
+ if not order_data.get('items'):
290
+ return {'error': 'No items'}
291
+ # Database operations mixed in (150 lines)
292
+ conn = mysql.connector.connect(host='localhost', user='root')
293
+ cursor = conn.cursor()
294
+ cursor.execute("INSERT INTO orders...")
295
+ # Business logic (100 lines)
296
+ total = 0
297
+ for item in order_data['items']:
298
+ total += item['price'] * item['quantity']
299
+ # Email notifications (80 lines)
300
+ smtp = smtplib.SMTP('smtp.gmail.com')
301
+ smtp.sendmail(...)
302
+ # Logging and analytics (70 lines)
303
+ log_file = open('/var/log/orders.log', 'a')
304
+ log_file.write(f"Order processed: {order_data}")
305
+
306
+ # AFTER: Clean, modular architecture
307
+ # domain/entities.py
308
+ from dataclasses import dataclass
309
+ from typing import List
310
+ from decimal import Decimal
311
+
312
+ @dataclass
313
+ class OrderItem:
314
+ product_id: str
315
+ quantity: int
316
+ price: Decimal
317
+
318
+ @dataclass
319
+ class Order:
320
+ customer_id: str
321
+ items: List[OrderItem]
322
+
323
+ @property
324
+ def total(self) -> Decimal:
325
+ return sum(item.price * item.quantity for item in self.items)
326
+
327
+ # domain/repositories.py
328
+ from abc import ABC, abstractmethod
329
+
330
+ class OrderRepository(ABC):
331
+ @abstractmethod
332
+ def save(self, order: Order) -> str: pass
333
+
334
+ @abstractmethod
335
+ def find_by_id(self, order_id: str) -> Order: pass
336
+
337
+ # infrastructure/mysql_order_repository.py
338
+ class MySQLOrderRepository(OrderRepository):
339
+ def __init__(self, connection_pool):
340
+ self.pool = connection_pool
341
+
342
+ def save(self, order: Order) -> str:
343
+ with self.pool.get_connection() as conn:
344
+ cursor = conn.cursor()
345
+ cursor.execute(
346
+ "INSERT INTO orders (customer_id, total) VALUES (%s, %s)",
347
+ (order.customer_id, order.total)
348
+ )
349
+ return cursor.lastrowid
350
+
351
+ # application/validators.py
352
+ class OrderValidator:
353
+ def validate(self, order: Order) -> None:
354
+ if not order.customer_id:
355
+ raise ValueError("Customer ID is required")
356
+ if not order.items:
357
+ raise ValueError("Order must contain items")
358
+ if order.total <= 0:
359
+ raise ValueError("Order total must be positive")
360
+
361
+ # application/services.py
362
+ class OrderService:
363
+ def __init__(
364
+ self,
365
+ validator: OrderValidator,
366
+ repository: OrderRepository,
367
+ email_service: EmailService,
368
+ logger: Logger
369
+ ):
370
+ self.validator = validator
371
+ self.repository = repository
372
+ self.email_service = email_service
373
+ self.logger = logger
374
+
375
+ def process_order(self, order: Order) -> str:
376
+ self.validator.validate(order)
377
+ order_id = self.repository.save(order)
378
+ self.email_service.send_confirmation(order)
379
+ self.logger.info(f"Order {order_id} processed successfully")
380
+ return order_id
381
+ ```
382
+
383
+ **Scenario 2: Code Smell Resolution Catalog**
384
+
385
+ ```typescript
386
+ // SMELL: Long Parameter List
387
+ // BEFORE
388
+ function createUser(
389
+ firstName: string,
390
+ lastName: string,
391
+ email: string,
392
+ phone: string,
393
+ address: string,
394
+ city: string,
395
+ state: string,
396
+ zipCode: string
397
+ ) {}
398
+
399
+ // AFTER: Parameter Object
400
+ interface UserData {
401
+ firstName: string;
402
+ lastName: string;
403
+ email: string;
404
+ phone: string;
405
+ address: Address;
406
+ }
407
+
408
+ interface Address {
409
+ street: string;
410
+ city: string;
411
+ state: string;
412
+ zipCode: string;
413
+ }
414
+
415
+ function createUser(userData: UserData) {}
416
+
417
+ // SMELL: Feature Envy (method uses another class's data more than its own)
418
+ // BEFORE
419
+ class Order {
420
+ calculateShipping(customer: Customer): number {
421
+ if (customer.isPremium) {
422
+ return customer.address.isInternational ? 0 : 5;
423
+ }
424
+ return customer.address.isInternational ? 20 : 10;
425
+ }
426
+ }
427
+
428
+ // AFTER: Move method to the class it envies
429
+ class Customer {
430
+ calculateShippingCost(): number {
431
+ if (this.isPremium) {
432
+ return this.address.isInternational ? 0 : 5;
433
+ }
434
+ return this.address.isInternational ? 20 : 10;
435
+ }
436
+ }
437
+
438
+ class Order {
439
+ calculateShipping(customer: Customer): number {
440
+ return customer.calculateShippingCost();
441
+ }
442
+ }
443
+
444
+ // SMELL: Primitive Obsession
445
+ // BEFORE
446
+ function validateEmail(email: string): boolean {
447
+ return /^[^\s@]+@[^\s@]+\.[^\s@]+$/.test(email);
448
+ }
449
+
450
+ let userEmail: string = "test@example.com";
451
+
452
+ // AFTER: Value Object
453
+ class Email {
454
+ private readonly value: string;
455
+
456
+ constructor(email: string) {
457
+ if (!this.isValid(email)) {
458
+ throw new Error("Invalid email format");
459
+ }
460
+ this.value = email;
461
+ }
462
+
463
+ private isValid(email: string): boolean {
464
+ return /^[^\s@]+@[^\s@]+\.[^\s@]+$/.test(email);
465
+ }
466
+
467
+ toString(): string {
468
+ return this.value;
469
+ }
470
+ }
471
+
472
+ let userEmail = new Email("test@example.com"); // Validation automatic
473
+ ```
474
+
475
+ ### 5. Decision Frameworks
476
+
477
+ **Code Quality Metrics Interpretation Matrix**
478
+
479
+ | Metric | Good | Warning | Critical | Action |
480
+ |--------|------|---------|----------|--------|
481
+ | Cyclomatic Complexity | <10 | 10-15 | >15 | Split into smaller methods |
482
+ | Method Lines | <20 | 20-50 | >50 | Extract methods, apply SRP |
483
+ | Class Lines | <200 | 200-500 | >500 | Decompose into multiple classes |
484
+ | Test Coverage | >80% | 60-80% | <60% | Add unit tests immediately |
485
+ | Code Duplication | <3% | 3-5% | >5% | Extract common code |
486
+ | Comment Ratio | 10-30% | <10% or >50% | N/A | Improve naming or reduce noise |
487
+ | Dependency Count | <5 | 5-10 | >10 | Apply DIP, use facades |
488
+
489
+ **Refactoring ROI Analysis**
490
+
491
+ ```
492
+ Priority = (Business Value × Technical Debt) / (Effort × Risk)
493
+
494
+ Business Value (1-10):
495
+ - Critical path code: 10
496
+ - Frequently changed: 8
497
+ - User-facing features: 7
498
+ - Internal tools: 5
499
+ - Legacy unused: 2
500
+
501
+ Technical Debt (1-10):
502
+ - Causes production bugs: 10
503
+ - Blocks new features: 8
504
+ - Hard to test: 6
505
+ - Style issues only: 2
506
+
507
+ Effort (hours):
508
+ - Rename variables: 1-2
509
+ - Extract methods: 2-4
510
+ - Refactor class: 4-8
511
+ - Architecture change: 40+
512
+
513
+ Risk (1-10):
514
+ - No tests, high coupling: 10
515
+ - Some tests, medium coupling: 5
516
+ - Full tests, loose coupling: 2
517
+ ```
518
+
519
+ **Technical Debt Prioritization Decision Tree**
520
+
521
+ ```
522
+ Is it causing production bugs?
523
+ ├─ YES → Priority: CRITICAL (Fix immediately)
524
+ └─ NO → Is it blocking new features?
525
+ ├─ YES → Priority: HIGH (Schedule this sprint)
526
+ └─ NO → Is it frequently modified?
527
+ ├─ YES → Priority: MEDIUM (Next quarter)
528
+ └─ NO → Is code coverage < 60%?
529
+ ├─ YES → Priority: MEDIUM (Add tests)
530
+ └─ NO → Priority: LOW (Backlog)
531
+ ```
532
+
533
+ ### 6. Modern Code Quality Practices (2024-2025)
534
+
535
+ **AI-Assisted Code Review Integration**
536
+
537
+ ```yaml
538
+ # .github/workflows/ai-review.yml
539
+ name: AI Code Review
540
+ on: [pull_request]
541
+
542
+ jobs:
543
+ ai-review:
544
+ runs-on: ubuntu-latest
545
+ steps:
546
+ - uses: actions/checkout@v4
547
+
548
+ # GitHub Copilot Autofix
549
+ - uses: github/copilot-autofix@v1
550
+ with:
551
+ languages: 'python,typescript,go'
552
+
553
+ # CodeRabbit AI Review
554
+ - uses: coderabbitai/action@v1
555
+ with:
556
+ review_type: 'comprehensive'
557
+ focus: 'security,performance,maintainability'
558
+
559
+ # Codium AI PR-Agent
560
+ - uses: codiumai/pr-agent@v1
561
+ with:
562
+ commands: '/review --pr_reviewer.num_code_suggestions=5'
563
+ ```
564
+
565
+ **Static Analysis Toolchain**
566
+
567
+ ``` oml
568
+ # pyproject.toml
569
+ [tool.ruff]
570
+ line-length = 100
571
+ select = [
572
+ "E", # pycodestyle errors
573
+ "W", # pycodestyle warnings
574
+ "F", # pyflakes
575
+ "I", # isort
576
+ "C90", # mccabe complexity
577
+ "N", # pep8-naming
578
+ "UP", # pyupgrade
579
+ "B", # flake8-bugbear
580
+ "A", # flake8-builtins
581
+ "C4", # flake8-comprehensions
582
+ "SIM", # flake8-simplify
583
+ "RET", # flake8-return
584
+ ]
585
+
586
+ [tool.mypy]
587
+ strict = true
588
+ warn_unreachable = true
589
+ warn_unused_ignores = true
590
+
591
+ [tool.coverage]
592
+ fail_under = 80
593
+ ```
594
+
595
+ ```javascript
596
+ // .eslintrc.json
597
+ {
598
+ "extends": [
599
+ "eslint:recommended",
600
+ "plugin:@typescript-eslint/recommended-type-checked",
601
+ "plugin:sonarjs/recommended",
602
+ "plugin:security/recommended"
603
+ ],
604
+ "plugins": ["sonarjs", "security", "no-loops"],
605
+ "rules": {
606
+ "complexity": ["error", 10],
607
+ "max-lines-per-function": ["error", 20],
608
+ "max-params": ["error", 3],
609
+ "no-loops/no-loops": "warn",
610
+ "sonarjs/cognitive-complexity": ["error", 15]
611
+ }
612
+ }
613
+ ```
614
+
615
+ **Automated Refactoring Suggestions**
616
+
617
+ ```yaml
618
+ # Use Sourcery for automatic refactoring suggestions
619
+ # sourcery.yaml
620
+ rules:
621
+ - id: convert-to-list-comprehension
622
+ - id: merge-duplicate-blocks
623
+ - id: use-named-expression
624
+ - id: inline-immediately-returned-variable
625
+ `
626
+
627
+ `python
628
+ # Example: Sourcery will suggest
629
+ # BEFORE
630
+ result = []
631
+ for item in items:
632
+ if item.is_active:
633
+ result.append(item.name)
634
+
635
+ # AFTER (auto-suggested)
636
+ result = [item.name for item in items if item.is_active]
637
+ ```
638
+
639
+ **Code Quality Dashboard Configuration**
640
+
641
+ ```properties
642
+ # sonar-project.properties
643
+ sonar.projectKey=my-project
644
+ sonar.sources=src
645
+ sonar.tests=tests
646
+ sonar.coverage.exclusions=**/*_test.py,**/test_*.py
647
+ sonar.python.coverage.reportPaths=coverage.xml
648
+
649
+ # Quality Gates
650
+ sonar.qualitygate.wait=true
651
+ sonar.qualitygate.timeout=300
652
+
653
+ # Thresholds
654
+ sonar.coverage.threshold=80
655
+ sonar.duplications.threshold=3
656
+ sonar.maintainability.rating=A
657
+ sonar.reliability.rating=A
658
+ sonar.security.rating=A
659
+ ```
660
+
661
+ **Security-Focused Refactoring**
662
+
663
+ ```yaml
664
+ # Use Semgrep for security-aware refactoring
665
+ # .semgrep.yml
666
+ rules:
667
+ - id: sql-injection-risk
668
+ pattern: execute($QUERY)
669
+ message: Potential SQL injection
670
+ severity: ERROR
671
+ fix: Use parameterized queries
672
+
673
+ - id: hardcoded-secrets
674
+ pattern: password = "..."
675
+ message: Hardcoded password detected
676
+ severity: ERROR
677
+ fix: Use environment variables or secret manager
678
+
679
+ # CodeQL security analysis
680
+ # .github/workflows/codeql.yml
681
+ - uses: github/codeql-action/analyze@v3
682
+ with:
683
+ category: "/language:python"
684
+ queries: security-extended,security-and-quality
685
+ ```
686
+
687
+ ### 7. Refactored Implementation
688
+
689
+ Provide the complete refactored code with:
690
+
691
+ **Clean Code Principles**
692
+ - Meaningful names (searchable, pronounceable, no abbreviations)
693
+ - Functions do one thing well
694
+ - No side effects
695
+ - Consistent abstraction levels
696
+ - DRY (Don't Repeat Yourself)
697
+ - YAGNI (You Aren't Gonna Need It)
698
+
699
+ **Error Handling**
700
+ ```python
701
+ # Use specific exceptions
702
+ class OrderValidationError(Exception):
703
+ pass
704
+
705
+ class InsufficientInventoryError(Exception):
706
+ pass
707
+
708
+ # Fail fast with clear messages
709
+ def validate_order(order):
710
+ if not order.items:
711
+ raise OrderValidationError("Order must contain at least one item")
712
+
713
+ for item in order.items:
714
+ if item.quantity <= 0:
715
+ raise OrderValidationError(f"Invalid quantity for {item.name}")
716
+ ```
717
+
718
+ **Documentation**
719
+ ```python
720
+ def calculate_discount(order: Order, customer: Customer) -> Decimal:
721
+ """
722
+ Calculate the total discount for an order based on customer tier and order value.
723
+
724
+ Args:
725
+ order: The order to calculate discount for
726
+ customer: The customer making the order
727
+
728
+ Returns:
729
+ The discount amount as a Decimal
730
+
731
+ Raises:
732
+ ValueError: If order total is negative
733
+ """
734
+ ```
735
+
736
+ ### 8. Testing Strategy
737
+
738
+ Generate comprehensive tests for the refactored code:
739
+
740
+ **Unit Tests**
741
+ ```python
742
+ class TestOrderProcessor:
743
+ def test_validate_order_empty_items(self):
744
+ order = Order(items=[])
745
+ with pytest.raises(OrderValidationError):
746
+ validate_order(order)
747
+
748
+ def test_calculate_discount_vip_customer(self):
749
+ order = create_test_order(total=1000)
750
+ customer = Customer(tier="VIP")
751
+ discount = calculate_discount(order, customer)
752
+ assert discount == Decimal("100.00") # 10% VIP discount
753
+ ```
754
+
755
+ **Test Coverage**
756
+ - All public methods tested
757
+ - Edge cases covered
758
+ - Error conditions verified
759
+ - Performance benchmarks included
760
+
761
+ ### 9. Before/After Comparison
762
+
763
+ Provide clear comparisons showing improvements:
764
+
765
+ **Metrics**
766
+ - Cyclomatic complexity reduction
767
+ - Lines of code per method
768
+ - Test coverage increase
769
+ - Performance improvements
770
+
771
+ **Example**
772
+ ```
773
+ Before:
774
+ - processData(): 150 lines, complexity: 25
775
+ - 0% test coverage
776
+ - 3 responsibilities mixed
777
+
778
+ After:
779
+ - validateInput(): 20 lines, complexity: 4
780
+ - transformData(): 25 lines, complexity: 5
781
+ - saveResults(): 15 lines, complexity: 3
782
+ - 95% test coverage
783
+ - Clear separation of concerns
784
+ ```
785
+
786
+ ### 10. Migration Guide
787
+
788
+ If breaking changes are introduced:
789
+
790
+ **Step-by-Step Migration**
791
+ 1. Install new dependencies
792
+ 2. Update import statements
793
+ 3. Replace deprecated methods
794
+ 4. Run migration scripts
795
+ 5. Execute test suite
796
+
797
+ **Backward Compatibility**
798
+ ```python
799
+ # Temporary adapter for smooth migration
800
+ class LegacyOrderProcessor:
801
+ def __init__(self):
802
+ self.processor = OrderProcessor()
803
+
804
+ def process(self, order_data):
805
+ # Convert legacy format
806
+ order = Order.from_legacy(order_data)
807
+ return self.processor.process(order)
808
+ ```
809
+
810
+ ### 11. Performance Optimizations
811
+
812
+ Include specific optimizations:
813
+
814
+ **Algorithm Improvements**
815
+ ```python
816
+ # Before: O(n²)
817
+ for item in items:
818
+ for other in items:
819
+ if item.id == other.id:
820
+ pass # process
821
+
822
+ # After: O(n)
823
+ item_map = {item.id: item for item in items}
824
+ for item_id, item in item_map.items():
825
+ pass # process
826
+ ```
827
+
828
+ **Caching Strategy**
829
+ ```python
830
+ from functools import lru_cache
831
+
832
+ @lru_cache(maxsize=128)
833
+ def calculate_expensive_metric(data_id: str) -> float:
834
+ # Expensive calculation cached
835
+ return 0.0
836
+ ```
837
+
838
+ ### 12. Code Quality Checklist
839
+
840
+ Ensure the refactored code meets these criteria:
841
+
842
+ - [ ] All methods < 20 lines
843
+ - [ ] All classes < 200 lines
844
+ - [ ] No method has > 3 parameters
845
+ - [ ] Cyclomatic complexity < 10
846
+ - [ ] No nested loops > 2 levels
847
+ - [ ] All names are descriptive
848
+ - [ ] No commented-out code
849
+ - [ ] Consistent formatting
850
+ - [ ] Type hints added (Python/TypeScript)
851
+ - [ ] Error handling comprehensive
852
+ - [ ] Logging added for debugging
853
+ - [ ] Performance metrics included
854
+ - [ ] Documentation complete
855
+ - [ ] Tests achieve > 80% coverage
856
+ - [ ] No security vulnerabilities
857
+ - [ ] AI code review passed
858
+ - [ ] Static analysis clean (SonarQube/CodeQL)
859
+ - [ ] No hardcoded secrets
860
+
861
+ ## Severity Levels
862
+
863
+ Rate issues found and improvements made:
864
+
865
+ **Critical**: Security vulnerabilities, data corruption risks, memory leaks
866
+ **High**: Performance bottlenecks, maintainability blockers, missing tests
867
+ **Medium**: Code smells, minor performance issues, incomplete documentation
868
+ **Low**: Style inconsistencies, minor naming issues, nice-to-have features
869
+
870
+ ## Output Format
871
+
872
+ 1. **Analysis Summary**: Key issues found and their impact
873
+ 2. **Refactoring Plan**: Prioritized list of changes with effort estimates
874
+ 3. **Refactored Code**: Complete implementation with inline comments explaining changes
875
+ 4. **Test Suite**: Comprehensive tests for all refactored components
876
+ 5. **Migration Guide**: Step-by-step instructions for adopting changes
877
+ 6. **Metrics Report**: Before/after comparison of code quality metrics
878
+ 7. **AI Review Results**: Summary of automated code review findings
879
+ 8. **Quality Dashboard**: Link to SonarQube/CodeQL results
880
+
881
+ Focus on delivering practical, incremental improvements that can be adopted immediately while maintaining system stability.