ma-agents 2.19.2 → 2.20.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/.cline/clinerules.md +14 -0
- package/.cline/skills/.ma-agents.json +199 -0
- package/.cline/skills/MANIFEST.yaml +204 -0
- package/.cline/skills/ai-audit-trail/SKILL.md +23 -0
- package/.cline/skills/cmake-best-practices/SKILL.md +64 -0
- package/.cline/skills/cmake-best-practices/examples/cmake.md +59 -0
- package/.cline/skills/code-documentation/SKILL.md +57 -0
- package/.cline/skills/code-documentation/examples/cpp.md +29 -0
- package/.cline/skills/code-documentation/examples/csharp.md +28 -0
- package/.cline/skills/code-documentation/examples/javascript_typescript.md +28 -0
- package/.cline/skills/code-documentation/examples/python.md +57 -0
- package/.cline/skills/code-review/SKILL.md +59 -0
- package/.cline/skills/commit-message/SKILL.md +79 -0
- package/.cline/skills/cpp-concurrency-safety/SKILL.md +60 -0
- package/.cline/skills/cpp-concurrency-safety/examples/concurrency.md +73 -0
- package/.cline/skills/cpp-const-correctness/SKILL.md +63 -0
- package/.cline/skills/cpp-const-correctness/examples/const_correctness.md +54 -0
- package/.cline/skills/cpp-memory-handling/SKILL.md +42 -0
- package/.cline/skills/cpp-memory-handling/examples/modern-cpp.md +49 -0
- package/.cline/skills/cpp-memory-handling/examples/smart-pointers.md +46 -0
- package/.cline/skills/cpp-modern-composition/SKILL.md +64 -0
- package/.cline/skills/cpp-modern-composition/examples/composition.md +51 -0
- package/.cline/skills/cpp-robust-interfaces/SKILL.md +55 -0
- package/.cline/skills/cpp-robust-interfaces/examples/interfaces.md +56 -0
- package/.cline/skills/create-hardened-docker-skill/SKILL.md +637 -0
- package/.cline/skills/create-hardened-docker-skill/scripts/create-all.sh +489 -0
- package/.cline/skills/docker-hardening-verification/SKILL.md +28 -0
- package/.cline/skills/docker-hardening-verification/scripts/verify-hardening.sh +39 -0
- package/.cline/skills/docker-image-signing/SKILL.md +28 -0
- package/.cline/skills/docker-image-signing/scripts/sign-image.sh +33 -0
- package/.cline/skills/document-revision-history/SKILL.md +104 -0
- package/.cline/skills/git-workflow-skill/SKILL.md +194 -0
- package/.cline/skills/git-workflow-skill/hooks/commit-msg +61 -0
- package/.cline/skills/git-workflow-skill/hooks/pre-commit +38 -0
- package/.cline/skills/git-workflow-skill/hooks/prepare-commit-msg +56 -0
- package/.cline/skills/git-workflow-skill/scripts/finish-feature.sh +192 -0
- package/.cline/skills/git-workflow-skill/scripts/install-hooks.sh +55 -0
- package/.cline/skills/git-workflow-skill/scripts/start-feature.sh +110 -0
- package/.cline/skills/git-workflow-skill/scripts/validate-workflow.sh +229 -0
- package/.cline/skills/js-ts-dependency-mgmt/SKILL.md +49 -0
- package/.cline/skills/js-ts-dependency-mgmt/examples/dependency_mgmt.md +60 -0
- package/.cline/skills/js-ts-security-skill/SKILL.md +64 -0
- package/.cline/skills/js-ts-security-skill/scripts/verify-security.sh +136 -0
- package/.cline/skills/logging-best-practices/SKILL.md +50 -0
- package/.cline/skills/logging-best-practices/docs/logging-standards.md +29 -0
- package/.cline/skills/logging-best-practices/examples/cpp.md +36 -0
- package/.cline/skills/logging-best-practices/examples/csharp.md +49 -0
- package/.cline/skills/logging-best-practices/examples/javascript.md +77 -0
- package/.cline/skills/logging-best-practices/examples/python.md +57 -0
- package/.cline/skills/opentelemetry-best-practices/SKILL.md +34 -0
- package/.cline/skills/opentelemetry-best-practices/docs/otel-standards.md +37 -0
- package/.cline/skills/opentelemetry-best-practices/examples/go.md +32 -0
- package/.cline/skills/opentelemetry-best-practices/examples/javascript.md +58 -0
- package/.cline/skills/opentelemetry-best-practices/examples/python.md +37 -0
- package/.cline/skills/python-dependency-mgmt/SKILL.md +42 -0
- package/.cline/skills/python-dependency-mgmt/examples/dependency_mgmt.md +67 -0
- package/.cline/skills/python-security-skill/SKILL.md +56 -0
- package/.cline/skills/python-security-skill/examples/security.md +56 -0
- package/.cline/skills/self-signed-cert/SKILL.md +42 -0
- package/.cline/skills/self-signed-cert/scripts/generate-cert.ps1 +45 -0
- package/.cline/skills/self-signed-cert/scripts/generate-cert.sh +43 -0
- package/.cline/skills/skill-creator/SKILL.md +196 -0
- package/.cline/skills/skill-creator/docs/output-patterns.md +82 -0
- package/.cline/skills/skill-creator/docs/workflows.md +28 -0
- package/.cline/skills/skill-creator/scripts/init_skill.py +208 -0
- package/.cline/skills/skill-creator/scripts/package_skill.py +99 -0
- package/.cline/skills/skill-creator/scripts/quick_validate.py +113 -0
- package/.cline/skills/test-accompanied-development/SKILL.md +50 -0
- package/.cline/skills/test-generator/SKILL.md +73 -0
- package/.cline/skills/vercel-react-best-practices/SKILL.md +109 -0
- package/.cline/skills/verify-hardened-docker-skill/SKILL.md +442 -0
- package/.cline/skills/verify-hardened-docker-skill/scripts/verify-docker-hardening.sh +439 -0
- package/.clinerules +14 -0
- package/.cursor/cursor.md +14 -0
- package/.cursor/skills/.ma-agents.json +199 -0
- package/.cursor/skills/MANIFEST.yaml +204 -0
- package/.cursor/skills/ai-audit-trail/SKILL.md +23 -0
- package/.cursor/skills/cmake-best-practices/SKILL.md +64 -0
- package/.cursor/skills/cmake-best-practices/examples/cmake.md +59 -0
- package/.cursor/skills/code-documentation/SKILL.md +57 -0
- package/.cursor/skills/code-documentation/examples/cpp.md +29 -0
- package/.cursor/skills/code-documentation/examples/csharp.md +28 -0
- package/.cursor/skills/code-documentation/examples/javascript_typescript.md +28 -0
- package/.cursor/skills/code-documentation/examples/python.md +57 -0
- package/.cursor/skills/code-review/SKILL.md +43 -0
- package/.cursor/skills/commit-message/SKILL.md +79 -0
- package/.cursor/skills/cpp-concurrency-safety/SKILL.md +60 -0
- package/.cursor/skills/cpp-concurrency-safety/examples/concurrency.md +73 -0
- package/.cursor/skills/cpp-const-correctness/SKILL.md +63 -0
- package/.cursor/skills/cpp-const-correctness/examples/const_correctness.md +54 -0
- package/.cursor/skills/cpp-memory-handling/SKILL.md +42 -0
- package/.cursor/skills/cpp-memory-handling/examples/modern-cpp.md +49 -0
- package/.cursor/skills/cpp-memory-handling/examples/smart-pointers.md +46 -0
- package/.cursor/skills/cpp-modern-composition/SKILL.md +64 -0
- package/.cursor/skills/cpp-modern-composition/examples/composition.md +51 -0
- package/.cursor/skills/cpp-robust-interfaces/SKILL.md +55 -0
- package/.cursor/skills/cpp-robust-interfaces/examples/interfaces.md +56 -0
- package/.cursor/skills/create-hardened-docker-skill/SKILL.md +637 -0
- package/.cursor/skills/create-hardened-docker-skill/scripts/create-all.sh +489 -0
- package/.cursor/skills/docker-hardening-verification/SKILL.md +28 -0
- package/.cursor/skills/docker-hardening-verification/scripts/verify-hardening.sh +39 -0
- package/.cursor/skills/docker-image-signing/SKILL.md +28 -0
- package/.cursor/skills/docker-image-signing/scripts/sign-image.sh +33 -0
- package/.cursor/skills/document-revision-history/SKILL.md +104 -0
- package/.cursor/skills/git-workflow-skill/SKILL.md +194 -0
- package/.cursor/skills/git-workflow-skill/hooks/commit-msg +61 -0
- package/.cursor/skills/git-workflow-skill/hooks/pre-commit +38 -0
- package/.cursor/skills/git-workflow-skill/hooks/prepare-commit-msg +56 -0
- package/.cursor/skills/git-workflow-skill/scripts/finish-feature.sh +192 -0
- package/.cursor/skills/git-workflow-skill/scripts/install-hooks.sh +55 -0
- package/.cursor/skills/git-workflow-skill/scripts/start-feature.sh +110 -0
- package/.cursor/skills/git-workflow-skill/scripts/validate-workflow.sh +229 -0
- package/.cursor/skills/js-ts-dependency-mgmt/SKILL.md +49 -0
- package/.cursor/skills/js-ts-dependency-mgmt/examples/dependency_mgmt.md +60 -0
- package/.cursor/skills/js-ts-security-skill/SKILL.md +64 -0
- package/.cursor/skills/js-ts-security-skill/scripts/verify-security.sh +136 -0
- package/.cursor/skills/logging-best-practices/SKILL.md +50 -0
- package/.cursor/skills/logging-best-practices/examples/cpp.md +36 -0
- package/.cursor/skills/logging-best-practices/examples/csharp.md +49 -0
- package/.cursor/skills/logging-best-practices/examples/javascript.md +77 -0
- package/.cursor/skills/logging-best-practices/examples/python.md +57 -0
- package/.cursor/skills/logging-best-practices/references/logging-standards.md +29 -0
- package/.cursor/skills/opentelemetry-best-practices/SKILL.md +34 -0
- package/.cursor/skills/opentelemetry-best-practices/examples/go.md +32 -0
- package/.cursor/skills/opentelemetry-best-practices/examples/javascript.md +58 -0
- package/.cursor/skills/opentelemetry-best-practices/examples/python.md +37 -0
- package/.cursor/skills/opentelemetry-best-practices/references/otel-standards.md +37 -0
- package/.cursor/skills/python-dependency-mgmt/SKILL.md +42 -0
- package/.cursor/skills/python-dependency-mgmt/examples/dependency_mgmt.md +67 -0
- package/.cursor/skills/python-security-skill/SKILL.md +56 -0
- package/.cursor/skills/python-security-skill/examples/security.md +56 -0
- package/.cursor/skills/self-signed-cert/SKILL.md +42 -0
- package/.cursor/skills/self-signed-cert/scripts/generate-cert.ps1 +45 -0
- package/.cursor/skills/self-signed-cert/scripts/generate-cert.sh +43 -0
- package/.cursor/skills/skill-creator/SKILL.md +196 -0
- package/.cursor/skills/skill-creator/references/output-patterns.md +82 -0
- package/.cursor/skills/skill-creator/references/workflows.md +28 -0
- package/.cursor/skills/skill-creator/scripts/init_skill.py +208 -0
- package/.cursor/skills/skill-creator/scripts/package_skill.py +99 -0
- package/.cursor/skills/skill-creator/scripts/quick_validate.py +113 -0
- package/.cursor/skills/test-accompanied-development/SKILL.md +50 -0
- package/.cursor/skills/test-generator/SKILL.md +65 -0
- package/.cursor/skills/vercel-react-best-practices/SKILL.md +109 -0
- package/.cursor/skills/verify-hardened-docker-skill/SKILL.md +442 -0
- package/.cursor/skills/verify-hardened-docker-skill/scripts/verify-docker-hardening.sh +439 -0
- package/.gemini/gemini.md +14 -0
- package/.gemini/skills/.ma-agents.json +199 -0
- package/.gemini/skills/MANIFEST.yaml +204 -0
- package/.gemini/skills/ai-audit-trail/SKILL.md +23 -0
- package/.gemini/skills/cmake-best-practices/SKILL.md +64 -0
- package/.gemini/skills/cmake-best-practices/examples/cmake.md +59 -0
- package/.gemini/skills/code-documentation/SKILL.md +57 -0
- package/.gemini/skills/code-documentation/examples/cpp.md +29 -0
- package/.gemini/skills/code-documentation/examples/csharp.md +28 -0
- package/.gemini/skills/code-documentation/examples/javascript_typescript.md +28 -0
- package/.gemini/skills/code-documentation/examples/python.md +57 -0
- package/.gemini/skills/code-review/SKILL.md +43 -0
- package/.gemini/skills/commit-message/SKILL.md +79 -0
- package/.gemini/skills/cpp-concurrency-safety/SKILL.md +60 -0
- package/.gemini/skills/cpp-concurrency-safety/examples/concurrency.md +73 -0
- package/.gemini/skills/cpp-const-correctness/SKILL.md +63 -0
- package/.gemini/skills/cpp-const-correctness/examples/const_correctness.md +54 -0
- package/.gemini/skills/cpp-memory-handling/SKILL.md +42 -0
- package/.gemini/skills/cpp-memory-handling/examples/modern-cpp.md +49 -0
- package/.gemini/skills/cpp-memory-handling/examples/smart-pointers.md +46 -0
- package/.gemini/skills/cpp-modern-composition/SKILL.md +64 -0
- package/.gemini/skills/cpp-modern-composition/examples/composition.md +51 -0
- package/.gemini/skills/cpp-robust-interfaces/SKILL.md +55 -0
- package/.gemini/skills/cpp-robust-interfaces/examples/interfaces.md +56 -0
- package/.gemini/skills/create-hardened-docker-skill/SKILL.md +637 -0
- package/.gemini/skills/create-hardened-docker-skill/scripts/create-all.sh +489 -0
- package/.gemini/skills/docker-hardening-verification/SKILL.md +28 -0
- package/.gemini/skills/docker-hardening-verification/scripts/verify-hardening.sh +39 -0
- package/.gemini/skills/docker-image-signing/SKILL.md +28 -0
- package/.gemini/skills/docker-image-signing/scripts/sign-image.sh +33 -0
- package/.gemini/skills/document-revision-history/SKILL.md +104 -0
- package/.gemini/skills/git-workflow-skill/SKILL.md +194 -0
- package/.gemini/skills/git-workflow-skill/hooks/commit-msg +61 -0
- package/.gemini/skills/git-workflow-skill/hooks/pre-commit +38 -0
- package/.gemini/skills/git-workflow-skill/hooks/prepare-commit-msg +56 -0
- package/.gemini/skills/git-workflow-skill/scripts/finish-feature.sh +192 -0
- package/.gemini/skills/git-workflow-skill/scripts/install-hooks.sh +55 -0
- package/.gemini/skills/git-workflow-skill/scripts/start-feature.sh +110 -0
- package/.gemini/skills/git-workflow-skill/scripts/validate-workflow.sh +229 -0
- package/.gemini/skills/js-ts-dependency-mgmt/SKILL.md +49 -0
- package/.gemini/skills/js-ts-dependency-mgmt/examples/dependency_mgmt.md +60 -0
- package/.gemini/skills/js-ts-security-skill/SKILL.md +64 -0
- package/.gemini/skills/js-ts-security-skill/scripts/verify-security.sh +136 -0
- package/.gemini/skills/logging-best-practices/SKILL.md +50 -0
- package/.gemini/skills/logging-best-practices/examples/cpp.md +36 -0
- package/.gemini/skills/logging-best-practices/examples/csharp.md +49 -0
- package/.gemini/skills/logging-best-practices/examples/javascript.md +77 -0
- package/.gemini/skills/logging-best-practices/examples/python.md +57 -0
- package/.gemini/skills/logging-best-practices/references/logging-standards.md +29 -0
- package/.gemini/skills/opentelemetry-best-practices/SKILL.md +34 -0
- package/.gemini/skills/opentelemetry-best-practices/examples/go.md +32 -0
- package/.gemini/skills/opentelemetry-best-practices/examples/javascript.md +58 -0
- package/.gemini/skills/opentelemetry-best-practices/examples/python.md +37 -0
- package/.gemini/skills/opentelemetry-best-practices/references/otel-standards.md +37 -0
- package/.gemini/skills/python-dependency-mgmt/SKILL.md +42 -0
- package/.gemini/skills/python-dependency-mgmt/examples/dependency_mgmt.md +67 -0
- package/.gemini/skills/python-security-skill/SKILL.md +56 -0
- package/.gemini/skills/python-security-skill/examples/security.md +56 -0
- package/.gemini/skills/self-signed-cert/SKILL.md +42 -0
- package/.gemini/skills/self-signed-cert/scripts/generate-cert.ps1 +45 -0
- package/.gemini/skills/self-signed-cert/scripts/generate-cert.sh +43 -0
- package/.gemini/skills/skill-creator/SKILL.md +196 -0
- package/.gemini/skills/skill-creator/references/output-patterns.md +82 -0
- package/.gemini/skills/skill-creator/references/workflows.md +28 -0
- package/.gemini/skills/skill-creator/scripts/init_skill.py +208 -0
- package/.gemini/skills/skill-creator/scripts/package_skill.py +99 -0
- package/.gemini/skills/skill-creator/scripts/quick_validate.py +113 -0
- package/.gemini/skills/test-accompanied-development/SKILL.md +50 -0
- package/.gemini/skills/test-generator/SKILL.md +65 -0
- package/.gemini/skills/vercel-react-best-practices/SKILL.md +109 -0
- package/.gemini/skills/verify-hardened-docker-skill/SKILL.md +442 -0
- package/.gemini/skills/verify-hardened-docker-skill/scripts/verify-docker-hardening.sh +439 -0
- package/.github/copilot/copilot.md +14 -0
- package/.github/copilot/skills/.ma-agents.json +199 -0
- package/.github/copilot/skills/MANIFEST.yaml +204 -0
- package/.github/copilot/skills/ai-audit-trail/SKILL.md +23 -0
- package/.github/copilot/skills/cmake-best-practices/SKILL.md +64 -0
- package/.github/copilot/skills/cmake-best-practices/examples/cmake.md +59 -0
- package/.github/copilot/skills/code-documentation/SKILL.md +57 -0
- package/.github/copilot/skills/code-documentation/examples/cpp.md +29 -0
- package/.github/copilot/skills/code-documentation/examples/csharp.md +28 -0
- package/.github/copilot/skills/code-documentation/examples/javascript_typescript.md +28 -0
- package/.github/copilot/skills/code-documentation/examples/python.md +57 -0
- package/.github/copilot/skills/code-review/SKILL.md +43 -0
- package/.github/copilot/skills/commit-message/SKILL.md +79 -0
- package/.github/copilot/skills/cpp-concurrency-safety/SKILL.md +60 -0
- package/.github/copilot/skills/cpp-concurrency-safety/examples/concurrency.md +73 -0
- package/.github/copilot/skills/cpp-const-correctness/SKILL.md +63 -0
- package/.github/copilot/skills/cpp-const-correctness/examples/const_correctness.md +54 -0
- package/.github/copilot/skills/cpp-memory-handling/SKILL.md +42 -0
- package/.github/copilot/skills/cpp-memory-handling/examples/modern-cpp.md +49 -0
- package/.github/copilot/skills/cpp-memory-handling/examples/smart-pointers.md +46 -0
- package/.github/copilot/skills/cpp-modern-composition/SKILL.md +64 -0
- package/.github/copilot/skills/cpp-modern-composition/examples/composition.md +51 -0
- package/.github/copilot/skills/cpp-robust-interfaces/SKILL.md +55 -0
- package/.github/copilot/skills/cpp-robust-interfaces/examples/interfaces.md +56 -0
- package/.github/copilot/skills/create-hardened-docker-skill/SKILL.md +637 -0
- package/.github/copilot/skills/create-hardened-docker-skill/scripts/create-all.sh +489 -0
- package/.github/copilot/skills/docker-hardening-verification/SKILL.md +28 -0
- package/.github/copilot/skills/docker-hardening-verification/scripts/verify-hardening.sh +39 -0
- package/.github/copilot/skills/docker-image-signing/SKILL.md +28 -0
- package/.github/copilot/skills/docker-image-signing/scripts/sign-image.sh +33 -0
- package/.github/copilot/skills/document-revision-history/SKILL.md +104 -0
- package/.github/copilot/skills/git-workflow-skill/SKILL.md +194 -0
- package/.github/copilot/skills/git-workflow-skill/hooks/commit-msg +61 -0
- package/.github/copilot/skills/git-workflow-skill/hooks/pre-commit +38 -0
- package/.github/copilot/skills/git-workflow-skill/hooks/prepare-commit-msg +56 -0
- package/.github/copilot/skills/git-workflow-skill/scripts/finish-feature.sh +192 -0
- package/.github/copilot/skills/git-workflow-skill/scripts/install-hooks.sh +55 -0
- package/.github/copilot/skills/git-workflow-skill/scripts/start-feature.sh +110 -0
- package/.github/copilot/skills/git-workflow-skill/scripts/validate-workflow.sh +229 -0
- package/.github/copilot/skills/js-ts-dependency-mgmt/SKILL.md +49 -0
- package/.github/copilot/skills/js-ts-dependency-mgmt/examples/dependency_mgmt.md +60 -0
- package/.github/copilot/skills/js-ts-security-skill/SKILL.md +64 -0
- package/.github/copilot/skills/js-ts-security-skill/scripts/verify-security.sh +136 -0
- package/.github/copilot/skills/logging-best-practices/SKILL.md +50 -0
- package/.github/copilot/skills/logging-best-practices/examples/cpp.md +36 -0
- package/.github/copilot/skills/logging-best-practices/examples/csharp.md +49 -0
- package/.github/copilot/skills/logging-best-practices/examples/javascript.md +77 -0
- package/.github/copilot/skills/logging-best-practices/examples/python.md +57 -0
- package/.github/copilot/skills/logging-best-practices/references/logging-standards.md +29 -0
- package/.github/copilot/skills/opentelemetry-best-practices/SKILL.md +34 -0
- package/.github/copilot/skills/opentelemetry-best-practices/examples/go.md +32 -0
- package/.github/copilot/skills/opentelemetry-best-practices/examples/javascript.md +58 -0
- package/.github/copilot/skills/opentelemetry-best-practices/examples/python.md +37 -0
- package/.github/copilot/skills/opentelemetry-best-practices/references/otel-standards.md +37 -0
- package/.github/copilot/skills/python-dependency-mgmt/SKILL.md +42 -0
- package/.github/copilot/skills/python-dependency-mgmt/examples/dependency_mgmt.md +67 -0
- package/.github/copilot/skills/python-security-skill/SKILL.md +56 -0
- package/.github/copilot/skills/python-security-skill/examples/security.md +56 -0
- package/.github/copilot/skills/self-signed-cert/SKILL.md +42 -0
- package/.github/copilot/skills/self-signed-cert/scripts/generate-cert.ps1 +45 -0
- package/.github/copilot/skills/self-signed-cert/scripts/generate-cert.sh +43 -0
- package/.github/copilot/skills/skill-creator/SKILL.md +196 -0
- package/.github/copilot/skills/skill-creator/references/output-patterns.md +82 -0
- package/.github/copilot/skills/skill-creator/references/workflows.md +28 -0
- package/.github/copilot/skills/skill-creator/scripts/init_skill.py +208 -0
- package/.github/copilot/skills/skill-creator/scripts/package_skill.py +99 -0
- package/.github/copilot/skills/skill-creator/scripts/quick_validate.py +113 -0
- package/.github/copilot/skills/test-accompanied-development/SKILL.md +50 -0
- package/.github/copilot/skills/test-generator/SKILL.md +65 -0
- package/.github/copilot/skills/vercel-react-best-practices/SKILL.md +109 -0
- package/.github/copilot/skills/verify-hardened-docker-skill/SKILL.md +442 -0
- package/.github/copilot/skills/verify-hardened-docker-skill/scripts/verify-docker-hardening.sh +439 -0
- package/.kilocode/kilocode.md +14 -0
- package/.kilocode/skills/.ma-agents.json +199 -0
- package/.kilocode/skills/MANIFEST.yaml +204 -0
- package/.kilocode/skills/ai-audit-trail/SKILL.md +23 -0
- package/.kilocode/skills/cmake-best-practices/SKILL.md +64 -0
- package/.kilocode/skills/cmake-best-practices/examples/cmake.md +59 -0
- package/.kilocode/skills/code-documentation/SKILL.md +57 -0
- package/.kilocode/skills/code-documentation/examples/cpp.md +29 -0
- package/.kilocode/skills/code-documentation/examples/csharp.md +28 -0
- package/.kilocode/skills/code-documentation/examples/javascript_typescript.md +28 -0
- package/.kilocode/skills/code-documentation/examples/python.md +57 -0
- package/.kilocode/skills/code-review/SKILL.md +43 -0
- package/.kilocode/skills/commit-message/SKILL.md +79 -0
- package/.kilocode/skills/cpp-concurrency-safety/SKILL.md +60 -0
- package/.kilocode/skills/cpp-concurrency-safety/examples/concurrency.md +73 -0
- package/.kilocode/skills/cpp-const-correctness/SKILL.md +63 -0
- package/.kilocode/skills/cpp-const-correctness/examples/const_correctness.md +54 -0
- package/.kilocode/skills/cpp-memory-handling/SKILL.md +42 -0
- package/.kilocode/skills/cpp-memory-handling/examples/modern-cpp.md +49 -0
- package/.kilocode/skills/cpp-memory-handling/examples/smart-pointers.md +46 -0
- package/.kilocode/skills/cpp-modern-composition/SKILL.md +64 -0
- package/.kilocode/skills/cpp-modern-composition/examples/composition.md +51 -0
- package/.kilocode/skills/cpp-robust-interfaces/SKILL.md +55 -0
- package/.kilocode/skills/cpp-robust-interfaces/examples/interfaces.md +56 -0
- package/.kilocode/skills/create-hardened-docker-skill/SKILL.md +637 -0
- package/.kilocode/skills/create-hardened-docker-skill/scripts/create-all.sh +489 -0
- package/.kilocode/skills/docker-hardening-verification/SKILL.md +28 -0
- package/.kilocode/skills/docker-hardening-verification/scripts/verify-hardening.sh +39 -0
- package/.kilocode/skills/docker-image-signing/SKILL.md +28 -0
- package/.kilocode/skills/docker-image-signing/scripts/sign-image.sh +33 -0
- package/.kilocode/skills/document-revision-history/SKILL.md +104 -0
- package/.kilocode/skills/git-workflow-skill/SKILL.md +194 -0
- package/.kilocode/skills/git-workflow-skill/hooks/commit-msg +61 -0
- package/.kilocode/skills/git-workflow-skill/hooks/pre-commit +38 -0
- package/.kilocode/skills/git-workflow-skill/hooks/prepare-commit-msg +56 -0
- package/.kilocode/skills/git-workflow-skill/scripts/finish-feature.sh +192 -0
- package/.kilocode/skills/git-workflow-skill/scripts/install-hooks.sh +55 -0
- package/.kilocode/skills/git-workflow-skill/scripts/start-feature.sh +110 -0
- package/.kilocode/skills/git-workflow-skill/scripts/validate-workflow.sh +229 -0
- package/.kilocode/skills/js-ts-dependency-mgmt/SKILL.md +49 -0
- package/.kilocode/skills/js-ts-dependency-mgmt/examples/dependency_mgmt.md +60 -0
- package/.kilocode/skills/js-ts-security-skill/SKILL.md +64 -0
- package/.kilocode/skills/js-ts-security-skill/scripts/verify-security.sh +136 -0
- package/.kilocode/skills/logging-best-practices/SKILL.md +50 -0
- package/.kilocode/skills/logging-best-practices/examples/cpp.md +36 -0
- package/.kilocode/skills/logging-best-practices/examples/csharp.md +49 -0
- package/.kilocode/skills/logging-best-practices/examples/javascript.md +77 -0
- package/.kilocode/skills/logging-best-practices/examples/python.md +57 -0
- package/.kilocode/skills/logging-best-practices/references/logging-standards.md +29 -0
- package/.kilocode/skills/opentelemetry-best-practices/SKILL.md +34 -0
- package/.kilocode/skills/opentelemetry-best-practices/examples/go.md +32 -0
- package/.kilocode/skills/opentelemetry-best-practices/examples/javascript.md +58 -0
- package/.kilocode/skills/opentelemetry-best-practices/examples/python.md +37 -0
- package/.kilocode/skills/opentelemetry-best-practices/references/otel-standards.md +37 -0
- package/.kilocode/skills/python-dependency-mgmt/SKILL.md +42 -0
- package/.kilocode/skills/python-dependency-mgmt/examples/dependency_mgmt.md +67 -0
- package/.kilocode/skills/python-security-skill/SKILL.md +56 -0
- package/.kilocode/skills/python-security-skill/examples/security.md +56 -0
- package/.kilocode/skills/self-signed-cert/SKILL.md +42 -0
- package/.kilocode/skills/self-signed-cert/scripts/generate-cert.ps1 +45 -0
- package/.kilocode/skills/self-signed-cert/scripts/generate-cert.sh +43 -0
- package/.kilocode/skills/skill-creator/SKILL.md +196 -0
- package/.kilocode/skills/skill-creator/references/output-patterns.md +82 -0
- package/.kilocode/skills/skill-creator/references/workflows.md +28 -0
- package/.kilocode/skills/skill-creator/scripts/init_skill.py +208 -0
- package/.kilocode/skills/skill-creator/scripts/package_skill.py +99 -0
- package/.kilocode/skills/skill-creator/scripts/quick_validate.py +113 -0
- package/.kilocode/skills/test-accompanied-development/SKILL.md +50 -0
- package/.kilocode/skills/test-generator/SKILL.md +65 -0
- package/.kilocode/skills/vercel-react-best-practices/SKILL.md +109 -0
- package/.kilocode/skills/verify-hardened-docker-skill/SKILL.md +442 -0
- package/.kilocode/skills/verify-hardened-docker-skill/scripts/verify-docker-hardening.sh +439 -0
- package/agents.code-workspace +11 -0
- package/bin/cli.js +250 -151
- package/docs/architecture.md +284 -0
- package/docs/development-guide.md +122 -0
- package/docs/index.md +48 -0
- package/docs/project-overview.md +56 -0
- package/docs/project-scan-report.json +50 -0
- package/docs/source-tree-analysis.md +84 -0
- package/docs/validation/bundled-installation-validation.md +52 -0
- package/lib/bmad-cache/bmb/.markdownlint-cli2.yaml +35 -0
- package/lib/bmad-cache/bmb/.nvmrc +1 -0
- package/lib/bmad-cache/bmb/.prettierignore +9 -0
- package/lib/bmad-cache/bmb/CNAME +1 -0
- package/lib/bmad-cache/bmb/LICENSE +30 -0
- package/lib/bmad-cache/bmb/README.md +63 -0
- package/lib/bmad-cache/bmb/eslint.config.mjs +141 -0
- package/lib/bmad-cache/bmb/package-lock.json +15283 -0
- package/lib/bmad-cache/bmb/package.json +96 -0
- package/lib/bmad-cache/bmb/prettier.config.mjs +32 -0
- package/lib/bmad-cache/bmb/samples/bmad-agent-dream-weaver/bmad-manifest.json +62 -0
- package/lib/bmad-cache/bmb/samples/bmad-agent-dream-weaver/scripts/recall_metrics.py +229 -0
- package/lib/bmad-cache/bmb/samples/bmad-agent-dream-weaver/scripts/seed_tracker.py +156 -0
- package/lib/bmad-cache/bmb/samples/bmad-agent-dream-weaver/scripts/symbol_stats.py +162 -0
- package/lib/bmad-cache/bmb/samples/bmad-agent-dream-weaver/scripts/tests/test_recall_metrics.py +115 -0
- package/lib/bmad-cache/bmb/samples/bmad-agent-dream-weaver/scripts/tests/test_seed_tracker.py +140 -0
- package/lib/bmad-cache/bmb/samples/bmad-agent-dream-weaver/scripts/tests/test_symbol_stats.py +113 -0
- package/lib/bmad-cache/bmb/samples/bmad-excalidraw/bmad-manifest.json +18 -0
- package/lib/bmad-cache/bmb/samples/bmad-excalidraw/scripts/generate_excalidraw.py +605 -0
- package/lib/bmad-cache/bmb/samples/bmad-excalidraw/scripts/tests/test_generate_excalidraw.py +360 -0
- package/lib/bmad-cache/bmb/samples/bmad-excalidraw/scripts/tests/test_validate_excalidraw.py +246 -0
- package/lib/bmad-cache/bmb/samples/bmad-excalidraw/scripts/validate_excalidraw.py +264 -0
- package/lib/bmad-cache/bmb/src/module-help.csv +7 -0
- package/lib/bmad-cache/bmb/src/module.yaml +20 -0
- package/lib/bmad-cache/bmb/src/skills/bmad-agent-builder/bmad-manifest.json +24 -0
- package/lib/bmad-cache/bmb/src/skills/bmad-agent-builder/bmad-skill-manifest.yaml +1 -0
- package/lib/bmad-cache/bmb/src/skills/bmad-agent-builder/scripts/bmad-manifest-schema.json +103 -0
- package/lib/bmad-cache/bmb/src/skills/bmad-agent-builder/scripts/generate-html-report.py +1002 -0
- package/lib/bmad-cache/bmb/src/skills/bmad-agent-builder/scripts/manifest.py +420 -0
- package/lib/bmad-cache/bmb/src/skills/bmad-agent-builder/scripts/prepass-execution-deps.py +368 -0
- package/lib/bmad-cache/bmb/src/skills/bmad-agent-builder/scripts/prepass-prompt-metrics.py +476 -0
- package/lib/bmad-cache/bmb/src/skills/bmad-agent-builder/scripts/prepass-structure-capabilities.py +636 -0
- package/lib/bmad-cache/bmb/src/skills/bmad-agent-builder/scripts/scan-path-standards.py +253 -0
- package/lib/bmad-cache/bmb/src/skills/bmad-agent-builder/scripts/scan-scripts.py +745 -0
- package/lib/bmad-cache/bmb/src/skills/bmad-workflow-builder/bmad-manifest.json +23 -0
- package/lib/bmad-cache/bmb/src/skills/bmad-workflow-builder/bmad-skill-manifest.yaml +1 -0
- package/lib/bmad-cache/bmb/src/skills/bmad-workflow-builder/scripts/bmad-manifest-schema.json +103 -0
- package/lib/bmad-cache/bmb/src/skills/bmad-workflow-builder/scripts/generate-html-report.py +1002 -0
- package/lib/bmad-cache/bmb/src/skills/bmad-workflow-builder/scripts/manifest.py +420 -0
- package/lib/bmad-cache/bmb/src/skills/bmad-workflow-builder/scripts/prepass-execution-deps.py +313 -0
- package/lib/bmad-cache/bmb/src/skills/bmad-workflow-builder/scripts/prepass-prompt-metrics.py +285 -0
- package/lib/bmad-cache/bmb/src/skills/bmad-workflow-builder/scripts/prepass-workflow-integrity.py +485 -0
- package/lib/bmad-cache/bmb/src/skills/bmad-workflow-builder/scripts/scan-path-standards.py +213 -0
- package/lib/bmad-cache/bmb/src/skills/bmad-workflow-builder/scripts/scan-scripts.py +745 -0
- package/lib/bmad-cache/bmb/tools/build-docs.mjs +448 -0
- package/lib/bmad-cache/bmb/tools/validate-file-refs.mjs +657 -0
- package/lib/bmad-cache/bmb/website/astro.config.mjs +134 -0
- package/lib/bmad-cache/bmb/website/public/favicon.ico +0 -0
- package/lib/bmad-cache/bmb/website/public/img/bmad-dark.png +0 -0
- package/lib/bmad-cache/bmb/website/public/img/bmad-light.png +0 -0
- package/lib/bmad-cache/bmb/website/src/components/Banner.astro +56 -0
- package/lib/bmad-cache/bmb/website/src/components/Header.astro +94 -0
- package/lib/bmad-cache/bmb/website/src/components/MobileMenuFooter.astro +33 -0
- package/lib/bmad-cache/bmb/website/src/content/config.ts +6 -0
- package/lib/bmad-cache/bmb/website/src/content/docs +1 -0
- package/lib/bmad-cache/bmb/website/src/lib/site-url.mjs +25 -0
- package/lib/bmad-cache/bmb/website/src/rehype-base-paths.js +88 -0
- package/lib/bmad-cache/bmb/website/src/rehype-markdown-links.js +117 -0
- package/lib/bmad-cache/bmb/website/src/styles/custom.css +484 -0
- package/lib/bmad-cache/cache-manifest.json +30 -0
- package/lib/bmad-cache/cis/.markdownlint-cli2.yaml +35 -0
- package/lib/bmad-cache/cis/.nvmrc +1 -0
- package/lib/bmad-cache/cis/.prettierignore +9 -0
- package/lib/bmad-cache/cis/CNAME +1 -0
- package/lib/bmad-cache/cis/LICENSE +26 -0
- package/lib/bmad-cache/cis/README.md +105 -0
- package/lib/bmad-cache/cis/eslint.config.mjs +141 -0
- package/lib/bmad-cache/cis/package.json +92 -0
- package/lib/bmad-cache/cis/prettier.config.mjs +32 -0
- package/lib/bmad-cache/cis/src/agents/brainstorming-coach.agent.yaml +21 -0
- package/lib/bmad-cache/cis/src/agents/creative-problem-solver.agent.yaml +21 -0
- package/lib/bmad-cache/cis/src/agents/design-thinking-coach.agent.yaml +21 -0
- package/lib/bmad-cache/cis/src/agents/innovation-strategist.agent.yaml +21 -0
- package/lib/bmad-cache/cis/src/agents/presentation-master.agent.yaml +53 -0
- package/lib/bmad-cache/cis/src/agents/storyteller/storyteller.agent.yaml +25 -0
- package/lib/bmad-cache/cis/src/module-help.csv +6 -0
- package/lib/bmad-cache/cis/src/module.yaml +27 -0
- package/lib/bmad-cache/cis/src/teams/creative-squad.yaml +7 -0
- package/lib/bmad-cache/cis/src/teams/default-party.csv +12 -0
- package/lib/bmad-cache/cis/src/workflows/README.md +175 -0
- package/lib/bmad-cache/cis/src/workflows/bmad-cis-design-thinking/bmad-skill-manifest.yaml +1 -0
- package/lib/bmad-cache/cis/src/workflows/bmad-cis-design-thinking/design-methods.csv +31 -0
- package/lib/bmad-cache/cis/src/workflows/bmad-cis-innovation-strategy/bmad-skill-manifest.yaml +1 -0
- package/lib/bmad-cache/cis/src/workflows/bmad-cis-innovation-strategy/innovation-frameworks.csv +31 -0
- package/lib/bmad-cache/cis/src/workflows/bmad-cis-problem-solving/bmad-skill-manifest.yaml +1 -0
- package/lib/bmad-cache/cis/src/workflows/bmad-cis-problem-solving/solving-methods.csv +31 -0
- package/lib/bmad-cache/cis/src/workflows/bmad-cis-storytelling/bmad-skill-manifest.yaml +1 -0
- package/lib/bmad-cache/cis/src/workflows/bmad-cis-storytelling/story-types.csv +26 -0
- package/lib/bmad-cache/cis/tools/build-docs.mjs +448 -0
- package/lib/bmad-cache/cis/website/astro.config.mjs +134 -0
- package/lib/bmad-cache/cis/website/public/favicon.ico +0 -0
- package/lib/bmad-cache/cis/website/public/img/bmad-dark.png +0 -0
- package/lib/bmad-cache/cis/website/public/img/bmad-light.png +0 -0
- package/lib/bmad-cache/cis/website/src/components/Banner.astro +56 -0
- package/lib/bmad-cache/cis/website/src/components/Header.astro +94 -0
- package/lib/bmad-cache/cis/website/src/components/MobileMenuFooter.astro +33 -0
- package/lib/bmad-cache/cis/website/src/content/config.ts +6 -0
- package/lib/bmad-cache/cis/website/src/content/docs +1 -0
- package/lib/bmad-cache/cis/website/src/lib/site-url.mjs +25 -0
- package/lib/bmad-cache/cis/website/src/rehype-base-paths.js +88 -0
- package/lib/bmad-cache/cis/website/src/rehype-markdown-links.js +117 -0
- package/lib/bmad-cache/cis/website/src/styles/custom.css +484 -0
- package/lib/bmad-cache/gds/.markdownlint-cli2.yaml +35 -0
- package/lib/bmad-cache/gds/.nvmrc +1 -0
- package/lib/bmad-cache/gds/.prettierignore +9 -0
- package/lib/bmad-cache/gds/CNAME +1 -0
- package/lib/bmad-cache/gds/LICENSE +26 -0
- package/lib/bmad-cache/gds/README.md +121 -0
- package/lib/bmad-cache/gds/eslint.config.mjs +141 -0
- package/lib/bmad-cache/gds/package.json +92 -0
- package/lib/bmad-cache/gds/prettier.config.mjs +32 -0
- package/lib/bmad-cache/gds/src/agents/game-architect.agent.yaml +44 -0
- package/lib/bmad-cache/gds/src/agents/game-designer.agent.yaml +45 -0
- package/lib/bmad-cache/gds/src/agents/game-dev.agent.yaml +49 -0
- package/lib/bmad-cache/gds/src/agents/game-qa.agent.yaml +63 -0
- package/lib/bmad-cache/gds/src/agents/game-scrum-master.agent.yaml +52 -0
- package/lib/bmad-cache/gds/src/agents/game-solo-dev.agent.yaml +53 -0
- package/lib/bmad-cache/gds/src/agents/tech-writer/tech-writer.agent.yaml +45 -0
- package/lib/bmad-cache/gds/src/gametest/qa-index.csv +18 -0
- package/lib/bmad-cache/gds/src/module-help.csv +35 -0
- package/lib/bmad-cache/gds/src/module.yaml +71 -0
- package/lib/bmad-cache/gds/src/teams/default-party.csv +12 -0
- package/lib/bmad-cache/gds/src/teams/team-gamedev.yaml +29 -0
- package/lib/bmad-cache/gds/src/workflows/1-preproduction/brainstorm-game/bmad-skill-manifest.yaml +3 -0
- package/lib/bmad-cache/gds/src/workflows/1-preproduction/brainstorm-game/game-brain-methods.csv +26 -0
- package/lib/bmad-cache/gds/src/workflows/1-preproduction/game-brief/bmad-skill-manifest.yaml +3 -0
- package/lib/bmad-cache/gds/src/workflows/1-preproduction/research/bmad-skill-manifest.yaml +9 -0
- package/lib/bmad-cache/gds/src/workflows/1-preproduction/research/gds-domain-research/bmad-skill-manifest.yaml +1 -0
- package/lib/bmad-cache/gds/src/workflows/2-design/create-prd/bmad-skill-manifest.yaml +14 -0
- package/lib/bmad-cache/gds/src/workflows/2-design/create-prd/data/domain-complexity.csv +15 -0
- package/lib/bmad-cache/gds/src/workflows/2-design/create-prd/data/project-types.csv +11 -0
- package/lib/bmad-cache/gds/src/workflows/2-design/gdd/bmad-skill-manifest.yaml +3 -0
- package/lib/bmad-cache/gds/src/workflows/2-design/gdd/game-types.csv +25 -0
- package/lib/bmad-cache/gds/src/workflows/2-design/gds-create-ux-design/bmad-skill-manifest.yaml +1 -0
- package/lib/bmad-cache/gds/src/workflows/2-design/narrative/bmad-skill-manifest.yaml +3 -0
- package/lib/bmad-cache/gds/src/workflows/3-technical/check-implementation-readiness/bmad-skill-manifest.yaml +3 -0
- package/lib/bmad-cache/gds/src/workflows/3-technical/create-epics-and-stories/bmad-skill-manifest.yaml +3 -0
- package/lib/bmad-cache/gds/src/workflows/3-technical/game-architecture/architecture-patterns.yaml +507 -0
- package/lib/bmad-cache/gds/src/workflows/3-technical/game-architecture/bmad-skill-manifest.yaml +3 -0
- package/lib/bmad-cache/gds/src/workflows/3-technical/game-architecture/decision-catalog.yaml +340 -0
- package/lib/bmad-cache/gds/src/workflows/3-technical/game-architecture/engine-mcps.yaml +270 -0
- package/lib/bmad-cache/gds/src/workflows/3-technical/game-architecture/pattern-categories.csv +13 -0
- package/lib/bmad-cache/gds/src/workflows/3-technical/generate-project-context/bmad-skill-manifest.yaml +3 -0
- package/lib/bmad-cache/gds/src/workflows/4-production/code-review/bmad-skill-manifest.yaml +3 -0
- package/lib/bmad-cache/gds/src/workflows/4-production/correct-course/bmad-skill-manifest.yaml +3 -0
- package/lib/bmad-cache/gds/src/workflows/4-production/gds-create-story/bmad-skill-manifest.yaml +1 -0
- package/lib/bmad-cache/gds/src/workflows/4-production/gds-dev-story/bmad-skill-manifest.yaml +1 -0
- package/lib/bmad-cache/gds/src/workflows/4-production/retrospective/bmad-skill-manifest.yaml +3 -0
- package/lib/bmad-cache/gds/src/workflows/4-production/sprint-planning/bmad-skill-manifest.yaml +3 -0
- package/lib/bmad-cache/gds/src/workflows/4-production/sprint-planning/sprint-status-template.yaml +55 -0
- package/lib/bmad-cache/gds/src/workflows/4-production/sprint-status/bmad-skill-manifest.yaml +3 -0
- package/lib/bmad-cache/gds/src/workflows/document-project/bmad-skill-manifest.yaml +3 -0
- package/lib/bmad-cache/gds/src/workflows/document-project/documentation-requirements.csv +12 -0
- package/lib/bmad-cache/gds/src/workflows/document-project/templates/project-scan-report-schema.json +160 -0
- package/lib/bmad-cache/gds/src/workflows/gametest/automate/bmad-skill-manifest.yaml +3 -0
- package/lib/bmad-cache/gds/src/workflows/gametest/e2e-scaffold/bmad-skill-manifest.yaml +3 -0
- package/lib/bmad-cache/gds/src/workflows/gametest/performance/bmad-skill-manifest.yaml +3 -0
- package/lib/bmad-cache/gds/src/workflows/gametest/playtest-plan/bmad-skill-manifest.yaml +3 -0
- package/lib/bmad-cache/gds/src/workflows/gametest/test-design/bmad-skill-manifest.yaml +3 -0
- package/lib/bmad-cache/gds/src/workflows/gametest/test-framework/bmad-skill-manifest.yaml +3 -0
- package/lib/bmad-cache/gds/src/workflows/gametest/test-review/bmad-skill-manifest.yaml +3 -0
- package/lib/bmad-cache/gds/src/workflows/gds-quick-flow/gds-quick-dev/bmad-skill-manifest.yaml +4 -0
- package/lib/bmad-cache/gds/src/workflows/gds-quick-flow/gds-quick-dev-new-preview/bmad-skill-manifest.yaml +4 -0
- package/lib/bmad-cache/gds/src/workflows/gds-quick-flow/quick-spec/bmad-skill-manifest.yaml +3 -0
- package/lib/bmad-cache/gds/tools/build-docs.mjs +450 -0
- package/lib/bmad-cache/gds/website/astro.config.mjs +134 -0
- package/lib/bmad-cache/gds/website/public/favicon.ico +0 -0
- package/lib/bmad-cache/gds/website/public/img/bmad-dark.png +0 -0
- package/lib/bmad-cache/gds/website/public/img/bmad-light.png +0 -0
- package/lib/bmad-cache/gds/website/src/components/Banner.astro +56 -0
- package/lib/bmad-cache/gds/website/src/components/Header.astro +94 -0
- package/lib/bmad-cache/gds/website/src/components/MobileMenuFooter.astro +33 -0
- package/lib/bmad-cache/gds/website/src/content/config.ts +6 -0
- package/lib/bmad-cache/gds/website/src/content/docs +1 -0
- package/lib/bmad-cache/gds/website/src/lib/site-url.mjs +25 -0
- package/lib/bmad-cache/gds/website/src/rehype-base-paths.js +88 -0
- package/lib/bmad-cache/gds/website/src/rehype-markdown-links.js +117 -0
- package/lib/bmad-cache/gds/website/src/styles/custom.css +484 -0
- package/lib/bmad-cache/tea/.coderabbit.yaml +40 -0
- package/lib/bmad-cache/tea/.github/CODE_OF_CONDUCT.md +128 -0
- package/lib/bmad-cache/tea/.github/FUNDING.yaml +15 -0
- package/lib/bmad-cache/tea/.github/ISSUE_TEMPLATE/config.yaml +11 -0
- package/lib/bmad-cache/tea/.github/ISSUE_TEMPLATE/feature_request.md +70 -0
- package/lib/bmad-cache/tea/.github/ISSUE_TEMPLATE/issue.md +61 -0
- package/lib/bmad-cache/tea/.github/workflows/docs.yaml +66 -0
- package/lib/bmad-cache/tea/.github/workflows/manual-release.yaml +195 -0
- package/lib/bmad-cache/tea/.github/workflows/quality.yaml +114 -0
- package/lib/bmad-cache/tea/.husky/pre-commit +20 -0
- package/lib/bmad-cache/tea/.markdownlint-cli2.yaml +36 -0
- package/lib/bmad-cache/tea/.nvmrc +1 -0
- package/lib/bmad-cache/tea/.prettierignore +9 -0
- package/lib/bmad-cache/tea/CHANGELOG.md +253 -0
- package/lib/bmad-cache/tea/CONTRIBUTING.md +268 -0
- package/lib/bmad-cache/tea/LICENSE +26 -0
- package/lib/bmad-cache/tea/README.md +371 -0
- package/lib/bmad-cache/tea/SECURITY.md +85 -0
- package/lib/bmad-cache/tea/docs/404.md +20 -0
- package/lib/bmad-cache/tea/docs/MIGRATION.md +488 -0
- package/lib/bmad-cache/tea/docs/explanation/engagement-models.md +767 -0
- package/lib/bmad-cache/tea/docs/explanation/fixture-architecture.md +484 -0
- package/lib/bmad-cache/tea/docs/explanation/knowledge-base-system.md +601 -0
- package/lib/bmad-cache/tea/docs/explanation/network-first-patterns.md +884 -0
- package/lib/bmad-cache/tea/docs/explanation/risk-based-testing.md +628 -0
- package/lib/bmad-cache/tea/docs/explanation/step-file-architecture.md +599 -0
- package/lib/bmad-cache/tea/docs/explanation/subagent-architecture.md +189 -0
- package/lib/bmad-cache/tea/docs/explanation/tea-overview.md +474 -0
- package/lib/bmad-cache/tea/docs/explanation/test-quality-standards.md +965 -0
- package/lib/bmad-cache/tea/docs/explanation/testing-as-engineering.md +115 -0
- package/lib/bmad-cache/tea/docs/glossary/index.md +160 -0
- package/lib/bmad-cache/tea/docs/how-to/brownfield/use-tea-for-enterprise.md +571 -0
- package/lib/bmad-cache/tea/docs/how-to/brownfield/use-tea-with-existing-tests.md +631 -0
- package/lib/bmad-cache/tea/docs/how-to/customization/configure-browser-automation.md +243 -0
- package/lib/bmad-cache/tea/docs/how-to/customization/integrate-playwright-utils.md +846 -0
- package/lib/bmad-cache/tea/docs/how-to/workflows/run-atdd.md +464 -0
- package/lib/bmad-cache/tea/docs/how-to/workflows/run-automate.md +693 -0
- package/lib/bmad-cache/tea/docs/how-to/workflows/run-nfr-assess.md +731 -0
- package/lib/bmad-cache/tea/docs/how-to/workflows/run-test-design.md +144 -0
- package/lib/bmad-cache/tea/docs/how-to/workflows/run-test-review.md +634 -0
- package/lib/bmad-cache/tea/docs/how-to/workflows/run-trace.md +959 -0
- package/lib/bmad-cache/tea/docs/how-to/workflows/setup-ci.md +763 -0
- package/lib/bmad-cache/tea/docs/how-to/workflows/setup-test-framework.md +122 -0
- package/lib/bmad-cache/tea/docs/how-to/workflows/teach-me-testing.md +302 -0
- package/lib/bmad-cache/tea/docs/index.md +74 -0
- package/lib/bmad-cache/tea/docs/reference/commands.md +353 -0
- package/lib/bmad-cache/tea/docs/reference/configuration.md +1122 -0
- package/lib/bmad-cache/tea/docs/reference/knowledge-base.md +404 -0
- package/lib/bmad-cache/tea/docs/reference/troubleshooting.md +788 -0
- package/lib/bmad-cache/tea/docs/tutorials/learn-testing-tea-academy.md +266 -0
- package/lib/bmad-cache/tea/docs/tutorials/tea-lite-quickstart.md +465 -0
- package/lib/bmad-cache/tea/eslint.config.mjs +141 -0
- package/lib/bmad-cache/tea/package-lock.json +16046 -0
- package/lib/bmad-cache/tea/package.json +118 -0
- package/lib/bmad-cache/tea/prettier.config.mjs +32 -0
- package/lib/bmad-cache/tea/src/agents/tea.agent.yaml +67 -0
- package/lib/bmad-cache/tea/src/module-help.csv +10 -0
- package/lib/bmad-cache/tea/src/module.yaml +299 -0
- package/lib/bmad-cache/tea/src/teams/default-party.csv +2 -0
- package/lib/bmad-cache/tea/src/testarch/knowledge/adr-quality-readiness-checklist.md +377 -0
- package/lib/bmad-cache/tea/src/testarch/knowledge/api-request.md +563 -0
- package/lib/bmad-cache/tea/src/testarch/knowledge/api-testing-patterns.md +915 -0
- package/lib/bmad-cache/tea/src/testarch/knowledge/auth-session.md +548 -0
- package/lib/bmad-cache/tea/src/testarch/knowledge/burn-in.md +273 -0
- package/lib/bmad-cache/tea/src/testarch/knowledge/ci-burn-in.md +717 -0
- package/lib/bmad-cache/tea/src/testarch/knowledge/component-tdd.md +486 -0
- package/lib/bmad-cache/tea/src/testarch/knowledge/contract-testing.md +1050 -0
- package/lib/bmad-cache/tea/src/testarch/knowledge/data-factories.md +500 -0
- package/lib/bmad-cache/tea/src/testarch/knowledge/email-auth.md +721 -0
- package/lib/bmad-cache/tea/src/testarch/knowledge/error-handling.md +725 -0
- package/lib/bmad-cache/tea/src/testarch/knowledge/feature-flags.md +750 -0
- package/lib/bmad-cache/tea/src/testarch/knowledge/file-utils.md +456 -0
- package/lib/bmad-cache/tea/src/testarch/knowledge/fixture-architecture.md +401 -0
- package/lib/bmad-cache/tea/src/testarch/knowledge/fixtures-composition.md +382 -0
- package/lib/bmad-cache/tea/src/testarch/knowledge/intercept-network-call.md +426 -0
- package/lib/bmad-cache/tea/src/testarch/knowledge/log.md +426 -0
- package/lib/bmad-cache/tea/src/testarch/knowledge/network-error-monitor.md +401 -0
- package/lib/bmad-cache/tea/src/testarch/knowledge/network-first.md +486 -0
- package/lib/bmad-cache/tea/src/testarch/knowledge/network-recorder.md +527 -0
- package/lib/bmad-cache/tea/src/testarch/knowledge/nfr-criteria.md +670 -0
- package/lib/bmad-cache/tea/src/testarch/knowledge/overview.md +286 -0
- package/lib/bmad-cache/tea/src/testarch/knowledge/pact-consumer-di.md +310 -0
- package/lib/bmad-cache/tea/src/testarch/knowledge/pact-consumer-framework-setup.md +635 -0
- package/lib/bmad-cache/tea/src/testarch/knowledge/pact-mcp.md +204 -0
- package/lib/bmad-cache/tea/src/testarch/knowledge/pactjs-utils-consumer-helpers.md +270 -0
- package/lib/bmad-cache/tea/src/testarch/knowledge/pactjs-utils-overview.md +216 -0
- package/lib/bmad-cache/tea/src/testarch/knowledge/pactjs-utils-provider-verifier.md +315 -0
- package/lib/bmad-cache/tea/src/testarch/knowledge/pactjs-utils-request-filter.md +224 -0
- package/lib/bmad-cache/tea/src/testarch/knowledge/playwright-cli.md +165 -0
- package/lib/bmad-cache/tea/src/testarch/knowledge/playwright-config.md +730 -0
- package/lib/bmad-cache/tea/src/testarch/knowledge/probability-impact.md +601 -0
- package/lib/bmad-cache/tea/src/testarch/knowledge/recurse.md +421 -0
- package/lib/bmad-cache/tea/src/testarch/knowledge/risk-governance.md +615 -0
- package/lib/bmad-cache/tea/src/testarch/knowledge/selective-testing.md +732 -0
- package/lib/bmad-cache/tea/src/testarch/knowledge/selector-resilience.md +527 -0
- package/lib/bmad-cache/tea/src/testarch/knowledge/test-healing-patterns.md +644 -0
- package/lib/bmad-cache/tea/src/testarch/knowledge/test-levels-framework.md +473 -0
- package/lib/bmad-cache/tea/src/testarch/knowledge/test-priorities-matrix.md +373 -0
- package/lib/bmad-cache/tea/src/testarch/knowledge/test-quality.md +664 -0
- package/lib/bmad-cache/tea/src/testarch/knowledge/timing-debugging.md +372 -0
- package/lib/bmad-cache/tea/src/testarch/knowledge/visual-debugging.md +524 -0
- package/lib/bmad-cache/tea/src/testarch/tea-index.csv +43 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/README.md +74 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-teach-me-testing/SKILL.md +6 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-teach-me-testing/bmad-skill-manifest.yaml +1 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-teach-me-testing/checklist.md +197 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-teach-me-testing/data/curriculum.yaml +129 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-teach-me-testing/data/quiz-questions.yaml +206 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-teach-me-testing/data/role-paths.yaml +136 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-teach-me-testing/data/session-content-map.yaml +207 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-teach-me-testing/data/tea-resources-index.yaml +359 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-teach-me-testing/instructions.md +130 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-teach-me-testing/steps-c/step-01-init.md +235 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-teach-me-testing/steps-c/step-01b-continue.md +147 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-teach-me-testing/steps-c/step-02-assess.md +258 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-teach-me-testing/steps-c/step-03-session-menu.md +219 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-teach-me-testing/steps-c/step-04-session-01.md +460 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-teach-me-testing/steps-c/step-04-session-02.md +465 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-teach-me-testing/steps-c/step-04-session-03.md +301 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-teach-me-testing/steps-c/step-04-session-04.md +234 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-teach-me-testing/steps-c/step-04-session-05.md +234 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-teach-me-testing/steps-c/step-04-session-06.md +209 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-teach-me-testing/steps-c/step-04-session-07.md +212 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-teach-me-testing/steps-c/step-05-completion.md +339 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-teach-me-testing/steps-e/step-e-01-assess-workflow.md +141 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-teach-me-testing/steps-e/step-e-02-apply-edits.md +122 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-teach-me-testing/steps-v/step-v-01-validate.md +263 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-teach-me-testing/templates/certificate-template.md +86 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-teach-me-testing/templates/progress-template.yaml +95 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-teach-me-testing/templates/session-notes-template.md +83 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-teach-me-testing/workflow-plan-teach-me-testing.md +950 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-teach-me-testing/workflow.md +90 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-atdd/SKILL.md +6 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-atdd/atdd-checklist-template.md +371 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-atdd/bmad-skill-manifest.yaml +1 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-atdd/checklist.md +374 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-atdd/instructions.md +45 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-atdd/steps-c/step-01-preflight-and-context.md +226 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-atdd/steps-c/step-01b-resume.md +96 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-atdd/steps-c/step-02-generation-mode.md +125 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-atdd/steps-c/step-03-test-strategy.md +110 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-atdd/steps-c/step-04-generate-tests.md +334 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-atdd/steps-c/step-04a-subagent-api-failing.md +286 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-atdd/steps-c/step-04b-subagent-e2e-failing.md +244 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-atdd/steps-c/step-04c-aggregate.md +370 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-atdd/steps-c/step-05-validate-and-complete.md +106 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-atdd/steps-e/step-01-assess.md +65 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-atdd/steps-e/step-02-apply-edit.md +60 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-atdd/steps-v/step-01-validate.md +67 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-atdd/validation-report-20260127-095021.md +73 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-atdd/validation-report-20260127-102401.md +116 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-atdd/workflow-plan.md +21 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-atdd/workflow.md +41 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-atdd/workflow.yaml +46 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-automate/SKILL.md +6 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-automate/bmad-skill-manifest.yaml +1 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-automate/checklist.md +611 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-automate/instructions.md +50 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-automate/steps-c/step-01-preflight-and-context.md +237 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-automate/steps-c/step-01b-resume.md +94 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-automate/steps-c/step-02-identify-targets.md +169 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-automate/steps-c/step-03-generate-tests.md +394 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-automate/steps-c/step-03a-subagent-api.md +263 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-automate/steps-c/step-03b-subagent-backend.md +246 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-automate/steps-c/step-03b-subagent-e2e.md +213 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-automate/steps-c/step-03c-aggregate.md +393 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-automate/steps-c/step-04-validate-and-summarize.md +106 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-automate/steps-e/step-01-assess.md +65 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-automate/steps-e/step-02-apply-edit.md +60 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-automate/steps-v/step-01-validate.md +67 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-automate/validation-report-20260127-095021.md +72 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-automate/validation-report-20260127-102401.md +114 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-automate/workflow-plan.md +20 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-automate/workflow.md +41 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-automate/workflow.yaml +53 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-ci/SKILL.md +6 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-ci/azure-pipelines-template.yaml +155 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-ci/bmad-skill-manifest.yaml +1 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-ci/checklist.md +289 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-ci/github-actions-template.yaml +328 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-ci/gitlab-ci-template.yaml +158 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-ci/harness-pipeline-template.yaml +159 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-ci/instructions.md +45 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-ci/jenkins-pipeline-template.groovy +129 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-ci/steps-c/step-01-preflight.md +158 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-ci/steps-c/step-01b-resume.md +110 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-ci/steps-c/step-02-generate-pipeline.md +279 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-ci/steps-c/step-03-configure-quality-gates.md +135 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-ci/steps-c/step-04-validate-and-summary.md +92 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-ci/steps-e/step-01-assess.md +65 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-ci/steps-e/step-02-apply-edit.md +60 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-ci/steps-v/step-01-validate.md +81 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-ci/validation-report-20260127-095021.md +72 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-ci/validation-report-20260127-102401.md +114 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-ci/workflow-plan.md +20 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-ci/workflow.md +41 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-ci/workflow.yaml +48 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-framework/SKILL.md +6 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-framework/bmad-skill-manifest.yaml +1 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-framework/checklist.md +345 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-framework/instructions.md +45 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-framework/steps-c/step-01-preflight.md +132 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-framework/steps-c/step-01b-resume.md +116 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-framework/steps-c/step-02-select-framework.md +117 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-framework/steps-c/step-03-scaffold-framework.md +323 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-framework/steps-c/step-04-docs-and-scripts.md +105 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-framework/steps-c/step-05-validate-and-summary.md +93 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-framework/steps-e/step-01-assess.md +65 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-framework/steps-e/step-02-apply-edit.md +60 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-framework/steps-v/step-01-validate.md +67 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-framework/validation-report-20260127-095021.md +73 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-framework/validation-report-20260127-102401.md +116 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-framework/workflow-plan.md +22 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-framework/workflow.md +41 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-framework/workflow.yaml +48 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-nfr/SKILL.md +6 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-nfr/bmad-skill-manifest.yaml +1 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-nfr/checklist.md +407 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-nfr/instructions.md +43 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-nfr/nfr-report-template.md +470 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-nfr/steps-c/step-01-load-context.md +138 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-nfr/steps-c/step-01b-resume.md +106 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-nfr/steps-c/step-02-define-thresholds.md +107 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-nfr/steps-c/step-03-gather-evidence.md +108 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-nfr/steps-c/step-04-evaluate-and-score.md +254 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-nfr/steps-c/step-04a-subagent-security.md +138 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-nfr/steps-c/step-04b-subagent-performance.md +84 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-nfr/steps-c/step-04c-subagent-reliability.md +85 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-nfr/steps-c/step-04d-subagent-scalability.md +88 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-nfr/steps-c/step-04e-aggregate-nfr.md +264 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-nfr/steps-c/step-05-generate-report.md +108 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-nfr/steps-e/step-01-assess.md +65 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-nfr/steps-e/step-02-apply-edit.md +60 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-nfr/steps-v/step-01-validate.md +67 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-nfr/validation-report-20260127-095021.md +73 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-nfr/validation-report-20260127-102401.md +116 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-nfr/workflow-plan.md +19 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-nfr/workflow.md +41 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-nfr/workflow.yaml +48 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-test-design/SKILL.md +6 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-test-design/bmad-skill-manifest.yaml +1 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-test-design/checklist.md +464 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-test-design/instructions.md +105 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-test-design/steps-c/step-01-detect-mode.md +134 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-test-design/steps-c/step-01b-resume.md +102 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-test-design/steps-c/step-02-load-context.md +242 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-test-design/steps-c/step-03-risk-and-testability.md +110 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-test-design/steps-c/step-04-coverage-plan.md +123 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-test-design/steps-c/step-05-generate-output.md +222 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-test-design/steps-e/step-01-assess.md +65 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-test-design/steps-e/step-02-apply-edit.md +60 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-test-design/steps-v/step-01-validate.md +67 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-test-design/test-design-architecture-template.md +230 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-test-design/test-design-handoff-template.md +70 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-test-design/test-design-qa-template.md +396 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-test-design/test-design-template.md +344 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-test-design/validation-report-20260127-095021.md +73 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-test-design/validation-report-20260127-102401.md +116 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-test-design/workflow-plan.md +22 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-test-design/workflow.md +41 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-test-design/workflow.yaml +77 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-test-review/SKILL.md +6 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-test-review/bmad-skill-manifest.yaml +1 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-test-review/checklist.md +475 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-test-review/instructions.md +45 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-test-review/steps-c/step-01-load-context.md +197 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-test-review/steps-c/step-01b-resume.md +104 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-test-review/steps-c/step-02-discover-tests.md +113 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-test-review/steps-c/step-03-quality-evaluation.md +274 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-test-review/steps-c/step-03a-subagent-determinism.md +214 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-test-review/steps-c/step-03b-subagent-isolation.md +125 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-test-review/steps-c/step-03c-subagent-maintainability.md +102 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-test-review/steps-c/step-03e-subagent-performance.md +117 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-test-review/steps-c/step-03f-aggregate-scores.md +277 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-test-review/steps-c/step-04-generate-report.md +111 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-test-review/steps-e/step-01-assess.md +65 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-test-review/steps-e/step-02-apply-edit.md +60 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-test-review/steps-v/step-01-validate.md +67 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-test-review/test-review-template.md +387 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-test-review/validation-report-20260127-095021.md +72 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-test-review/validation-report-20260127-102401.md +114 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-test-review/workflow-plan.md +18 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-test-review/workflow.md +41 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-test-review/workflow.yaml +48 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-trace/SKILL.md +6 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-trace/bmad-skill-manifest.yaml +1 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-trace/checklist.md +647 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-trace/instructions.md +43 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-trace/steps-c/step-01-load-context.md +105 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-trace/steps-c/step-01b-resume.md +102 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-trace/steps-c/step-02-discover-tests.md +112 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-trace/steps-c/step-03-map-criteria.md +97 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-trace/steps-c/step-04-analyze-gaps.md +421 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-trace/steps-c/step-05-gate-decision.md +266 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-trace/steps-e/step-01-assess.md +65 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-trace/steps-e/step-02-apply-edit.md +60 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-trace/steps-v/step-01-validate.md +67 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-trace/trace-template.md +708 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-trace/validation-report-20260127-095021.md +73 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-trace/validation-report-20260127-102401.md +116 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-trace/workflow-plan.md +21 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-trace/workflow.md +41 -0
- package/lib/bmad-cache/tea/src/workflows/testarch/bmad-testarch-trace/workflow.yaml +56 -0
- package/lib/bmad-cache/tea/test/README.md +23 -0
- package/lib/bmad-cache/tea/test/fixtures/agent-schema/invalid/critical-actions/actions-as-string.agent.yaml +27 -0
- package/lib/bmad-cache/tea/test/fixtures/agent-schema/invalid/critical-actions/empty-string-in-actions.agent.yaml +30 -0
- package/lib/bmad-cache/tea/test/fixtures/agent-schema/invalid/menu/empty-menu.agent.yaml +22 -0
- package/lib/bmad-cache/tea/test/fixtures/agent-schema/invalid/menu/missing-menu.agent.yaml +20 -0
- package/lib/bmad-cache/tea/test/fixtures/agent-schema/invalid/menu-commands/empty-command-target.agent.yaml +25 -0
- package/lib/bmad-cache/tea/test/fixtures/agent-schema/invalid/menu-commands/no-command-target.agent.yaml +24 -0
- package/lib/bmad-cache/tea/test/fixtures/agent-schema/invalid/menu-triggers/camel-case.agent.yaml +25 -0
- package/lib/bmad-cache/tea/test/fixtures/agent-schema/invalid/menu-triggers/compound-invalid-format.agent.yaml +25 -0
- package/lib/bmad-cache/tea/test/fixtures/agent-schema/invalid/menu-triggers/compound-mismatched-kebab.agent.yaml +25 -0
- package/lib/bmad-cache/tea/test/fixtures/agent-schema/invalid/menu-triggers/duplicate-triggers.agent.yaml +31 -0
- package/lib/bmad-cache/tea/test/fixtures/agent-schema/invalid/menu-triggers/empty-trigger.agent.yaml +25 -0
- package/lib/bmad-cache/tea/test/fixtures/agent-schema/invalid/menu-triggers/leading-asterisk.agent.yaml +25 -0
- package/lib/bmad-cache/tea/test/fixtures/agent-schema/invalid/menu-triggers/snake-case.agent.yaml +25 -0
- package/lib/bmad-cache/tea/test/fixtures/agent-schema/invalid/menu-triggers/trigger-with-spaces.agent.yaml +25 -0
- package/lib/bmad-cache/tea/test/fixtures/agent-schema/invalid/metadata/empty-module-string.agent.yaml +26 -0
- package/lib/bmad-cache/tea/test/fixtures/agent-schema/invalid/metadata/empty-name.agent.yaml +24 -0
- package/lib/bmad-cache/tea/test/fixtures/agent-schema/invalid/metadata/extra-metadata-fields.agent.yaml +27 -0
- package/lib/bmad-cache/tea/test/fixtures/agent-schema/invalid/metadata/missing-id.agent.yaml +23 -0
- package/lib/bmad-cache/tea/test/fixtures/agent-schema/invalid/persona/empty-principles-array.agent.yaml +24 -0
- package/lib/bmad-cache/tea/test/fixtures/agent-schema/invalid/persona/empty-string-in-principles.agent.yaml +27 -0
- package/lib/bmad-cache/tea/test/fixtures/agent-schema/invalid/persona/extra-persona-fields.agent.yaml +27 -0
- package/lib/bmad-cache/tea/test/fixtures/agent-schema/invalid/persona/missing-role.agent.yaml +24 -0
- package/lib/bmad-cache/tea/test/fixtures/agent-schema/invalid/prompts/empty-content.agent.yaml +29 -0
- package/lib/bmad-cache/tea/test/fixtures/agent-schema/invalid/prompts/extra-prompt-fields.agent.yaml +31 -0
- package/lib/bmad-cache/tea/test/fixtures/agent-schema/invalid/prompts/missing-content.agent.yaml +28 -0
- package/lib/bmad-cache/tea/test/fixtures/agent-schema/invalid/prompts/missing-id.agent.yaml +28 -0
- package/lib/bmad-cache/tea/test/fixtures/agent-schema/invalid/top-level/empty-file.agent.yaml +5 -0
- package/lib/bmad-cache/tea/test/fixtures/agent-schema/invalid/top-level/extra-top-level-keys.agent.yaml +28 -0
- package/lib/bmad-cache/tea/test/fixtures/agent-schema/invalid/top-level/missing-agent-key.agent.yaml +11 -0
- package/lib/bmad-cache/tea/test/fixtures/agent-schema/invalid/yaml-errors/invalid-indentation.agent.yaml +19 -0
- package/lib/bmad-cache/tea/test/fixtures/agent-schema/invalid/yaml-errors/malformed-yaml.agent.yaml +18 -0
- package/lib/bmad-cache/tea/test/fixtures/agent-schema/valid/critical-actions/empty-critical-actions.agent.yaml +24 -0
- package/lib/bmad-cache/tea/test/fixtures/agent-schema/valid/critical-actions/no-critical-actions.agent.yaml +22 -0
- package/lib/bmad-cache/tea/test/fixtures/agent-schema/valid/critical-actions/valid-critical-actions.agent.yaml +27 -0
- package/lib/bmad-cache/tea/test/fixtures/agent-schema/valid/menu/multiple-menu-items.agent.yaml +31 -0
- package/lib/bmad-cache/tea/test/fixtures/agent-schema/valid/menu/single-menu-item.agent.yaml +22 -0
- package/lib/bmad-cache/tea/test/fixtures/agent-schema/valid/menu-commands/all-command-types.agent.yaml +38 -0
- package/lib/bmad-cache/tea/test/fixtures/agent-schema/valid/menu-commands/multiple-commands.agent.yaml +24 -0
- package/lib/bmad-cache/tea/test/fixtures/agent-schema/valid/menu-triggers/compound-triggers.agent.yaml +31 -0
- package/lib/bmad-cache/tea/test/fixtures/agent-schema/valid/menu-triggers/kebab-case-triggers.agent.yaml +34 -0
- package/lib/bmad-cache/tea/test/fixtures/agent-schema/valid/metadata/core-agent-with-module.agent.yaml +24 -0
- package/lib/bmad-cache/tea/test/fixtures/agent-schema/valid/metadata/empty-module-name-in-path.agent.yaml +24 -0
- package/lib/bmad-cache/tea/test/fixtures/agent-schema/valid/metadata/malformed-path-treated-as-core.agent.yaml +24 -0
- package/lib/bmad-cache/tea/test/fixtures/agent-schema/valid/metadata/module-agent-correct.agent.yaml +24 -0
- package/lib/bmad-cache/tea/test/fixtures/agent-schema/valid/metadata/module-agent-missing-module.agent.yaml +23 -0
- package/lib/bmad-cache/tea/test/fixtures/agent-schema/valid/metadata/wrong-module-value.agent.yaml +24 -0
- package/lib/bmad-cache/tea/test/fixtures/agent-schema/valid/persona/complete-persona.agent.yaml +24 -0
- package/lib/bmad-cache/tea/test/fixtures/agent-schema/valid/prompts/empty-prompts.agent.yaml +24 -0
- package/lib/bmad-cache/tea/test/fixtures/agent-schema/valid/prompts/no-prompts.agent.yaml +22 -0
- package/lib/bmad-cache/tea/test/fixtures/agent-schema/valid/prompts/valid-prompts-minimal.agent.yaml +28 -0
- package/lib/bmad-cache/tea/test/fixtures/agent-schema/valid/prompts/valid-prompts-with-description.agent.yaml +30 -0
- package/lib/bmad-cache/tea/test/fixtures/agent-schema/valid/top-level/minimal-core-agent.agent.yaml +24 -0
- package/lib/bmad-cache/tea/test/schema/agent.js +491 -0
- package/lib/bmad-cache/tea/test/test-agent-schema.js +387 -0
- package/lib/bmad-cache/tea/test/test-installation-components.js +214 -0
- package/lib/bmad-cache/tea/test/test-knowledge-base.js +208 -0
- package/lib/bmad-cache/tea/test/unit-test-schema.js +133 -0
- package/lib/bmad-cache/tea/test/validate-agent-schema.js +110 -0
- package/lib/bmad-cache/tea/tools/build-docs.js +575 -0
- package/lib/bmad-cache/tea/tools/fix-doc-links.js +288 -0
- package/lib/bmad-cache/tea/tools/schema/agent.js +491 -0
- package/lib/bmad-cache/tea/tools/validate-agent-schema.js +111 -0
- package/lib/bmad-cache/tea/tools/validate-doc-links.js +371 -0
- package/lib/bmad-cache/tea/tools/validate-tea-workflow-descriptions.js +122 -0
- package/lib/bmad-cache/tea/tools/verify-paths.js +100 -0
- package/lib/bmad-cache/tea/website/README.md +137 -0
- package/lib/bmad-cache/tea/website/astro.config.mjs +179 -0
- package/lib/bmad-cache/tea/website/package-lock.json +6856 -0
- package/lib/bmad-cache/tea/website/package.json +24 -0
- package/lib/bmad-cache/tea/website/public/favicon.ico +0 -0
- package/lib/bmad-cache/tea/website/public/img/tea-logo.svg +7 -0
- package/lib/bmad-cache/tea/website/public/robots.txt +37 -0
- package/lib/bmad-cache/tea/website/src/components/Banner.astro +59 -0
- package/lib/bmad-cache/tea/website/src/components/Header.astro +121 -0
- package/lib/bmad-cache/tea/website/src/components/MobileMenuFooter.astro +53 -0
- package/lib/bmad-cache/tea/website/src/content/config.ts +6 -0
- package/lib/bmad-cache/tea/website/src/content/docs +1 -0
- package/lib/bmad-cache/tea/website/src/lib/site-url.js +25 -0
- package/lib/bmad-cache/tea/website/src/pages/404.astro +11 -0
- package/lib/bmad-cache/tea/website/src/rehype-base-paths.js +89 -0
- package/lib/bmad-cache/tea/website/src/rehype-markdown-links.js +117 -0
- package/lib/bmad-cache/tea/website/src/styles/custom.css +499 -0
- package/lib/bmad-cache/tea/website/tsconfig.json +9 -0
- package/lib/bmad.js +76 -10
- package/lib/installer.js +23 -1
- package/package.json +4 -2
- package/scripts/build-bmad-cache.js +288 -0
- package/test/yes-flag.test.js +193 -0
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: C++ Safety-First Concurrency
|
|
3
|
+
description: Enforce safe multi-threading patterns using RAII locking and task-based parallelism (C++14+).
|
|
4
|
+
---
|
|
5
|
+
# C++ Safety-First Concurrency (Core Guidelines Section CP)
|
|
6
|
+
|
|
7
|
+
This skill prevents common multi-threading defects like data races, deadlocks, and shared-state corruption.
|
|
8
|
+
|
|
9
|
+
## Policies
|
|
10
|
+
|
|
11
|
+
### 1. RAII Locking Only
|
|
12
|
+
* **Rule**: Never call `mutex.lock()` or `mutex.unlock()` manually.
|
|
13
|
+
* **Action**:
|
|
14
|
+
- Use `std::lock_guard` for single mutexes.
|
|
15
|
+
- Use `std::unique_lock` if you need deferred locking or condition variables.
|
|
16
|
+
- Use `std::scoped_lock` (C++17) for multiple mutexes to avoid deadlocks.
|
|
17
|
+
* **Rationale**: Ensures locks are released even if an exception is thrown.
|
|
18
|
+
|
|
19
|
+
### 2. Task-Based Parallelism
|
|
20
|
+
* **Rule**: Prefer tasks (`std::async`, `std::packaged_task`, `std::future`) over raw threads (`std::thread`).
|
|
21
|
+
* **Action**: Use `auto result = std::async(std::launch::async, func, args...);`
|
|
22
|
+
* **Rationale**: Automates thread management and handles value return/exception propagation naturally.
|
|
23
|
+
|
|
24
|
+
### 3. Minimize Shared Mutable State
|
|
25
|
+
* **Rule**: Data should ideally be either "Thread-Local" or "Read-Only".
|
|
26
|
+
* **Action**:
|
|
27
|
+
- Pass data to threads by value where possible.
|
|
28
|
+
- Use `const` for data shared between threads.
|
|
29
|
+
- Group mutexes with the data they protect (e.g., in a struct).
|
|
30
|
+
* **Rationale**: If data isn't shared or isn't mutable, it cannot have a race condition.
|
|
31
|
+
|
|
32
|
+
### 4. Never Sleep/Wait without a Condition
|
|
33
|
+
* **Rule**: Avoid `std::this_thread::sleep_for` for synchronization.
|
|
34
|
+
* **Action**: Use `std::condition_variable` with a predicate to wait for work.
|
|
35
|
+
* **Rationale**: Sleeping is inefficient and bug-prone; condition variables are precise and responsive.
|
|
36
|
+
|
|
37
|
+
## Examples
|
|
38
|
+
|
|
39
|
+
### Before (Dangerous Concurrency)
|
|
40
|
+
```cpp
|
|
41
|
+
std::mutex mtx;
|
|
42
|
+
int sharedData = 0;
|
|
43
|
+
|
|
44
|
+
void worker() {
|
|
45
|
+
mtx.lock();
|
|
46
|
+
sharedData++;
|
|
47
|
+
mtx.unlock(); // What if an exception happened above?
|
|
48
|
+
}
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
### After (Safe Concurrency)
|
|
52
|
+
```cpp
|
|
53
|
+
std::mutex mtx;
|
|
54
|
+
int sharedData = 0;
|
|
55
|
+
|
|
56
|
+
void worker() {
|
|
57
|
+
std::lock_guard<std::mutex> lock(mtx);
|
|
58
|
+
sharedData++;
|
|
59
|
+
} // Lock automatically released here
|
|
60
|
+
```
|
|
@@ -0,0 +1,73 @@
|
|
|
1
|
+
# Concurrency Safety Examples (C++14+)
|
|
2
|
+
|
|
3
|
+
### 1. Task-Based Parallelism (Async)
|
|
4
|
+
Avoids manual thread joining and handles return values safely.
|
|
5
|
+
|
|
6
|
+
```cpp
|
|
7
|
+
#include <future>
|
|
8
|
+
#include <vector>
|
|
9
|
+
#include <numeric>
|
|
10
|
+
|
|
11
|
+
int computeLargeSum(const std::vector<int>& data) {
|
|
12
|
+
auto part1 = std::async(std::launch::async, [&data]() {
|
|
13
|
+
return std::accumulate(data.begin(), data.begin() + data.size()/2, 0);
|
|
14
|
+
});
|
|
15
|
+
|
|
16
|
+
auto part2 = std::accumulate(data.begin() + data.size()/2, data.end(), 0);
|
|
17
|
+
|
|
18
|
+
return part1.get() + part2;
|
|
19
|
+
}
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
### 2. Multi-Lock Safety (C++17 scoped_lock)
|
|
23
|
+
Prevents deadlocks when acquiring multiple resources.
|
|
24
|
+
|
|
25
|
+
```cpp
|
|
26
|
+
#include <mutex>
|
|
27
|
+
|
|
28
|
+
struct Account {
|
|
29
|
+
std::mutex mtx;
|
|
30
|
+
double balance;
|
|
31
|
+
};
|
|
32
|
+
|
|
33
|
+
void transfer(Account& from, Account& to, double amount) {
|
|
34
|
+
// Acquire both locks simultaneously in a deadlock-free manner
|
|
35
|
+
std::scoped_lock lock(from.mtx, to.mtx);
|
|
36
|
+
|
|
37
|
+
if (from.balance >= amount) {
|
|
38
|
+
from.balance -= amount;
|
|
39
|
+
to.balance += amount;
|
|
40
|
+
}
|
|
41
|
+
}
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
### 3. Condition Variables with Predicates
|
|
45
|
+
Always use a predicate to protect against "spurious wakeups."
|
|
46
|
+
|
|
47
|
+
```cpp
|
|
48
|
+
#include <mutex>
|
|
49
|
+
#include <condition_variable>
|
|
50
|
+
#include <queue>
|
|
51
|
+
|
|
52
|
+
std::queue<int> workQueue;
|
|
53
|
+
std::mutex workMtx;
|
|
54
|
+
std::condition_variable workCv;
|
|
55
|
+
bool finished = false;
|
|
56
|
+
|
|
57
|
+
void consumer() {
|
|
58
|
+
while (true) {
|
|
59
|
+
std::unique_lock<std::mutex> lock(workMtx);
|
|
60
|
+
|
|
61
|
+
// Wait until there is work OR we are finished
|
|
62
|
+
workCv.wait(lock, []{ return !workQueue.empty() || finished; });
|
|
63
|
+
|
|
64
|
+
if (workQueue.empty() && finished) break;
|
|
65
|
+
|
|
66
|
+
int task = workQueue.front();
|
|
67
|
+
workQueue.pop();
|
|
68
|
+
lock.unlock(); // Release lock before processing
|
|
69
|
+
|
|
70
|
+
process(task);
|
|
71
|
+
}
|
|
72
|
+
}
|
|
73
|
+
```
|
|
@@ -0,0 +1,63 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: C++ Const-Correctness & Logic
|
|
3
|
+
description: Enforce immutability-by-default and push logic to compile-time using constexpr (C++14+).
|
|
4
|
+
---
|
|
5
|
+
# C++ Const-Correctness & Logic (Core Guidelines Section Con & ES)
|
|
6
|
+
|
|
7
|
+
This skill ensures that C++ code is "immutable by default," reducing side effects and enabling better compiler optimizations.
|
|
8
|
+
|
|
9
|
+
## Policies
|
|
10
|
+
|
|
11
|
+
### 1. By Default, Make Objects Immutable
|
|
12
|
+
* **Rule**: Declare all variables `const` unless they *must* be modified.
|
|
13
|
+
* **Action**:
|
|
14
|
+
- Use `const auto x = ...;` instead of `auto x = ...;`.
|
|
15
|
+
- Use `const` for function results that won't be modified.
|
|
16
|
+
* **Rationale**: Prevents accidental state mutation and improves code reasoning.
|
|
17
|
+
|
|
18
|
+
### 2. Const Member Functions
|
|
19
|
+
* **Rule**: Any member function that does not modify the object's observable state must be `const`.
|
|
20
|
+
* **Action**: Append `const` to the function signature: `T getValue() const { ... }`.
|
|
21
|
+
* **Rationale**: Necessary for calling functions on `const` objects and `const&` parameters.
|
|
22
|
+
|
|
23
|
+
### 3. Compute at Compile-Time (`constexpr`)
|
|
24
|
+
* **Rule**: Prefer `constexpr` for any value or simple logic that *can* be computed at compile-time.
|
|
25
|
+
* **Action**:
|
|
26
|
+
- Use `constexpr` for constants.
|
|
27
|
+
- Declare mathematical or configuration functions as `constexpr` (C++14 allows complex logic in `constexpr`).
|
|
28
|
+
* **Rationale**: Moves work from runtime to compile-time, reducing binary size and execution time.
|
|
29
|
+
|
|
30
|
+
### 4. Consistent Parameter Logic
|
|
31
|
+
* **Rule**: Avoid passing by value for large types; avoid passing by non-const reference unless it's an "out" or "in-out" parameter.
|
|
32
|
+
* **Action**:
|
|
33
|
+
- **In parameters**: Pass cheap types (int, double, pointers, `string_view`) by value. Pass large types by `const&`.
|
|
34
|
+
- **Out/In-out parameters**: Pass by `T&`.
|
|
35
|
+
- **Sinks**: Pass by `T&&` (rvalue reference).
|
|
36
|
+
|
|
37
|
+
## Examples
|
|
38
|
+
|
|
39
|
+
### Before (Mutable/Runtime Logic)
|
|
40
|
+
```cpp
|
|
41
|
+
int getMultiplier(int x) {
|
|
42
|
+
return x * 10;
|
|
43
|
+
}
|
|
44
|
+
|
|
45
|
+
void process() {
|
|
46
|
+
auto data = loadData();
|
|
47
|
+
auto mult = getMultiplier(5); // mutable by accident
|
|
48
|
+
data.apply(mult);
|
|
49
|
+
}
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
### After (Const/Compile-time Logic)
|
|
53
|
+
```cpp
|
|
54
|
+
constexpr int getMultiplier(int x) {
|
|
55
|
+
return x * 10;
|
|
56
|
+
}
|
|
57
|
+
|
|
58
|
+
void process() {
|
|
59
|
+
const auto data = loadData(); // data won't change
|
|
60
|
+
constexpr auto mult = getMultiplier(5); // computed at compile time
|
|
61
|
+
data.apply(mult);
|
|
62
|
+
}
|
|
63
|
+
```
|
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
# Const-Correctness Examples (C++14+)
|
|
2
|
+
|
|
3
|
+
### 1. Complex Const Initialization (Lambda)
|
|
4
|
+
Sometimes you need to conditionally initialize a variable, but you want it to be `const` afterward.
|
|
5
|
+
|
|
6
|
+
**Modern (C++14):**
|
|
7
|
+
```cpp
|
|
8
|
+
const auto path = []() {
|
|
9
|
+
if (auto env = std::getenv("APP_PATH")) {
|
|
10
|
+
return std::string(env);
|
|
11
|
+
}
|
|
12
|
+
return std::string("/default/path");
|
|
13
|
+
}(); // Immediately invoked lambda
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
### 2. Const-Correct Member Functions
|
|
17
|
+
Ensure getters and inspectors are `const`.
|
|
18
|
+
|
|
19
|
+
```cpp
|
|
20
|
+
class Config {
|
|
21
|
+
int timeout = 30;
|
|
22
|
+
public:
|
|
23
|
+
// This is an inspector, must be const
|
|
24
|
+
int getTimeout() const { return timeout; }
|
|
25
|
+
|
|
26
|
+
// This is a mutator, cannot be const
|
|
27
|
+
void setTimeout(int t) { timeout = t; }
|
|
28
|
+
};
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
### 3. C++14 constexpr Logic
|
|
32
|
+
C++14 expanded `constexpr` significantly (loops, branches allowed).
|
|
33
|
+
|
|
34
|
+
```cpp
|
|
35
|
+
constexpr int fibonacci(int n) {
|
|
36
|
+
if (n <= 1) return n;
|
|
37
|
+
int a = 0, b = 1;
|
|
38
|
+
for (int i = 2; i <= n; ++i) {
|
|
39
|
+
int next = a + b;
|
|
40
|
+
a = b;
|
|
41
|
+
b = next;
|
|
42
|
+
}
|
|
43
|
+
return b;
|
|
44
|
+
}
|
|
45
|
+
|
|
46
|
+
// Result is computed by the compiler
|
|
47
|
+
constexpr int fib10 = fibonacci(10);
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
### 4. Parameter Passing Guide
|
|
51
|
+
- `void f(int)` : Fast to copy (Value)
|
|
52
|
+
- `void f(const LargeObject&)` : Expensive to copy (Const Ref)
|
|
53
|
+
- `void f(LargeObject&)` : I will modify this (Ref)
|
|
54
|
+
- `void f(LargeObject&&)` : I will MOVE/OWN this (Rvalue Ref)
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: C++ Safe Memory Handling
|
|
3
|
+
description: Enforces Modern C++ practices (RAII, Smart Pointers) to prevent memory leaks, dangling pointers, and buffer overflows.
|
|
4
|
+
---
|
|
5
|
+
# C++ Safe Memory Handling
|
|
6
|
+
|
|
7
|
+
Guidelines for writing robust, memory-safe C++ code by leveraging Modern C++ features and RAII principles.
|
|
8
|
+
|
|
9
|
+
## Mandatory Policies
|
|
10
|
+
|
|
11
|
+
### 1. Smart Pointers by Default
|
|
12
|
+
You MUST use smart pointers for all heap allocations.
|
|
13
|
+
- Use `std::unique_ptr` for exclusive ownership. This is the preferred default.
|
|
14
|
+
- Use `std::shared_ptr` only when multiple objects share ownership of a resource.
|
|
15
|
+
- Use `std::weak_ptr` to break circular dependencies or for non-owning references that must be checked for validity.
|
|
16
|
+
|
|
17
|
+
### 2. Forbid raw new/delete
|
|
18
|
+
You MUST NOT use raw `new` and `delete` operators.
|
|
19
|
+
- Use `std::make_unique` (C++14+) or `std::make_shared` to allocate objects on the heap.
|
|
20
|
+
- Exceptions are only allowed within low-level custom container implementations, which must be encapsulated.
|
|
21
|
+
|
|
22
|
+
### 3. Prefer Value Semantics
|
|
23
|
+
Always prefer stack-allocated objects and value semantics over pointer-based indirection unless heap allocation is strictly necessary (e.g., polymorphism, very large objects, or dynamic lifetimes).
|
|
24
|
+
|
|
25
|
+
### 4. RAII for All Resources
|
|
26
|
+
Every resource (file handles, sockets, mutexes, memory) MUST be managed by an object whose constructor acquires the resource and destructor releases it. Never rely on manual cleanup blocks.
|
|
27
|
+
|
|
28
|
+
### 5. Standard Containers
|
|
29
|
+
NEVER use raw buffers or manually managed arrays.
|
|
30
|
+
- Use `std::vector` for dynamic arrays.
|
|
31
|
+
- Use `std::string` for text.
|
|
32
|
+
- Use `std::array` (C++11) for fixed-size stack arrays.
|
|
33
|
+
- Access elements using `.at()` if bounds checking is required for security-critical logic.
|
|
34
|
+
|
|
35
|
+
## Critical Rules
|
|
36
|
+
- **No Dangling Pointers**: Never return a pointer or reference to a local stack-allocated variable.
|
|
37
|
+
- **Rule of Zero/Five**: Follow the "Rule of Zero" (prefer components that handle their own resource management). If manual management is needed, correctly implement the "Rule of Five".
|
|
38
|
+
- **Nullable Checks**: Always check pointers (even smart ones) for `nullptr` before dereferencing if there is any chance they could be empty.
|
|
39
|
+
|
|
40
|
+
## Resources
|
|
41
|
+
- [Modern C++ Examples](file:///skills/cpp-memory-handling/examples/modern-cpp.md)
|
|
42
|
+
- [Smart Pointer Reference](file:///skills/cpp-memory-handling/examples/smart-pointers.md)
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
# Modern C++ Safe Memory Examples
|
|
2
|
+
|
|
3
|
+
Demonstrating RAII and safe resource management in modern C++.
|
|
4
|
+
|
|
5
|
+
## RAII Resource Management
|
|
6
|
+
|
|
7
|
+
```cpp
|
|
8
|
+
#include <iostream>
|
|
9
|
+
#include <fstream>
|
|
10
|
+
#include <vector>
|
|
11
|
+
#include <memory>
|
|
12
|
+
|
|
13
|
+
class FileHandler {
|
|
14
|
+
public:
|
|
15
|
+
FileHandler(const std::string& filename) : file(filename) {
|
|
16
|
+
if (!file.is_open()) throw std::runtime_error("Could not open file");
|
|
17
|
+
}
|
|
18
|
+
// Destructor automatically closes the file
|
|
19
|
+
~FileHandler() { if (file.is_open()) file.close(); }
|
|
20
|
+
|
|
21
|
+
void write(const std::string& data) { file << data; }
|
|
22
|
+
|
|
23
|
+
private:
|
|
24
|
+
std::ofstream file;
|
|
25
|
+
};
|
|
26
|
+
|
|
27
|
+
void log_data(const std::string& message) {
|
|
28
|
+
// RAII handles lifetime. No manual close needed.
|
|
29
|
+
FileHandler handler("app.log");
|
|
30
|
+
handler.write(message);
|
|
31
|
+
}
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
## Vector vs Raw Arrays
|
|
35
|
+
|
|
36
|
+
```cpp
|
|
37
|
+
// BAD: Manual memory management
|
|
38
|
+
void bad_array() {
|
|
39
|
+
int* arr = new int[100];
|
|
40
|
+
// ... logic ...
|
|
41
|
+
delete[] arr; // Manual cleanup is error-prone
|
|
42
|
+
}
|
|
43
|
+
|
|
44
|
+
// GOOD: Automatic memory management
|
|
45
|
+
void safe_vector() {
|
|
46
|
+
std::vector<int> arr(100);
|
|
47
|
+
// Vector manages its own heap memory. RAII cleans up at scope exit.
|
|
48
|
+
}
|
|
49
|
+
```
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
# C++ Smart Pointer Reference
|
|
2
|
+
|
|
3
|
+
Guidelines for selecting and using smart pointers correctly.
|
|
4
|
+
|
|
5
|
+
## unique_ptr (Preferred Default)
|
|
6
|
+
- Represents **exclusive ownership**.
|
|
7
|
+
- Zero runtime overhead compared to raw pointers.
|
|
8
|
+
|
|
9
|
+
```cpp
|
|
10
|
+
#include <memory>
|
|
11
|
+
|
|
12
|
+
class Widget { /* ... */ };
|
|
13
|
+
|
|
14
|
+
void exclusive_use() {
|
|
15
|
+
// Use make_unique for safety and efficiency
|
|
16
|
+
auto widget = std::make_unique<Widget>();
|
|
17
|
+
|
|
18
|
+
// Ownership can be moved but not copied
|
|
19
|
+
std::unique_ptr<Widget> other = std::move(widget);
|
|
20
|
+
}
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
## shared_ptr (For Shared Ownership)
|
|
24
|
+
- Use only when **multiple** owners truly exist.
|
|
25
|
+
- Reference counting has small overhead.
|
|
26
|
+
|
|
27
|
+
```cpp
|
|
28
|
+
void shared_use() {
|
|
29
|
+
auto shared_widget = std::make_shared<Widget>();
|
|
30
|
+
|
|
31
|
+
auto owner1 = shared_widget; // Count = 2
|
|
32
|
+
auto owner2 = shared_widget; // Count = 3
|
|
33
|
+
}
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
## weak_ptr (Breaking Cycles)
|
|
37
|
+
- Non-owning reference. Must be locked before use.
|
|
38
|
+
|
|
39
|
+
```cpp
|
|
40
|
+
void weak_use(std::weak_ptr<Widget> weak_widget) {
|
|
41
|
+
if (auto shared = weak_widget.lock()) {
|
|
42
|
+
// Resource is still alive
|
|
43
|
+
shared->do_something();
|
|
44
|
+
}
|
|
45
|
+
}
|
|
46
|
+
```
|
|
@@ -0,0 +1,64 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: C++ Modern Composition
|
|
3
|
+
description: Replace legacy C patterns with STL, Ranges, and modern C++ abstractions (C++14+).
|
|
4
|
+
---
|
|
5
|
+
# C++ Modern Composition (Core Guidelines Section STL, CPL, ES)
|
|
6
|
+
|
|
7
|
+
This skill forces the transition from legacy "C-style" C++ to modern, declarative, and safer C++ idioms.
|
|
8
|
+
|
|
9
|
+
## Policies
|
|
10
|
+
|
|
11
|
+
### 1. STL Algorithms over Manual Loops
|
|
12
|
+
* **Rule**: Never write a raw `for` or `while` loop for operations supported by `<algorithm>` or `<numeric>`.
|
|
13
|
+
* **Action**:
|
|
14
|
+
- Use `std::any_of`, `std::all_of`, `std::find_if`, `std::transform`, `std::accumulate`.
|
|
15
|
+
- In C++20 projects, prefer `std::ranges` versions.
|
|
16
|
+
* **Rationale**: Reduces "off-by-one" errors and improves intent readability.
|
|
17
|
+
|
|
18
|
+
### 2. Eradicate C-style Casts and Macros
|
|
19
|
+
* **Rule**: Ban `(type)value` and `#define` for logic/constants.
|
|
20
|
+
* **Action**:
|
|
21
|
+
- Use `static_cast`, `reinterpret_cast`, or `const_cast`.
|
|
22
|
+
- Replace macros with `constexpr` variables or `inline` functions/templates.
|
|
23
|
+
* **Rationale**: Named casts are searchable and safer; `constexpr` respects namespaces and scopes.
|
|
24
|
+
|
|
25
|
+
### 3. Universal Initialization
|
|
26
|
+
* **Rule**: Prefer `{}` initialization to avoid the "Most Vexing Parse".
|
|
27
|
+
* **Action**: Use `auto x = Type{args...};` or `Type x{args...};`.
|
|
28
|
+
* **Rationale**: Prevents narrowing conversions (e.g., `int x{3.5}` is a compiler error, while `int x = 3.5` is not).
|
|
29
|
+
|
|
30
|
+
### 4. Zero Raw Memory Manipulation
|
|
31
|
+
* **Rule**: Ban `memset`, `memcpy`, and `malloc`.
|
|
32
|
+
* **Action**:
|
|
33
|
+
- Use `std::fill`, `std::copy`, or `container.assign()`.
|
|
34
|
+
- Use `std::vector` or `std::array` instead of raw arrays.
|
|
35
|
+
* **Rationale**: Standard containers are bounds-checked (via `.at()`) and manage their own memory.
|
|
36
|
+
|
|
37
|
+
## Examples
|
|
38
|
+
|
|
39
|
+
### Before (C-style C++)
|
|
40
|
+
```cpp
|
|
41
|
+
#define MAX_BUFFER 1024
|
|
42
|
+
int arr[MAX_BUFFER];
|
|
43
|
+
memset(arr, 0, sizeof(arr));
|
|
44
|
+
|
|
45
|
+
bool found = false;
|
|
46
|
+
for (int i = 0; i < MAX_BUFFER; ++i) {
|
|
47
|
+
if (arr[i] == (int)someFloat) {
|
|
48
|
+
found = true;
|
|
49
|
+
break;
|
|
50
|
+
}
|
|
51
|
+
}
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
### After (Modern C++)
|
|
55
|
+
```cpp
|
|
56
|
+
constexpr size_t MaxBuffer = 1024;
|
|
57
|
+
std::array<int, MaxBuffer> arr;
|
|
58
|
+
arr.fill(0);
|
|
59
|
+
|
|
60
|
+
auto target = static_cast<int>(someFloat);
|
|
61
|
+
bool found = std::any_of(arr.begin(), arr.end(), [target](int v) {
|
|
62
|
+
return v == target;
|
|
63
|
+
});
|
|
64
|
+
```
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
# Modern Composition Examples (C++14+)
|
|
2
|
+
|
|
3
|
+
### 1. Data Transformation (Transform)
|
|
4
|
+
**Legacy:**
|
|
5
|
+
```cpp
|
|
6
|
+
std::vector<int> inputs = {1, 2, 3};
|
|
7
|
+
std::vector<int> outputs;
|
|
8
|
+
for (size_t i = 0; i < inputs.size(); ++i) {
|
|
9
|
+
outputs.push_back(inputs[i] * 2);
|
|
10
|
+
}
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
**Modern (C++14):**
|
|
14
|
+
```cpp
|
|
15
|
+
std::vector<int> inputs = {1, 2, 3};
|
|
16
|
+
std::vector<int> outputs;
|
|
17
|
+
outputs.reserve(inputs.size());
|
|
18
|
+
std::transform(inputs.begin(), inputs.end(), std::back_inserter(outputs),
|
|
19
|
+
[](int n) { return n * 2; });
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
### 2. Summation and Reduction (Accumulate)
|
|
23
|
+
**Modern (C++14):**
|
|
24
|
+
```cpp
|
|
25
|
+
#include <numeric>
|
|
26
|
+
|
|
27
|
+
std::vector<double> prices = {10.5, 20.0, 5.25};
|
|
28
|
+
double total = std::accumulate(prices.begin(), prices.end(), 0.0);
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
### 3. Safe Narrowing Protection
|
|
32
|
+
**Logic:**
|
|
33
|
+
```cpp
|
|
34
|
+
double d = 7.9;
|
|
35
|
+
// int i{d}; // Error: narrowing conversion from 'double' to 'int'
|
|
36
|
+
int i = static_cast<int>(d); // Explicit and safe
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
### 4. Replacing Function Macros
|
|
40
|
+
**Legacy:**
|
|
41
|
+
```cpp
|
|
42
|
+
#define SQUARE(x) ((x)*(x))
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
**Modern (C++14):**
|
|
46
|
+
```cpp
|
|
47
|
+
template<typename T>
|
|
48
|
+
constexpr T square(T t) {
|
|
49
|
+
return t * t;
|
|
50
|
+
}
|
|
51
|
+
```
|
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: C++ Robust Interfaces
|
|
3
|
+
description: Enforce contract-based design and strong typing in C++ interfaces (C++14+).
|
|
4
|
+
---
|
|
5
|
+
# C++ Robust Interfaces (Core Guidelines Section I & E)
|
|
6
|
+
|
|
7
|
+
This skill ensures that C++ interfaces follow contract-based design principles to improve safety, clarity, and maintainability.
|
|
8
|
+
|
|
9
|
+
## Policies
|
|
10
|
+
|
|
11
|
+
### 1. Make Interfaces Explicit
|
|
12
|
+
* **Rule**: Functions must explicitly state their requirements (pre-conditions) and guarantees (post-conditions).
|
|
13
|
+
* **Action**: Use `Expects()` and `Ensures()` (from GSL) or standardized comments if GSL is unavailable.
|
|
14
|
+
* **Rationale**: Detects integration bugs at the call site rather than deep in the implementation.
|
|
15
|
+
|
|
16
|
+
### 2. Strong Typing over Primitive Types
|
|
17
|
+
* **Rule**: Avoid "Boolean Blindness" and `void*`.
|
|
18
|
+
* **Action**:
|
|
19
|
+
- Use `enum class` for options instead of `bool`.
|
|
20
|
+
- Use `std::chrono` for time instead of `int`.
|
|
21
|
+
- Use specific types/structs instead of a long list of primitive arguments.
|
|
22
|
+
|
|
23
|
+
### 3. Clear Ownership and Lifetime
|
|
24
|
+
* **Rule**: A raw pointer (`T*`) in an interface **must never** represent ownership.
|
|
25
|
+
* **Action**:
|
|
26
|
+
- Use `gsl::not_null<T*>` for pointers that cannot be null.
|
|
27
|
+
- Use `std::unique_ptr` or `std::shared_ptr` ONLY if the function is participating in ownership/lifetime management.
|
|
28
|
+
- Prefer `T&` for arguments that must exist and aren't owned by the callee.
|
|
29
|
+
|
|
30
|
+
### 4. Sequence Safety
|
|
31
|
+
* **Rule**: Never pass an array as a raw pointer + size.
|
|
32
|
+
* **Action**:
|
|
33
|
+
- Use `gsl::span<T>` (C++14/17 via GSL) or `std::span<T>` (C++20).
|
|
34
|
+
- Use `std::string_view` for read-only strings.
|
|
35
|
+
|
|
36
|
+
## Examples
|
|
37
|
+
|
|
38
|
+
### Before (Fragile Interface)
|
|
39
|
+
```cpp
|
|
40
|
+
// What does 'flag' mean? Is data allowed to be null? Is it an array?
|
|
41
|
+
void processData(char* data, int size, bool flag);
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
### After (Robust Interface)
|
|
45
|
+
```cpp
|
|
46
|
+
#include <gsl/gsl>
|
|
47
|
+
|
|
48
|
+
enum class ProcessingMode { Fast, Thorough };
|
|
49
|
+
|
|
50
|
+
// Explicit contract: data must not be null, size is handled by span
|
|
51
|
+
void processData(gsl::span<const char> data, ProcessingMode mode) {
|
|
52
|
+
Expects(!data.empty());
|
|
53
|
+
// ...
|
|
54
|
+
}
|
|
55
|
+
```
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
# Robust Interface Examples (C++14+)
|
|
2
|
+
|
|
3
|
+
### 1. Avoiding Boolean Blindness
|
|
4
|
+
**Incorrect:**
|
|
5
|
+
```cpp
|
|
6
|
+
void setWindowVisible(bool visible, bool animate);
|
|
7
|
+
// Call site: setWindowVisible(true, false); // What is false?
|
|
8
|
+
```
|
|
9
|
+
|
|
10
|
+
**Correct (C++14):**
|
|
11
|
+
```cpp
|
|
12
|
+
enum class Visibility { Visible, Hidden };
|
|
13
|
+
enum class Animation { Enabled, Disabled };
|
|
14
|
+
|
|
15
|
+
void setWindowVisible(Visibility v, Animation a);
|
|
16
|
+
// Call site: setWindowVisible(Visibility::Visible, Animation::Disabled);
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
### 2. Contract-Based Validation
|
|
20
|
+
Using GSL (Guidelines Support Library) style:
|
|
21
|
+
|
|
22
|
+
```cpp
|
|
23
|
+
#include <gsl/gsl>
|
|
24
|
+
|
|
25
|
+
class User {
|
|
26
|
+
public:
|
|
27
|
+
// Ensure name is never null or empty
|
|
28
|
+
void setName(gsl::not_null<const char*> name) {
|
|
29
|
+
Expects(std::strlen(name) > 0);
|
|
30
|
+
this->name = name;
|
|
31
|
+
}
|
|
32
|
+
private:
|
|
33
|
+
std::string name;
|
|
34
|
+
};
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
### 3. Safe Sequences with Span
|
|
38
|
+
Replaces pointer + length pairs which are prone to buffer overflows.
|
|
39
|
+
|
|
40
|
+
```cpp
|
|
41
|
+
#include <gsl/gsl> // Use gsl::span in C++14
|
|
42
|
+
|
|
43
|
+
float calculateAverage(gsl::span<const float> values) {
|
|
44
|
+
Expects(!values.empty());
|
|
45
|
+
|
|
46
|
+
float sum = 0.0f;
|
|
47
|
+
for (float v : values) {
|
|
48
|
+
sum += v;
|
|
49
|
+
}
|
|
50
|
+
return sum / values.size();
|
|
51
|
+
}
|
|
52
|
+
|
|
53
|
+
// Usage:
|
|
54
|
+
// float arr[] = {1, 2, 3};
|
|
55
|
+
// calculateAverage(arr); // Automatic conversion to span
|
|
56
|
+
```
|