autoworkflow 1.0.0 → 1.2.0

package/README.md

@@ -24,6 +24,9 @@ npm install autoworkflow
   │  ✓ Creates .husky/pre-commit     │
   │  ✓ Creates .husky/commit-msg     │
   │  ✓ Creates enforce.config.json   │
+  │  ✓ Creates CLAUDE.md             │
+  │  ✓ Creates .vscode/settings.json │
+  │  ✓ Creates .vscode/tasks.json    │
   │  ✓ Adds prepare script           │
   └──────────────────────────────────┘
          │
@@ -31,27 +34,32 @@ npm install autoworkflow
   Every "git commit" runs checks automatically
 ```
 
+**Note:** Existing files are never overwritten.
+
 ## Default Checks
 
-| Check | Blocking | Auto-Fix |
-|-------|----------|----------|
-| No TODO/FIXME comments | ✅ | - |
-| No console.log | ✅ | - |
-| TypeScript errors | ✅ | - |
-| ESLint errors | ✅ | ✅ |
-| Circular dependencies | ✅ | - |
-| Commit message format | ✅ | - |
+| Check                  | Blocking | Auto-Fix |
+| ---------------------- | -------- | -------- |
+| No TODO/FIXME comments | ✅       | -        |
+| No console.log         | ✅       | -        |
+| TypeScript errors      | ✅       | -        |
+| ESLint errors          | ✅       | ✅       |
+| Circular dependencies  | ✅       | -        |
+| Commit message format  | ✅       | -        |
 
 ## How It Works
 
 ### Pre-Commit Hook
+
 Every time you run `git commit`, autoworkflow:
+
 1. Runs all enabled checks
 2. If ESLint fails, auto-fixes and retries (up to 5 attempts)
 3. Blocks commit if any blocking check fails
 4. Allows commit if all checks pass
 
 ### Commit Message Validation
+
 Enforces [Conventional Commits](https://www.conventionalcommits.org/):
 
 ```bash
@@ -113,13 +121,13 @@ Edit `enforce.config.json` in your project root:
 
 ### Rule Options
 
-| Option | Type | Description |
-|--------|------|-------------|
-| `enabled` | boolean | Enable/disable the rule |
-| `blocking` | boolean | If true, fails the commit on violation |
-| `autoFix` | boolean | Enable auto-fix for this rule |
-| `command` | string | Custom check command |
-| `fixCommand` | string | Custom fix command |
+| Option       | Type    | Description                            |
+| ------------ | ------- | -------------------------------------- |
+| `enabled`    | boolean | Enable/disable the rule                |
+| `blocking`   | boolean | If true, fails the commit on violation |
+| `autoFix`    | boolean | Enable auto-fix for this rule          |
+| `command`    | string  | Custom check command                   |
+| `fixCommand` | string  | Custom fix command                     |
 
 ### Disable a Rule
 
@@ -193,12 +201,49 @@ Use sparingly. All skipped commits are your responsibility.
 - TypeScript >= 5.0.0 (for TypeScript checks)
 - ESLint >= 8.0.0 (for ESLint checks)
 
+## VSCode Integration
+
+### Auto-Fix on Save
+
+The generated `.vscode/settings.json` enables:
+
+- **Format on save** with Prettier
+- **ESLint auto-fix** on save
+- **Organize imports** on save
+- **Remove unused imports** on save
+- **Tailwind CSS** class sorting (clsx/cn support)
+
+### Quick Tasks (Cmd+Shift+B)
+
+The generated `.vscode/tasks.json` provides:
+
+| Task | Description |
+|------|-------------|
+| Autoworkflow: Run Checks | Run all enforcement checks |
+| Autoworkflow: TypeScript Check | TypeScript only |
+| Autoworkflow: ESLint Fix | Fix all ESLint issues |
+| Autoworkflow: List Rules | Show rule status |
+| Dev Server | Start npm run dev |
+| Quick Commit | Stage all + commit with prompt |
+
+## AI Integration (CLAUDE.md)
+
+The generated `CLAUDE.md` instructs Claude/AI assistants to:
+
+- Follow a structured workflow (Analyze → Plan → Confirm → Implement)
+- Show 3-tier suggestions (Required/Recommended/Optional)
+- Ask for confirmation before implementing
+- Use conventional commit messages
+- Respect all enforcement rules
+
 ## Uninstall
 
 ```bash
 npm uninstall autoworkflow
 rm -rf .husky
 rm enforce.config.json
+rm CLAUDE.md
+rm -rf .vscode  # Only if you want to remove VSCode settings
 ```
 
 ## License

package/lib/index.js

@@ -5,5 +5,5 @@
  */
 
 module.exports = {
-  version: '1.0.0',
+  version: '1.2.0',
 };

package/lib/install.js

@@ -192,6 +192,488 @@ function updatePackageJson(projectRoot) {
   }
 }
 
+function createClaudeMd(projectRoot) {
+  const claudePath = path.join(projectRoot, 'CLAUDE.md');
+
+  if (fs.existsSync(claudePath)) {
+    log(c.yellow, '  ⚠ CLAUDE.md already exists, skipping...');
+    return;
+  }
+
+  const claudeContent = `# CLAUDE.md - Agentic Workflow
+
+> **MANDATORY**: Follow this workflow for ALL coding tasks. No exceptions.
+
+## Workflow (REQUIRED)
+
+\`\`\`
+┌─────────────────────────────────────────────────────────────────┐
+│                     AGENTIC WORKFLOW                            │
+├─────────────────────────────────────────────────────────────────┤
+│                                                                 │
+│  1. ANALYZE   ──►  Read relevant files first                    │
+│       │                                                         │
+│       ▼                                                         │
+│  2. PLAN      ──►  Show plan + suggestions (3-tier)             │
+│       │                                                         │
+│       ▼                                                         │
+│  3. CONFIRM   ──►  "Should I proceed?" (WAIT for approval)      │
+│       │                                                         │
+│       ▼                                                         │
+│  4. IMPLEMENT ──►  Make changes (after approval only)           │
+│       │                                                         │
+│       ▼                                                         │
+│  5. VERIFY    ──►  npm run typecheck 2>&1 || true               │
+│       │                                                         │
+│       ├──► PASS ──► Continue to step 6                          │
+│       │                                                         │
+│       └──► FAIL ──► Fix errors → Re-verify (max 5 attempts)     │
+│                                                                 │
+│       ▼                                                         │
+│  6. COMMIT    ──►  git commit -m "type: description"            │
+│                    (autoworkflow runs all checks automatically) │
+│                                                                 │
+└─────────────────────────────────────────────────────────────────┘
+\`\`\`
+
+---
+
+## Blocking Rules (Enforced by autoworkflow)
+
+These rules are **automatically enforced** on every commit:
+
+| Rule | Blocking | Auto-Fix |
+|------|----------|----------|
+| No TODO/FIXME comments | ⛔ YES | NO |
+| No console.log statements | ⛔ YES | NO |
+| TypeScript errors | ⛔ YES | NO |
+| ESLint errors | ⛔ YES | YES (auto-fix loop) |
+| Circular dependencies | ⛔ YES | NO |
+| Conventional commits | ⛔ YES | NO |
+
+---
+
+## Suggestions System (3-Tier)
+
+For EVERY new feature or significant change, include a **Suggestions** section after your plan:
+
+\`\`\`
+💡 **Suggestions for Feature Completeness:**
+
+🔴 **Required** (must implement):
+- [ ] Error handling for [specific case]
+- [ ] Loading state for [async operation]
+- [ ] Input validation for [field]
+
+🟡 **Recommended** (improves quality):
+- [ ] Handle edge case: [scenario]
+- [ ] Add accessibility: [aria labels, keyboard nav]
+- [ ] Empty state handling
+
+🟢 **Optional** (nice to have):
+- [ ] Add tests for [component/function]
+- [ ] Performance optimization: [specific]
+- [ ] Add analytics tracking
+
+**Which suggestions should I include?** (all/required/none/1,2,4)
+\`\`\`
+
+### When to Show Suggestions
+
+| Task Type | Show Suggestions? |
+|-----------|-------------------|
+| New feature | ✅ Always |
+| New component | ✅ Always |
+| New page/route | ✅ Always |
+| Bug fix | ⚠️ Only if reveals missing handling |
+| Refactor | ⚠️ Only if scope expands |
+| Style changes | ❌ Skip |
+| Config changes | ❌ Skip |
+
+### Suggestion Checklist Reference
+
+**Functionality:**
+- [ ] Error states (API failures, network errors)
+- [ ] Loading states (spinners, skeletons)
+- [ ] Empty states (no data)
+- [ ] Success feedback (toasts, confirmations)
+
+**Edge Cases:**
+- [ ] Null/undefined data
+- [ ] Empty arrays/strings
+- [ ] Maximum limits (text length, file size)
+- [ ] Concurrent actions (double-click, race conditions)
+
+**User Experience:**
+- [ ] Form validation (client + server)
+- [ ] Keyboard navigation
+- [ ] Mobile responsiveness
+- [ ] Disabled states
+
+---
+
+## Confirmation Checkpoints
+
+### Checkpoint 1: Plan + Suggestions (BEFORE implementing)
+
+\`\`\`
+## Task: [description]
+
+### 1. Analysis
+[findings from codebase]
+
+### 2. Plan
+📋 **Proposed changes:**
+1. [Change 1]
+2. [Change 2]
+
+💡 **Suggestions for Feature Completeness:**
+
+🔴 **Required:**
+- [ ] Add error handling for API failure
+- [ ] Add loading state while fetching
+
+🟡 **Recommended:**
+- [ ] Add empty state when no results
+- [ ] Add keyboard shortcut
+
+🟢 **Optional:**
+- [ ] Add unit tests
+
+**Should I proceed?**
+**Which suggestions to include?** (all/required/none/1,2,4)
+\`\`\`
+
+### Checkpoint 2: Before Destructive Actions
+
+\`\`\`
+⚠️ **Warning:** This will [describe impact].
+Files affected: [list]
+**Should I proceed?**
+\`\`\`
+
+### Checkpoint 3: Before Commit
+
+\`\`\`
+✅ Verification passed.
+**Should I commit with message: "[message]"?**
+\`\`\`
+
+---
+
+## Verification Protocol
+
+### After EVERY Change
+
+\`\`\`bash
+npm run typecheck 2>&1 || true
+\`\`\`
+
+### Error Resolution (Max 5 Attempts)
+
+\`\`\`
+┌─────────────────────────────────────────────────────────────────┐
+│  VERIFICATION FAILED - Attempt [X/5]                            │
+├─────────────────────────────────────────────────────────────────┤
+│  Error: [error message]                                         │
+│  File:  [file path]                                             │
+│  Line:  [line number]                                           │
+├─────────────────────────────────────────────────────────────────┤
+│  Fix Applied: [what was changed]                                │
+│  Re-running verification...                                     │
+└─────────────────────────────────────────────────────────────────┘
+\`\`\`
+
+### If 5 Attempts Fail
+
+\`\`\`
+❌ VERIFICATION FAILED after 5 attempts.
+Remaining errors:
+1. [error 1]
+2. [error 2]
+
+**Need guidance on:** [specific question about the error]
+\`\`\`
+
+---
+
+## Commit Message Format
+
+Must follow conventional commits:
+
+\`\`\`bash
+# Valid formats
+feat: add user authentication
+fix(api): resolve timeout issue
+docs: update installation guide
+
+# Types: feat, fix, docs, style, refactor, perf, test, build, ci, chore, revert
+\`\`\`
+
+---
+
+## Anti-Patterns (NEVER DO)
+
+| ❌ Don't | ✅ Do Instead |
+|----------|---------------|
+| Implement without plan | Show plan + suggestions first |
+| Leave TODO comments | Complete the work or create issue |
+| Use console.log | Remove or use proper logging |
+| Skip verification | Always run \`npm run typecheck\` |
+| Batch multiple features | Complete one feature fully first |
+| Commit with errors | Fix all errors before commit |
+| Guess at solutions | Ask for clarification |
+
+---
+
+## Quick Reference
+
+**For new features:**
+\`\`\`
+Analyze → Plan + Suggestions → Confirm → Implement → Verify → Commit
+\`\`\`
+
+**For bug fixes:**
+\`\`\`
+Analyze → Plan → Confirm → Implement → Verify → Commit
+\`\`\`
+
+**Commands:**
+\`\`\`bash
+npm run typecheck    # Verify (REQUIRED after changes)
+npx autoworkflow run # Run all enforcement checks
+npx autoworkflow list # Show rule status
+\`\`\`
+
+---
+
+**VERIFY ALWAYS. SUGGEST COMPLETENESS. ASK BEFORE ACTIONS.**
+`;
+
+  fs.writeFileSync(claudePath, claudeContent);
+  log(c.green, '  ✓ Created CLAUDE.md');
+}
+
+function createVSCodeSettings(projectRoot) {
+  const vscodeDir = path.join(projectRoot, '.vscode');
+  const settingsPath = path.join(vscodeDir, 'settings.json');
+
+  // Create .vscode directory if it doesn't exist
+  if (!fs.existsSync(vscodeDir)) {
+    fs.mkdirSync(vscodeDir, { recursive: true });
+  }
+
+  if (fs.existsSync(settingsPath)) {
+    log(c.yellow, '  ⚠ .vscode/settings.json already exists, skipping...');
+    return;
+  }
+
+  const settings = {
+    // Editor - Format & Fix on Save
+    "editor.formatOnSave": true,
+    "editor.formatOnPaste": true,
+    "editor.codeActionsOnSave": {
+      "source.fixAll.eslint": "explicit",
+      "source.organizeImports": "explicit",
+      "source.removeUnusedImports": "explicit"
+    },
+    "editor.defaultFormatter": "esbenp.prettier-vscode",
+    "editor.tabSize": 2,
+    "editor.insertSpaces": true,
+    "editor.detectIndentation": false,
+    "editor.bracketPairColorization.enabled": true,
+    "editor.guides.bracketPairs": true,
+    "editor.linkedEditing": true,
+    "editor.suggest.preview": true,
+    "editor.inlineSuggest.enabled": true,
+
+    // TypeScript - Use workspace version, strict checking
+    "typescript.tsdk": "node_modules/typescript/lib",
+    "typescript.enablePromptUseWorkspaceTsdk": true,
+    "typescript.validate.enable": true,
+    "typescript.suggestionActions.enabled": true,
+    "typescript.preferences.importModuleSpecifier": "relative",
+    "typescript.updateImportsOnFileMove.enabled": "always",
+    "typescript.suggest.completeFunctionCalls": true,
+
+    // JavaScript
+    "javascript.updateImportsOnFileMove.enabled": "always",
+    "javascript.suggest.completeFunctionCalls": true,
+
+    // ESLint
+    "eslint.validate": ["javascript", "javascriptreact", "typescript", "typescriptreact"],
+    "eslint.codeActionsOnSave.mode": "all",
+    "eslint.run": "onType",
+
+    // Prettier
+    "[typescript]": { "editor.defaultFormatter": "esbenp.prettier-vscode" },
+    "[typescriptreact]": { "editor.defaultFormatter": "esbenp.prettier-vscode" },
+    "[javascript]": { "editor.defaultFormatter": "esbenp.prettier-vscode" },
+    "[javascriptreact]": { "editor.defaultFormatter": "esbenp.prettier-vscode" },
+    "[json]": { "editor.defaultFormatter": "esbenp.prettier-vscode" },
+    "[jsonc]": { "editor.defaultFormatter": "esbenp.prettier-vscode" },
+    "[markdown]": { "editor.defaultFormatter": "esbenp.prettier-vscode" },
+    "[css]": { "editor.defaultFormatter": "esbenp.prettier-vscode" },
+    "[scss]": { "editor.defaultFormatter": "esbenp.prettier-vscode" },
+    "[html]": { "editor.defaultFormatter": "esbenp.prettier-vscode" },
+
+    // Files
+    "files.autoSave": "onFocusChange",
+    "files.trimTrailingWhitespace": true,
+    "files.insertFinalNewline": true,
+    "files.trimFinalNewlines": true,
+    "files.associations": {
+      "*.css": "tailwindcss"
+    },
+    "files.exclude": {
+      "**/node_modules": true,
+      "**/.git": true,
+      "**/dist": true,
+      "**/.next": true,
+      "**/coverage": true
+    },
+
+    // Search
+    "search.exclude": {
+      "**/node_modules": true,
+      "**/dist": true,
+      "**/coverage": true,
+      "**/.next": true,
+      "**/package-lock.json": true
+    },
+
+    // Tailwind CSS
+    "tailwindCSS.experimental.classRegex": [
+      ["clsx\\(([^)]*)\\)", "(?:'|\"|`)([^']*)(?:'|\"|`)"],
+      ["cn\\(([^)]*)\\)", "(?:'|\"|`)([^']*)(?:'|\"|`)"],
+      ["cva\\(([^)]*)\\)", "[\"'`]([^\"'`]*).*?[\"'`]"]
+    ],
+    "tailwindCSS.includeLanguages": {
+      "typescript": "javascript",
+      "typescriptreact": "javascript"
+    },
+
+    // Terminal
+    "terminal.integrated.defaultProfile.osx": "zsh",
+    "terminal.integrated.scrollback": 10000,
+
+    // Git
+    "git.enableSmartCommit": true,
+    "git.confirmSync": false,
+    "git.autofetch": true,
+
+    // Explorer
+    "explorer.confirmDelete": false,
+    "explorer.confirmDragAndDrop": false,
+    "explorer.compactFolders": false
+  };
+
+  fs.writeFileSync(settingsPath, JSON.stringify(settings, null, 2));
+  log(c.green, '  ✓ Created .vscode/settings.json');
+}
+
+function createVSCodeTasks(projectRoot) {
+  const vscodeDir = path.join(projectRoot, '.vscode');
+  const tasksPath = path.join(vscodeDir, 'tasks.json');
+
+  // Create .vscode directory if it doesn't exist
+  if (!fs.existsSync(vscodeDir)) {
+    fs.mkdirSync(vscodeDir, { recursive: true });
+  }
+
+  if (fs.existsSync(tasksPath)) {
+    log(c.yellow, '  ⚠ .vscode/tasks.json already exists, skipping...');
+    return;
+  }
+
+  const tasks = {
+    "version": "2.0.0",
+    "tasks": [
+      {
+        "label": "Autoworkflow: Run Checks",
+        "type": "shell",
+        "command": "npx autoworkflow run",
+        "group": {
+          "kind": "build",
+          "isDefault": true
+        },
+        "presentation": {
+          "reveal": "always",
+          "panel": "shared",
+          "clear": true
+        },
+        "problemMatcher": ["$tsc", "$eslint-stylish"]
+      },
+      {
+        "label": "Autoworkflow: TypeScript Check",
+        "type": "shell",
+        "command": "npx tsc --noEmit",
+        "group": "build",
+        "presentation": {
+          "reveal": "always",
+          "panel": "shared"
+        },
+        "problemMatcher": "$tsc"
+      },
+      {
+        "label": "Autoworkflow: ESLint Fix",
+        "type": "shell",
+        "command": "npx eslint . --fix",
+        "group": "build",
+        "presentation": {
+          "reveal": "always",
+          "panel": "shared"
+        },
+        "problemMatcher": "$eslint-stylish"
+      },
+      {
+        "label": "Autoworkflow: List Rules",
+        "type": "shell",
+        "command": "npx autoworkflow list",
+        "group": "build",
+        "presentation": {
+          "reveal": "always",
+          "panel": "shared"
+        },
+        "problemMatcher": []
+      },
+      {
+        "label": "Dev Server",
+        "type": "shell",
+        "command": "npm run dev",
+        "group": "build",
+        "isBackground": true,
+        "presentation": {
+          "reveal": "always",
+          "panel": "dedicated"
+        },
+        "problemMatcher": []
+      },
+      {
+        "label": "Quick Commit",
+        "type": "shell",
+        "command": "git add -A && git commit -m '${input:commitMessage}'",
+        "group": "build",
+        "presentation": {
+          "reveal": "always",
+          "panel": "shared"
+        },
+        "problemMatcher": []
+      }
+    ],
+    "inputs": [
+      {
+        "id": "commitMessage",
+        "type": "promptString",
+        "description": "Commit message (e.g., 'feat: add dark mode')"
+      }
+    ]
+  };
+
+  fs.writeFileSync(tasksPath, JSON.stringify(tasks, null, 2));
+  log(c.green, '  ✓ Created .vscode/tasks.json');
+}
+
 function main() {
   console.log('');
   log(c.blue, '━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━');
@@ -231,6 +713,13 @@ function main() {
   // Update package.json
   updatePackageJson(projectRoot);
 
+  // Create CLAUDE.md for AI workflow
+  createClaudeMd(projectRoot);
+
+  // Create VSCode settings and tasks
+  createVSCodeSettings(projectRoot);
+  createVSCodeTasks(projectRoot);
+
   console.log('');
   log(c.green, '━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━');
   log(c.green, '✅ Setup complete!');
@@ -240,7 +729,12 @@ function main() {
   console.log('  git add .');
   console.log('  git commit -m "feat: your feature"');
   console.log('');
-  log(c.blue, 'Configuration: enforce.config.json');
+  log(c.blue, 'Files created:');
+  console.log('  • enforce.config.json - Rule configuration');
+  console.log('  • CLAUDE.md - AI workflow instructions');
+  console.log('  • .vscode/settings.json - Editor settings');
+  console.log('  • .vscode/tasks.json - Quick tasks (Cmd+Shift+B)');
+  console.log('');
   log(c.blue, 'CLI commands: npx autoworkflow --help');
   console.log('');
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "autoworkflow",
-  "version": "1.0.0",
+  "version": "1.2.0",
   "description": "Automatic code quality enforcement with fix loops, configurable rules, and Git hook integration",
   "keywords": [
     "git-hooks",