fraim-framework 1.0.1 → 1.0.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fraim-framework",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "description": "FRAIM: Framework for Rigor-based AI Management - Where humans become AI managers through rigorous methodology",
   "main": "index.js",
   "bin": {

package/setup.js

@@ -53,88 +53,13 @@ function writeFile(filePath, content) {
     logSuccess(`Created file: ${filePath}`);
 }
 
-function createGitHubLabels() {
-    const labels = [
-        { name: 'phase:design', color: '0e8a16', description: 'Design phase - RFC creation and review' },
-        { name: 'phase:impl', color: '1d76db', description: 'Implementation phase - coding and testing' },
-        { name: 'phase:tests', color: 'fef2c0', description: 'Testing phase - validation and QA' },
-        { name: 'status:wip', color: 'fbca04', description: 'Work in progress' },
-        { name: 'status:needs-review', color: 'd93f0b', description: 'Ready for review' },
-        { name: 'status:complete', color: '0e8a16', description: 'Completed and approved' },
-        { name: 'ai-agent:cursor', color: '5319e7', description: 'Assigned to Cursor AI agent' },
-        { name: 'ai-agent:claude', color: 'c2e0c6', description: 'Assigned to Claude AI agent' },
-        { name: 'ai-agent:windsurf', color: 'bfdadc', description: 'Assigned to Windsurf AI agent' }
-    ];
-
-    const labelsContent = JSON.stringify(labels, null, 2);
-    writeFile('.github/labels.json', labelsContent);
-    
-    logInfo('GitHub labels configuration created');
-    logInfo('You can import these labels using GitHub CLI or the web interface');
-}
-
-function createGitHubWorkflows() {
-    // Phase change workflow
-    const phaseChangeWorkflow = `name: Phase Change Automation
-
-on:
-  issues:
-    types: [labeled, unlabeled]
-
-jobs:
-  phase-change:
-    runs-on: ubuntu-latest
-    if: contains(github.event.issue.labels.*.name, 'phase:') || contains(github.event.label.name, 'phase:')
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-      
-      - name: Phase Change Handler
-        run: |
-          echo "Phase change detected for issue #\${{ github.event.issue.number }}"
-          echo "New phase: \${{ github.event.label.name || 'phase removed' }}"
-      
-      - name: Update Issue Status
-        if: contains(github.event.label.name, 'phase:')
-        run: |
-          gh issue edit \${{ github.event.issue.number }} --add-label "status:wip"
-          echo "Status updated to WIP for new phase"
-`;
-
-    // Status change workflow
-    const statusChangeWorkflow = `name: Status Change Automation
-
-on:
-  issues:
-    types: [labeled, unlabeled]
-
-jobs:
-  status-change:
-    runs-on: ubuntu-latest
-    if: contains(github.event.issue.labels.*.name, 'status:') || contains(github.event.label.name, 'status:')
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-      
-      - name: Status Change Handler
-        run: |
-          echo "Status change detected for issue #\${{ github.event.issue.number }}"
-          echo "New status: \${{ github.event.label.name || 'status removed' }}"
-      
-      - name: Notify Team
-        if: contains(github.event.label.name, 'status:needs-review')
-        run: |
-          echo "Issue ready for review - notifying team"
-`;
-
-    writeFile('.github/workflows/phase-change.yml', phaseChangeWorkflow);
-    writeFile('.github/workflows/status-change.yml', statusChangeWorkflow);
-    
-    logSuccess('GitHub workflows created');
-}
+function createAgentStructure() {
+    // Create the proper agent directory structure
+    ensureDirectory('agents/cursor/rules');
+    ensureDirectory('agents/claude/rules');
+    ensureDirectory('agents/windsurf/rules');
 
-function createAgentConfigs() {
-    // Cursor rules
+    // Create .cursorrules that references modular rules
     const cursorRules = `# FRAIM Cursor Rules
 
 ## Core Rules (Always Apply)
@@ -178,17 +103,15 @@ function createAgentConfigs() {
 - Enable observability through clear documentation
 `;
 
-    // Claude rules
-    const claudeRules = `# FRAIM Claude Rules
+    // Create .windsurfrules that references modular rules
+    const windsurfRules = `# FRAIM Windsurf Rules
 
-## Always-On Rules
+## Core Rules (Always Apply)
 - **ashley-architecture.mdc** - Follow the established architecture patterns
 - **continuous-learning.mdc** - Always review retrospectives and RFCs before starting work
-
-## Phase-Specific Rules (Manual Trigger Only)
-- **design.mdc** - Design phase rules
-- **implement.mdc** - Implementation phase rules
-- **test.mdc** - Testing phase rules
+- **local-development.mdc** - Work locally, coordinate remotely
+- **simplicity.mdc** - Keep it simple, don't over-engineer
+- **issue-resolution-process.mdc** - Follow the established issue resolution process
 
 ## Key Behavioral Requirements
 - Always verify actions taken
@@ -209,22 +132,30 @@ function createAgentConfigs() {
 - Use local Git for version control
 - Test locally before committing
 
-## FRAIM Integration
-- Follow the RIGOR methodology
-- Maintain isolation between agents
-- Use GitOps for coordination
-- Enable observability through clear documentation
+## Architecture and Optimization Principles
+- Follow established patterns
+- Optimize for performance and maintainability
+- Document architectural decisions
+- Consider scalability and security
+
+## Your Role in FRAIM
+- Provide technical expertise and optimization
+- Maintain code quality and standards
+- Ensure architectural consistency
+- Support other agents with technical guidance
 `;
 
-    // Windsurf rules
-    const windsurfRules = `# FRAIM Windsurf Rules
+    // Create CLAUDE.md that references modular rules
+    const claudeRules = `# FRAIM Claude Rules
 
-## Core Rules (Always Apply)
+## Always-On Rules
 - **ashley-architecture.mdc** - Follow the established architecture patterns
 - **continuous-learning.mdc** - Always review retrospectives and RFCs before starting work
-- **local-development.mdc** - Work locally, coordinate remotely
-- **simplicity.mdc** - Keep it simple, don't over-engineer
-- **issue-resolution-process.mdc** - Follow the established issue resolution process
+
+## Phase-Specific Rules (Manual Trigger Only)
+- **design.mdc** - Design phase rules
+- **implement.mdc** - Implementation phase rules
+- **test.mdc** - Testing phase rules
 
 ## Key Behavioral Requirements
 - Always verify actions taken
@@ -245,68 +176,139 @@ function createAgentConfigs() {
 - Use local Git for version control
 - Test locally before committing
 
-## Architecture and Optimization Principles
-- Follow established patterns
-- Optimize for performance and maintainability
-- Document architectural decisions
-- Consider scalability and security
-
-## Your Role in FRAIM
-- Provide technical expertise and optimization
-- Maintain code quality and standards
-- Ensure architectural consistency
-- Support other agents with technical guidance
+## FRAIM Integration
+- Follow the RIGOR methodology
+- Maintain isolation between agents
+- Use GitOps for coordination
+- Enable observability through clear documentation
 `;
 
     writeFile('.cursorrules', cursorRules);
-    writeFile('CLAUDE.md', claudeRules);
     writeFile('.windsurfrules', windsurfRules);
+    writeFile('CLAUDE.md', claudeRules);
     
-    logSuccess('AI agent configurations created');
+    logSuccess('AI agent configuration files created');
 }
 
-function createDocumentation() {
-    const readme = `# FRAIM-Enabled Repository
-
-This repository is configured with FRAIM (Framework for Rigor-based AI Management) to enable coordinated AI agent development.
-
-## 🚀 Quick Start
+function createGitHubWorkflows() {
+    // Phase change workflow
+    const phaseChangeWorkflow = `name: Phase Change Automation
 
-1. **Create an issue** with appropriate phase labels:
-   \`\`\`bash
-   gh issue create --title "Add user authentication" --label "phase:design,ai-agent:claude"
-   \`\`\`
+on:
+  issues:
+    types: [labeled, unlabeled]
 
-2. **AI agents will automatically coordinate** through GitHub state:
-   - Claude creates RFC → Cursor implements → Windsurf optimizes
+jobs:
+  phase-change:
+    runs-on: ubuntu-latest
+    if: contains(github.event.issue.labels.*.name, 'phase:') || contains(github.event.label.name, 'phase:')
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      
+      - name: Phase Change Handler
+        run: |
+          echo "Phase change detected for issue #\${{ github.event.issue.number }}"
+          echo "New phase: \${{ github.event.label.name || 'phase removed' }}"
+      
+      - name: Update Issue Status
+        if: contains(github.event.label.name, 'phase:')
+        run: |
+          gh issue edit \${{ github.event.issue.number }} --add-label "status:wip"
+          echo "Status updated to WIP for new phase"
+`;
 
-3. **Use phase labels** to manage workflow:
-   - \`phase:design\` → \`phase:impl\` → \`phase:tests\`
+    // Status change workflow
+    const statusChangeWorkflow = `name: Status Change Automation
 
-## 🏷️ Available Labels
+on:
+  issues:
+    types: [labeled, unlabeled]
 
-- **Phase Labels**: \`phase:design\`, \`phase:impl\`, \`phase:tests\`
-- **Status Labels**: \`status:wip\`, \`status:needs-review\`, \`status:complete\`
-- **Agent Labels**: \`ai-agent:cursor\`, \`ai-agent:claude\`, \`ai-agent:windsurf\`
+jobs:
+  status-change:
+    runs-on: ubuntu-latest
+    if: contains(github.event.issue.labels.*.name, 'status:') || contains(github.event.label.name, 'status:')
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      
+      - name: Status Change Handler
+        run: |
+          echo "Status change detected for issue #\${{ github.event.issue.number }}"
+          echo "New status: \${{ github.event.label.name || 'status removed' }}"
+      
+      - name: Notify Team
+        if: contains(github.event.label.name, 'status:needs-review')
+        run: |
+          echo "Issue ready for review - notifying team"
+`;
 
-## 📚 Learn More
+    // Sync on PR review workflow
+    const syncOnPRReviewWorkflow = `name: Sync on PR Review
 
-- [FRAIM Framework](https://github.com/mathursrus/Ashley-Calendar-AI/tree/master/FRAIM)
-- [RIGOR Methodology](https://github.com/mathursrus/Ashley-Calendar-AI/tree/master/FRAIM#the-rigor-methodology)
-- [Getting Started Guide](https://github.com/mathursrus/Ashley-Calendar-AI/tree/master/FRAIM/docs/guides/getting-started.md)
+on:
+  pull_request_review:
+    types: [submitted, edited, dismissed]
 
-## 🤖 AI Agent Rules
+jobs:
+  sync-review:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      
+      - name: Sync Review Status
+        env:
+          GITHUB_TOKEN: \${{ secrets.GITHUB_TOKEN }}
+        run: |
+          PR_NUMBER="\${{ github.event.pull_request.number }}"
+          REVIEW_STATE="\${{ github.event.review.state }}"
+          
+          echo "PR #\$PR_NUMBER review state: \$REVIEW_STATE"
+          
+          if [ "\$REVIEW_STATE" = "approved" ]; then
+            echo "PR approved - updating status"
+            gh pr edit \$PR_NUMBER --add-label "status:approved"
+          elif [ "\$REVIEW_STATE" = "changes_requested" ]; then
+            echo "Changes requested - updating status"
+            gh pr edit \$PR_NUMBER --add-label "status:changes-requested"
+          fi
+          
+          echo "Review sync complete"
+`;
 
-Each AI agent has specific rules and configurations:
-- **Cursor**: \`.cursorrules\`
-- **Claude**: \`CLAUDE.md\`
-- **Windsurf**: \`.windsurfrules\`
+    writeFile('.github/workflows/phase-change.yml', phaseChangeWorkflow);
+    writeFile('.github/workflows/status-change.yml', statusChangeWorkflow);
+    writeFile('.github/workflows/sync-on-pr-review.yml', syncOnPRReviewWorkflow);
+    
+    logSuccess('GitHub workflows created');
+}
 
----
+function createGitHubLabels() {
+    const labels = [
+        { name: 'phase:design', color: '0e8a16', description: 'Design phase - RFC creation and review' },
+        { name: 'phase:impl', color: '1d76db', description: 'Implementation phase - coding and testing' },
+        { name: 'phase:tests', color: 'fef2c0', description: 'Testing phase - validation and QA' },
+        { name: 'status:wip', color: 'fbca04', description: 'Work in progress' },
+        { name: 'status:needs-review', color: 'd93f0b', description: 'Ready for review' },
+        { name: 'status:complete', color: '0e8a16', description: 'Completed and approved' },
+        { name: 'status:approved', color: '0e8a16', description: 'Approved and ready to merge' },
+        { name: 'status:changes-requested', color: 'd93f0b', description: 'Changes requested in review' },
+        { name: 'ai-agent:cursor', color: '5319e7', description: 'Assigned to Cursor AI agent' },
+        { name: 'ai-agent:claude', color: 'c2e0c6', description: 'Assigned to Claude AI agent' },
+        { name: 'ai-agent:windsurf', color: 'bfdadc', description: 'Assigned to Windsurf AI agent' }
+    ];
 
-*Powered by FRAIM: Where humans become AI managers through rigorous methodology*
-`;
+    const labelsContent = JSON.stringify(labels, null, 2);
+    writeFile('.github/labels.json', labelsContent);
+    
+    logInfo('GitHub labels configuration created');
+    logInfo('You can import these labels using GitHub CLI or the web interface');
+    logInfo('Or use the GitHub web interface: Settings > Labels > Import labels');
+}
 
+function createFRAIMConfig() {
     const fraimConfig = {
         version: "1.0.0",
         framework: "FRAIM",
@@ -325,14 +327,13 @@ Each AI agent has specific rules and configurations:
         },
         workflows: [
             ".github/workflows/phase-change.yml",
-            ".github/workflows/status-change.yml"
+            ".github/workflows/status-change.yml",
+            ".github/workflows/sync-on-pr-review.yml"
         ]
     };
 
-    writeFile('README.md', readme);
     writeFile('fraim-config.json', JSON.stringify(fraimConfig, null, 2));
-    
-    logSuccess('Documentation created');
+    logSuccess('FRAIM configuration created');
 }
 
 function runSetup() {
@@ -340,15 +341,14 @@ function runSetup() {
     log('Setting up FRAIM in current repository...\n');
 
     try {
-        // Create directory structure
+        // Create only essential directory structure
         ensureDirectory('.github/workflows');
-        ensureDirectory('examples');
 
         // Create all components
-        createGitHubLabels();
+        createAgentStructure();
         createGitHubWorkflows();
-        createAgentConfigs();
-        createDocumentation();
+        createGitHubLabels();
+        createFRAIMConfig();
 
         logHeader('🎉 Setup Complete!');
         logSuccess('FRAIM has been successfully set up in your repository!');