fraim-framework 2.0.41 → 2.0.43

package/README.md

@@ -266,9 +266,33 @@ FRAIM/
 ### **Install & Initialize**
 ```bash
 npm install -g fraim-framework
-fraim init
+fraim setup  # Complete setup with IDE configuration
 ```
 
+### **🔧 Additional Commands**
+
+After initial setup, you can use these commands:
+
+```bash
+# Add FRAIM to additional IDEs (after initial setup)
+fraim add-ide --ide claude          # Configure specific IDE
+fraim add-ide --ide antigravity     # Configure Gemini Antigravity
+fraim add-ide --all                 # Configure all detected IDEs
+fraim add-ide --list                # List supported IDEs
+
+# Project initialization
+fraim init-project                  # Initialize FRAIM in current project
+
+# Testing and validation
+fraim test-mcp                      # Test MCP server connections
+fraim doctor                        # Diagnose configuration issues
+
+# Sync and maintenance
+fraim sync                          # Sync latest workflows and rules
+```
+
+**💡 Pro Tip**: Use `fraim add-ide` when you install a new IDE after initial setup. It reuses your existing FRAIM and GitHub keys, making it much faster than running full setup again.
+
 ### **🔧 Customize for Your Project**
 
 After installation, customize these files for your specific project:

package/dist/registry/ai-manager-rules/design.json

@@ -0,0 +1,97 @@
+{
+  "workflowType": "design",
+  "description": "Design phase validation ensures that technical designs are complete, follow RFC format, and provide clear implementation guidance.",
+  "validationRules": [
+    {
+      "step": 1,
+      "description": "Verify issue is labeled with phase:design",
+      "passCriteria": "Issue has 'phase:design' label applied",
+      "weight": "blocking",
+      "category": "process"
+    },
+    {
+      "step": 2,
+      "description": "Verify RFC document exists in correct location",
+      "command": "find \"docs/rfcs\" -name \"*{issue_number}*\" -type f",
+      "passCriteria": "RFC document exists at docs/rfcs/{issue_number}-{kebab-title}.md with substantial content (>1500 characters)",
+      "weight": "blocking",
+      "category": "completeness"
+    },
+    {
+      "step": 3,
+      "description": "Check RFC follows technical design template structure",
+      "passCriteria": "RFC includes all required sections: Problem Statement, Solution Overview, Technical Design, Implementation Plan, Testing Strategy, Risks and Mitigations",
+      "weight": "blocking",
+      "category": "structure"
+    },
+    {
+      "step": 4,
+      "description": "Validate Problem Statement is clear",
+      "passCriteria": "Problem Statement clearly defines the technical challenge and why it needs to be solved",
+      "weight": "blocking",
+      "category": "problem-definition"
+    },
+    {
+      "step": 5,
+      "description": "Validate Solution Overview provides clear direction",
+      "passCriteria": "Solution Overview describes the high-level approach and key architectural decisions",
+      "weight": "blocking",
+      "category": "solution-design"
+    },
+    {
+      "step": 6,
+      "description": "Check Technical Design has sufficient detail",
+      "passCriteria": "Technical Design includes API contracts, data models, component interactions, and implementation details",
+      "weight": "blocking",
+      "category": "technical-detail"
+    },
+    {
+      "step": 7,
+      "description": "Validate Implementation Plan is actionable",
+      "passCriteria": "Implementation Plan breaks down work into clear, executable steps with dependencies identified",
+      "weight": "blocking",
+      "category": "implementation-planning"
+    },
+    {
+      "step": 8,
+      "description": "Check Testing Strategy is comprehensive",
+      "passCriteria": "Testing Strategy covers unit tests, integration tests, and validation scenarios",
+      "weight": "blocking",
+      "category": "testing"
+    },
+    {
+      "step": 9,
+      "description": "Verify Risks and Mitigations are identified",
+      "passCriteria": "Risks and Mitigations section identifies potential issues and mitigation strategies",
+      "weight": "warning",
+      "category": "risk-management"
+    },
+    {
+      "step": 10,
+      "description": "Check all requirements from spec are addressed",
+      "passCriteria": "All requirements from the specification document are covered in the technical design",
+      "weight": "blocking",
+      "category": "completeness"
+    }
+  ],
+  "gradingCriteria": {
+    "passRequirements": [
+      "ALL blocking validation steps must pass",
+      "At least 80% of warning validation steps should pass",
+      "Design demonstrates clear technical understanding",
+      "Implementation plan is realistic and actionable",
+      "No placeholder text or incomplete sections remain"
+    ],
+    "failRequirements": [
+      "ANY blocking validation step fails",
+      "Multiple warning validation steps fail indicating quality issues",
+      "Design appears incomplete or lacks technical depth",
+      "Requirements not properly addressed",
+      "Template structure not followed"
+    ]
+  },
+  "reportingFormat": {
+    "requiredFields": ["pass", "reasons"],
+    "instructions": "Evaluate each validation step honestly. If ANY blocking step fails, you must report pass=false. Provide specific reasons for failure in the reasons array. Focus on technical completeness and implementation clarity."
+  }
+}

package/dist/registry/ai-manager-rules/implement.json

@@ -0,0 +1,153 @@
+{
+  "workflowType": "implement",
+  "description": "Implementation phase validation ensures that code changes are complete, properly tested with high-quality tests, and ready for production deployment. This phase enforces rigorous testing standards and design completeness.",
+  "validationRules": [
+    {
+      "step": 1,
+      "description": "Verify issue is labeled with phase:implement",
+      "passCriteria": "Issue has 'phase:implement' label applied",
+      "weight": "blocking",
+      "category": "process"
+    },
+    {
+      "step": 2,
+      "description": "Verify all aspects of design are complete",
+      "passCriteria": "All design requirements from spec/RFC are implemented: API contracts, data models, user interfaces, error handling patterns, and integration points. No placeholder code or TODO comments remain for core functionality.",
+      "weight": "blocking",
+      "category": "design-completeness"
+    },
+    {
+      "step": 3,
+      "description": "Verify all test cases from design document are written",
+      "passCriteria": "Every test case specified in the design document/RFC validation plan has a corresponding automated test. Test coverage includes all user scenarios, edge cases, and error conditions outlined in the design.",
+      "weight": "blocking",
+      "category": "test-completeness"
+    },
+    {
+      "step": 4,
+      "description": "Verify all test cases follow architecture standards",
+      "passCriteria": "Tests follow the Shared Server Architecture pattern from docs/architecture/architecture.md: use shared-server-utils.ts, unique API keys per test, proper cleanup in finally blocks, no individual server instances, proper timeouts (5-10s for network calls).",
+      "weight": "blocking",
+      "category": "test-architecture"
+    },
+    {
+      "step": 5,
+      "description": "Verify all test cases have been run and are passing",
+      "passCriteria": "All tests pass successfully. Test output shows 0 failures, 0 timeouts, and all assertions succeed. Tests complete within reasonable time limits (<60s total, <10s per test).",
+      "weight": "blocking",
+      "category": "test-execution"
+    },
+    {
+      "step": 6,
+      "description": "Verify tests do not mock the objects they should be testing",
+      "passCriteria": "Tests validate real functionality, not mocked behavior. Core business logic is tested against actual implementations. Mocks are only used for external dependencies (databases, APIs, file system) not for the code under test.",
+      "weight": "blocking",
+      "category": "test-quality"
+    },
+    {
+      "step": 7,
+      "description": "Verify tests do not default to passing when unable to test",
+      "passCriteria": "No tests contain 'return true' without validation, empty test bodies, or assertions that always pass. Every test performs meaningful validation of expected behavior and will fail if the code is broken.",
+      "weight": "blocking",
+      "category": "test-quality"
+    },
+    {
+      "step": 8,
+      "description": "Verify tests use flow testing instead of static analysis",
+      "passCriteria": "Tests execute actual code paths and validate runtime behavior. Tests call functions, trigger workflows, and verify outcomes. Static analysis (type checking, linting) supplements but does not replace functional testing.",
+      "weight": "blocking",
+      "category": "test-quality"
+    },
+    {
+      "step": 9,
+      "description": "Check TypeScript compilation passes",
+      "command": "npx tsc --noEmit --skipLibCheck",
+      "passCriteria": "TypeScript compilation completes without errors",
+      "weight": "blocking",
+      "category": "code-quality"
+    },
+    {
+      "step": 10,
+      "description": "Check code quality standards",
+      "passCriteria": "No 'as any' type bypassing, proper error handling, consistent code style, meaningful variable names, and appropriate code comments",
+      "weight": "blocking",
+      "category": "code-quality"
+    },
+    {
+      "step": 11,
+      "description": "Verify implementation matches design exactly",
+      "passCriteria": "Implementation follows the technical design/RFC precisely and addresses all specified requirements. API signatures, data structures, and behavior match the design specification.",
+      "weight": "blocking",
+      "category": "design-compliance"
+    },
+    {
+      "step": 12,
+      "description": "Check comprehensive error handling and edge cases",
+      "passCriteria": "Proper error handling implemented for all failure scenarios, edge cases covered with tests, graceful degradation where appropriate, and meaningful error messages",
+      "weight": "blocking",
+      "category": "robustness"
+    },
+    {
+      "step": 13,
+      "description": "Validate API contracts and interfaces",
+      "passCriteria": "All API contracts match specification, proper input validation, consistent response formats, and backward compatibility maintained",
+      "weight": "blocking",
+      "category": "api-compliance"
+    },
+    {
+      "step": 14,
+      "description": "Check security best practices",
+      "passCriteria": "Input sanitization, proper authentication/authorization, no security vulnerabilities, secure handling of sensitive data",
+      "weight": "blocking",
+      "category": "security"
+    },
+    {
+      "step": 15,
+      "description": "Check documentation is updated",
+      "passCriteria": "Code comments, README updates, API documentation, and inline documentation reflect all changes",
+      "weight": "warning",
+      "category": "documentation"
+    },
+    {
+      "step": 16,
+      "description": "Verify performance considerations",
+      "passCriteria": "No obvious performance regressions, efficient algorithms used, proper resource management, and performance tests where applicable",
+      "weight": "warning",
+      "category": "performance"
+    },
+    {
+      "step": 17,
+      "description": "Validate evidence document exists",
+      "command": "find \"docs/evidence\" -name \"*{issue_number}*implementation*\" -type f",
+      "passCriteria": "Implementation evidence document exists with test results, validation details, and proof of all requirements being met",
+      "weight": "warning",
+      "category": "documentation"
+    }
+  ],
+  "gradingCriteria": {
+    "passRequirements": [
+      "ALL blocking validation steps must pass",
+      "At least 80% of warning validation steps should pass",
+      "All design aspects are fully implemented",
+      "All test cases from design document are written and passing",
+      "Tests follow architecture standards and test real functionality",
+      "No tests mock objects under test or default to passing",
+      "Tests use flow testing to validate runtime behavior",
+      "Code is production-ready and maintainable"
+    ],
+    "failRequirements": [
+      "ANY blocking validation step fails",
+      "Design implementation is incomplete",
+      "Test cases from design document are missing",
+      "Tests violate architecture standards",
+      "Tests mock the objects they should be testing",
+      "Tests default to passing without proper validation",
+      "Tests rely on static analysis instead of flow testing",
+      "Code has obvious bugs or security issues"
+    ]
+  },
+  "reportingFormat": {
+    "requiredFields": ["pass", "reasons"],
+    "instructions": "Evaluate each validation step rigorously. Pay special attention to test quality - verify that tests actually test the intended functionality and follow architecture standards. If ANY blocking step fails, you must report pass=false. Focus on design completeness, test quality, and production readiness."
+  }
+}

package/dist/registry/ai-manager-rules/spec.json

@@ -0,0 +1,112 @@
+{
+  "workflowType": "spec",
+  "description": "Specification phase validation ensures that feature specifications are complete, follow the correct template structure, and include all necessary components including high-fidelity mocks for UI changes.",
+  "validationRules": [
+    {
+      "step": 1,
+      "description": "Verify issue is labeled with phase:spec",
+      "passCriteria": "Issue has 'phase:spec' label applied in GitHub",
+      "weight": "blocking",
+      "category": "process"
+    },
+    {
+      "step": 2,
+      "description": "Verify spec document exists in correct location",
+      "command": "find \"docs/feature specs\" -name \"*{issue_number}*\" -type f",
+      "passCriteria": "Spec document exists at docs/feature specs/{issue_number}-{kebab-title}.md with substantial content (>1000 characters)",
+      "weight": "blocking",
+      "category": "completeness"
+    },
+    {
+      "step": 3,
+      "description": "Check spec follows FEATURESPEC template structure",
+      "passCriteria": "Spec includes all required sections: Customer, Customer's Desired Outcome, Customer Problem, User Experience, Validation Plan, Alternatives, Competitive Landscape",
+      "weight": "blocking",
+      "category": "structure"
+    },
+    {
+      "step": 4,
+      "description": "Validate Customer section is complete",
+      "passCriteria": "Customer section clearly identifies who will use this feature with specific details",
+      "weight": "blocking",
+      "category": "customer-focus"
+    },
+    {
+      "step": 5,
+      "description": "Validate Customer's Desired Outcome is specific",
+      "passCriteria": "Desired outcome is clear, measurable, and describes the end goal the customer wants to achieve",
+      "weight": "blocking",
+      "category": "customer-focus"
+    },
+    {
+      "step": 6,
+      "description": "Validate Customer Problem is well-defined",
+      "passCriteria": "Problem statement is specific and explains why current state is insufficient for the customer",
+      "weight": "blocking",
+      "category": "problem-definition"
+    },
+    {
+      "step": 7,
+      "description": "Check User Experience section has detailed workflow",
+      "passCriteria": "User Experience includes specific step-by-step workflow (start in X, click Y, see Z, etc.) that shows exactly how the user will interact with the feature",
+      "weight": "blocking",
+      "category": "user-experience"
+    },
+    {
+      "step": 8,
+      "description": "Verify high-fidelity mocks are created if issue requires mocks",
+      "command": "find \"docs/feature specs/mocks\" -name \"*{issue_number}*\" -type f",
+      "passCriteria": "If feature involves UI changes, high-fidelity mocks (HTML/CSS files) are included in docs/feature specs/mocks folder and linked in spec. Markdown code blocks are NOT sufficient.",
+      "weight": "blocking",
+      "category": "user-experience"
+    },
+    {
+      "step": 9,
+      "description": "Validate Validation Plan is actionable",
+      "passCriteria": "Validation Plan includes specific, executable steps to verify the feature works (browser tests, API calls, user scenarios, etc.)",
+      "weight": "blocking",
+      "category": "validation"
+    },
+    {
+      "step": 10,
+      "description": "Check Alternatives section is complete",
+      "passCriteria": "Alternatives section includes table with alternative solutions and clear reasons for not choosing them",
+      "weight": "warning",
+      "category": "thoroughness"
+    },
+    {
+      "step": 11,
+      "description": "Verify Competitive Landscape analysis",
+      "passCriteria": "Competitive Landscape section includes table with competitors, their solutions, and customer feedback or market research",
+      "weight": "warning",
+      "category": "market-awareness"
+    },
+    {
+      "step": 12,
+      "description": "Check all requirements from original issue are addressed",
+      "passCriteria": "All requirements and acceptance criteria from the original GitHub issue are covered in the spec document",
+      "weight": "blocking",
+      "category": "completeness"
+    }
+  ],
+  "gradingCriteria": {
+    "passRequirements": [
+      "ALL blocking validation steps must pass",
+      "At least 80% of warning validation steps should pass",
+      "Spec demonstrates clear understanding of customer needs",
+      "Quality standards are met consistently",
+      "No placeholder text or incomplete sections remain"
+    ],
+    "failRequirements": [
+      "ANY blocking validation step fails",
+      "Multiple warning validation steps fail indicating quality issues",
+      "Spec appears incomplete or rushed",
+      "Requirements not properly addressed",
+      "Template structure not followed"
+    ]
+  },
+  "reportingFormat": {
+    "requiredFields": ["pass", "reasons"],
+    "instructions": "Evaluate each validation step honestly. If ANY blocking step fails, you must report pass=false. Provide specific reasons for failure in the reasons array. Be thorough and honest in your self-assessment."
+  }
+}

package/dist/registry/ai-manager-rules/test.json

@@ -0,0 +1,98 @@
+{
+  "workflowType": "test",
+  "description": "Testing phase validation ensures comprehensive test coverage, proper test implementation, and validation of all functionality.",
+  "validationRules": [
+    {
+      "step": 1,
+      "description": "Verify issue is labeled with phase:test",
+      "passCriteria": "Issue has 'phase:test' label applied",
+      "weight": "blocking",
+      "category": "process"
+    },
+    {
+      "step": 2,
+      "description": "Check all tests pass",
+      "command": "npm test",
+      "passCriteria": "All tests pass without errors or failures",
+      "weight": "blocking",
+      "category": "test-execution"
+    },
+    {
+      "step": 3,
+      "description": "Verify test coverage is adequate",
+      "command": "npm run test:coverage",
+      "passCriteria": "Test coverage meets project standards (typically >80% for new code)",
+      "weight": "blocking",
+      "category": "test-coverage"
+    },
+    {
+      "step": 4,
+      "description": "Check unit tests for new functionality",
+      "passCriteria": "All new functions/methods have corresponding unit tests with edge cases",
+      "weight": "blocking",
+      "category": "unit-testing"
+    },
+    {
+      "step": 5,
+      "description": "Verify integration tests exist",
+      "passCriteria": "Integration tests cover API endpoints, database interactions, and component integration",
+      "weight": "blocking",
+      "category": "integration-testing"
+    },
+    {
+      "step": 6,
+      "description": "Check error scenario testing",
+      "passCriteria": "Tests cover error conditions, invalid inputs, and failure scenarios",
+      "weight": "blocking",
+      "category": "error-testing"
+    },
+    {
+      "step": 7,
+      "description": "Validate test data and mocking",
+      "passCriteria": "Proper test data setup, appropriate mocking of external dependencies",
+      "weight": "warning",
+      "category": "test-setup"
+    },
+    {
+      "step": 8,
+      "description": "Check test performance",
+      "passCriteria": "Tests run efficiently, no unnecessarily slow tests, proper test isolation",
+      "weight": "warning",
+      "category": "test-performance"
+    },
+    {
+      "step": 9,
+      "description": "Verify end-to-end tests (if applicable)",
+      "passCriteria": "E2E tests cover critical user workflows and system interactions",
+      "weight": "warning",
+      "category": "e2e-testing"
+    },
+    {
+      "step": 10,
+      "description": "Check test documentation",
+      "passCriteria": "Test cases are well-documented, test setup instructions are clear",
+      "weight": "warning",
+      "category": "test-documentation"
+    }
+  ],
+  "gradingCriteria": {
+    "passRequirements": [
+      "ALL blocking validation steps must pass",
+      "At least 80% of warning validation steps should pass",
+      "Comprehensive test coverage for all new functionality",
+      "Tests are reliable and maintainable",
+      "All edge cases and error scenarios covered"
+    ],
+    "failRequirements": [
+      "ANY blocking validation step fails",
+      "Tests are failing or missing",
+      "Inadequate test coverage",
+      "Poor test quality or reliability",
+      "Critical scenarios not tested"
+    ]
+  },
+  "reportingFormat": {
+    "requiredFields": ["pass", "reasons"],
+    "instructions": "Evaluate each validation step honestly. Run all test commands and verify coverage reports. If ANY blocking step fails, you must report pass=false. Focus on test quality, coverage, and reliability."
+  }
+}