proagents 1.0.5 → 1.0.7

package/lib/commands/init.js

@@ -86,6 +86,9 @@ const FRAMEWORK_FILES = [
   'PROAGENTS.md',
   'GETTING-STARTED-STORY.md',
   'slash-commands.json',
+  'CLAUDE.md',
+  '.cursorrules',
+  'AI_INSTRUCTIONS.md',
 ];
 
 /**
@@ -253,6 +256,21 @@ For detailed commands, see \`./proagents/PROAGENTS.md\`
       console.log(chalk.green('✓ Created README.md with ProAgents commands'));
     }
 
+    // Copy AI instruction files to project root (for AI platform recognition)
+    const claudeMdSource = join(sourceDir, 'CLAUDE.md');
+    const claudeMdTarget = join(targetDir, 'CLAUDE.md');
+    if (existsSync(claudeMdSource) && !existsSync(claudeMdTarget)) {
+      cpSync(claudeMdSource, claudeMdTarget);
+      console.log(chalk.green('✓ Created CLAUDE.md (for Claude AI recognition)'));
+    }
+
+    const cursorRulesSource = join(sourceDir, '.cursorrules');
+    const cursorRulesTarget = join(targetDir, '.cursorrules');
+    if (existsSync(cursorRulesSource) && !existsSync(cursorRulesTarget)) {
+      cpSync(cursorRulesSource, cursorRulesTarget);
+      console.log(chalk.green('✓ Created .cursorrules (for Cursor AI recognition)'));
+    }
+
     // Success message
     console.log(chalk.green('\n✓ ProAgents initialized successfully!\n'));
 
@@ -287,6 +305,21 @@ async function smartUpdate(sourceDir, targetDir) {
     }
   }
 
+  // Before updating, migrate any modified template files
+  const migrationResult = migrateModifiedTemplates(sourceDir, targetDir);
+  if (migrationResult.migrated.length > 0) {
+    console.log(chalk.green(`✓ Migrated ${migrationResult.migrated.length} modified template(s) to user files`));
+    for (const file of migrationResult.migrated) {
+      console.log(chalk.gray(`  • ${file}`));
+    }
+  }
+  if (migrationResult.backedUp.length > 0) {
+    console.log(chalk.yellow(`⚠️  Backed up ${migrationResult.backedUp.length} modified template(s)`));
+    for (const file of migrationResult.backedUp) {
+      console.log(chalk.gray(`  • ${file}`));
+    }
+  }
+
   // Update framework folders
   let updatedCount = 0;
   for (const folder of FRAMEWORK_FOLDERS) {
@@ -304,6 +337,9 @@ async function smartUpdate(sourceDir, targetDir) {
   }
   console.log(chalk.green(`✓ Updated ${updatedCount} framework folders`));
 
+  // Restore user files that were migrated (they were saved before folder deletion)
+  restoreUserFiles(targetDir, migrationResult);
+
   // Update framework root files
   let filesUpdated = 0;
   for (const file of FRAMEWORK_FILES) {
@@ -345,6 +381,25 @@ async function smartUpdate(sourceDir, targetDir) {
       }
     }
   }
+
+  // Copy AI instruction files to project root (for AI platform recognition)
+  const projectRoot = join(targetDir, '..');
+  const aiFiles = ['CLAUDE.md', '.cursorrules', 'AI_INSTRUCTIONS.md'];
+  let aiFilesUpdated = 0;
+
+  for (const file of aiFiles) {
+    const sourcePath = join(sourceDir, file);
+    const targetPath = join(projectRoot, file);
+
+    if (existsSync(sourcePath)) {
+      cpSync(sourcePath, targetPath, { force: true });
+      aiFilesUpdated++;
+    }
+  }
+
+  if (aiFilesUpdated > 0) {
+    console.log(chalk.green(`✓ Updated ${aiFilesUpdated} AI instruction files (CLAUDE.md, .cursorrules)`));
+  }
 }
 
 /**
@@ -427,3 +482,131 @@ function mergeConfigs(userConfigPath, newConfigPath) {
     return { newOptions: 0, newKeys: [] };
   }
 }
+
+/**
+ * Find all template files in a directory recursively
+ * Template files have '.template.' in their name
+ */
+function findTemplateFiles(dir, baseDir = dir) {
+  const templates = [];
+
+  if (!existsSync(dir)) return templates;
+
+  const entries = readdirSync(dir, { withFileTypes: true });
+
+  for (const entry of entries) {
+    const fullPath = join(dir, entry.name);
+    const relativePath = fullPath.replace(baseDir + '/', '');
+
+    if (entry.isDirectory()) {
+      templates.push(...findTemplateFiles(fullPath, baseDir));
+    } else if (entry.name.includes('.template.')) {
+      templates.push(relativePath);
+    }
+  }
+
+  return templates;
+}
+
+/**
+ * Get the user file path for a template file
+ * e.g., 'config/rules/custom-rules.template.yaml' -> 'config/rules/custom-rules.yaml'
+ */
+function getUserFilePath(templatePath) {
+  return templatePath.replace('.template.', '.');
+}
+
+/**
+ * Check if a file has been modified by comparing with source
+ */
+function isFileModified(sourcePath, targetPath) {
+  if (!existsSync(targetPath)) return false;
+  if (!existsSync(sourcePath)) return true; // File exists in target but not source = modified/custom
+
+  try {
+    const sourceContent = readFileSync(sourcePath, 'utf-8');
+    const targetContent = readFileSync(targetPath, 'utf-8');
+    return sourceContent !== targetContent;
+  } catch {
+    return false;
+  }
+}
+
+/**
+ * Migrate modified template files to user files before update
+ * Returns info about migrated and backed up files
+ */
+function migrateModifiedTemplates(sourceDir, targetDir) {
+  const result = {
+    migrated: [],      // Templates copied to user files
+    backedUp: [],      // Templates backed up (user file already existed)
+    userFiles: {}      // Map of user file paths to their content (for restoration)
+  };
+
+  // Find all template files in target directory
+  const templateFiles = findTemplateFiles(targetDir);
+
+  for (const templateRelPath of templateFiles) {
+    const templateTargetPath = join(targetDir, templateRelPath);
+    const templateSourcePath = join(sourceDir, templateRelPath);
+    const userFileRelPath = getUserFilePath(templateRelPath);
+    const userFilePath = join(targetDir, userFileRelPath);
+
+    // Check if template was modified by user
+    if (isFileModified(templateSourcePath, templateTargetPath)) {
+      try {
+        const modifiedContent = readFileSync(templateTargetPath, 'utf-8');
+
+        if (existsSync(userFilePath)) {
+          // User file already exists - backup the modified template
+          const backupPath = templateTargetPath + '.backup';
+          writeFileSync(backupPath, modifiedContent);
+          result.backedUp.push(templateRelPath);
+          // Save backup content for restoration after folder deletion
+          result.userFiles[templateRelPath + '.backup'] = modifiedContent;
+        } else {
+          // No user file - migrate template to user file
+          result.userFiles[userFileRelPath] = modifiedContent;
+          result.migrated.push(`${templateRelPath} → ${userFileRelPath}`);
+        }
+      } catch (error) {
+        // Skip files that can't be read
+        continue;
+      }
+    }
+
+    // Also preserve existing user files (non-template versions)
+    if (existsSync(userFilePath)) {
+      try {
+        const userContent = readFileSync(userFilePath, 'utf-8');
+        result.userFiles[userFileRelPath] = userContent;
+      } catch {
+        // Skip files that can't be read
+      }
+    }
+  }
+
+  return result;
+}
+
+/**
+ * Restore user files after framework folders have been updated
+ */
+function restoreUserFiles(targetDir, migrationResult) {
+  for (const [relativePath, content] of Object.entries(migrationResult.userFiles)) {
+    const fullPath = join(targetDir, relativePath);
+    const dirPath = dirname(fullPath);
+
+    try {
+      // Ensure directory exists
+      if (!existsSync(dirPath)) {
+        mkdirSync(dirPath, { recursive: true });
+      }
+
+      // Write the user file
+      writeFileSync(fullPath, content);
+    } catch (error) {
+      console.log(chalk.yellow(`⚠️  Could not restore ${relativePath}: ${error.message}`));
+    }
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "proagents",
-  "version": "1.0.5",
+  "version": "1.0.7",
   "description": "AI-agnostic development workflow framework that automates the full software development lifecycle",
   "type": "module",
   "main": "lib/index.js",

package/proagents/.cursorrules

@@ -0,0 +1,33 @@
+# ProAgents Rules for Cursor
+
+This project uses ProAgents workflow framework.
+
+## Command Recognition
+
+Recognize commands starting with `pa:` prefix:
+
+- `pa:help` - Show all commands
+- `pa:feature "name"` - Start feature workflow (see ./proagents/WORKFLOW.md)
+- `pa:fix "bug"` - Bug fix mode (see ./proagents/workflow-modes/entry-modes.md)
+- `pa:status` - Show progress
+- `pa:doc` - Documentation options
+- `pa:doc-full` - Generate full documentation (see ./proagents/prompts/07-documentation.md)
+- `pa:doc-moderate` - Balanced documentation
+- `pa:doc-lite` - Quick reference
+- `pa:qa` - Quality checks (see ./proagents/checklists/code-quality.md)
+- `pa:test` - Test workflow (see ./proagents/prompts/06-testing.md)
+- `pa:deploy` - Deployment workflow (see ./proagents/prompts/08-deployment.md)
+- `pa:release` - Generate release notes
+
+## Workflow
+
+When user types `pa:` command:
+1. Read corresponding prompt from ./proagents/prompts/
+2. Follow the defined workflow
+3. Respect settings in ./proagents/proagents.config.yaml
+
+## Key References
+
+- Workflow: ./proagents/WORKFLOW.md
+- Commands: ./proagents/PROAGENTS.md
+- Prompts: ./proagents/prompts/

package/proagents/AI_INSTRUCTIONS.md

@@ -0,0 +1,71 @@
+# AI Instructions for ProAgents
+
+This project uses ProAgents - an AI-agnostic development workflow framework.
+
+## Command Recognition
+
+When the user types commands starting with `pa:`, recognize and execute them:
+
+### Core Commands
+| Command | Action |
+|---------|--------|
+| `pa:help` | Show all available commands |
+| `pa:feature "name"` | Start new feature workflow |
+| `pa:fix "description"` | Quick bug fix mode |
+| `pa:status` | Show current progress |
+
+### Documentation Commands
+| Command | Action |
+|---------|--------|
+| `pa:doc` | Show documentation options |
+| `pa:doc-full` | Generate full project documentation |
+| `pa:doc-moderate` | Generate balanced documentation |
+| `pa:doc-lite` | Generate quick reference |
+| `pa:doc-module [name]` | Document specific module |
+| `pa:doc-file [path]` | Document specific file |
+| `pa:doc-api` | Generate API documentation |
+| `pa:readme` | Generate/update README |
+| `pa:changelog` | Update CHANGELOG.md |
+| `pa:release` | Generate release notes |
+| `pa:release [version]` | Version-specific release notes |
+
+### Quality Commands
+| Command | Action |
+|---------|--------|
+| `pa:qa` | Run quality assurance checks |
+| `pa:test` | Run test workflow |
+| `pa:review` | Code review workflow |
+
+### Deployment Commands
+| Command | Action |
+|---------|--------|
+| `pa:deploy` | Deployment preparation |
+| `pa:rollback` | Rollback procedures |
+
+## How to Execute Commands
+
+When user types a `pa:` command:
+
+1. **Read the corresponding prompt file** from `./proagents/prompts/`
+2. **Follow the workflow** defined in that prompt
+3. **Use project context** from `./proagents/` folder
+
+### Prompt File Mapping
+- `pa:feature` → `./proagents/prompts/00-init.md` + workflow
+- `pa:fix` → `./proagents/workflow-modes/entry-modes.md` (Bug Fix section)
+- `pa:doc*` → `./proagents/prompts/07-documentation.md`
+- `pa:qa` → `./proagents/checklists/code-quality.md`
+- `pa:test` → `./proagents/prompts/06-testing.md`
+- `pa:deploy` → `./proagents/prompts/08-deployment.md`
+- `pa:release` → `./proagents/prompts/07-documentation.md` (Release Notes section)
+
+## Workflow Reference
+
+Full workflow documentation: `./proagents/WORKFLOW.md`
+Quick command reference: `./proagents/PROAGENTS.md`
+
+## Important
+
+- Always check `./proagents/` folder for project-specific configurations
+- Preserve user's `proagents.config.yaml` settings
+- Follow existing code patterns found in the project

package/proagents/CLAUDE.md

@@ -0,0 +1,33 @@
+# ProAgents Commands for Claude
+
+This project uses ProAgents. Recognize `pa:` commands:
+
+## Commands
+
+```
+pa:help              → Show all commands
+pa:feature "name"    → Start feature (read ./proagents/WORKFLOW.md)
+pa:fix "bug"         → Bug fix mode (read ./proagents/workflow-modes/entry-modes.md)
+pa:status            → Show progress
+pa:doc               → Documentation options
+pa:doc-full          → Full docs (read ./proagents/prompts/07-documentation.md)
+pa:doc-moderate      → Balanced docs
+pa:doc-lite          → Quick reference
+pa:qa                → Quality checks (read ./proagents/checklists/code-quality.md)
+pa:test              → Test workflow (read ./proagents/prompts/06-testing.md)
+pa:deploy            → Deployment (read ./proagents/prompts/08-deployment.md)
+pa:release           → Release notes
+pa:release [ver]     → Version-specific notes
+```
+
+## On `pa:` command
+
+1. Read the corresponding file in `./proagents/prompts/` or `./proagents/workflow-modes/`
+2. Follow the workflow instructions
+3. Use project config from `./proagents/proagents.config.yaml`
+
+## Key Files
+
+- `./proagents/WORKFLOW.md` - Full 10-phase workflow
+- `./proagents/PROAGENTS.md` - Quick command reference
+- `./proagents/prompts/` - Phase-specific prompts