code-quality-lib 1.0.4 → 1.1.0

package/README.md

@@ -18,6 +18,9 @@
 - ⚙️ Configurable tools and commands
 - 📚 TypeScript definitions included
 - 🔧 CLI and library usage
+- 📄 Detailed error reports for developers and AI agents
+- 🔍 --logs flag for verbose terminal output
+- 🤖 AI-friendly structured error information
 
 ## Installation
 
@@ -91,6 +94,9 @@ yarn add -D code-quality-lib && yarn code-quality
 # Run all quality checks
 code-quality
 
+# Run with detailed error logs in terminal
+code-quality --logs
+
 # Or use with npx (without installing)
 npx code-quality-lib
 
@@ -101,6 +107,28 @@ bunx code-quality-lib
 yarn code-quality
 ```
 
+### Error Reporting
+
+The library automatically generates a detailed error report at `.quality-report.md` with:
+- ✅ Status of each quality check
+- 📋 Full error output for failed checks
+- 💡 Suggestions for fixing common issues
+- 🤖 AI-friendly structured information
+
+**Viewing Errors:**
+```bash
+# Silent mode (default) - errors saved to .quality-report.md
+code-quality
+
+# Verbose mode - errors shown in terminal + saved to report
+code-quality --logs
+
+# View the report
+cat .quality-report.md
+```
+
+**Note:** Add `.quality-report.md` to your `.gitignore` to keep reports local only.
+
 ### As a Library
 
 ```javascript

package/index.js

@@ -4,6 +4,10 @@ const { execSync } = require('child_process');
 const path = require('path');
 const fs = require('fs');
 
+// Parse command line arguments
+const args = process.argv.slice(2);
+const showLogs = args.includes('--logs');
+
 // Load environment variables from .env file
 function loadEnvFile() {
   try {
@@ -29,326 +33,155 @@ function loadEnvFile() {
   }
 }
 
-// Check if this is first run and setup configuration
-function checkFirstRun() {
-  const configPath = path.join(process.cwd(), '.code-quality.json');
-  
-  if (!fs.existsSync(configPath)) {
-    colorLog('\n🔧 Code Quality Library - First Time Setup', 'bright');
-    colorLog('─'.repeat(50), 'cyan');
-    colorLog('\nChoose your quality rules configuration:', 'yellow');
-    colorLog('1) Use library rules (recommended for new projects)', 'white');
-    colorLog('2) Use project rules (keep existing configurations)', 'white');
-    colorLog('3) Custom setup (choose specific tools)', 'white');
-    
-    // For now, default to library rules
-    // In a real implementation, you would read user input here
-    const choice = process.env.CODE_QUALITY_CHOICE || '1';
-    
-    const config = {
-      useLibraryRules: choice === '1',
-      useProjectRules: choice === '2',
-      customSetup: choice === '3',
-      tools: ['TypeScript', 'ESLint', 'Prettier', 'Knip', 'Snyk'],
-      copyConfigs: choice === '1',
-      version: '1.0.1'
-    };
-    
-    fs.writeFileSync(configPath, JSON.stringify(config, null, 2));
-    
-    if (choice === '1') {
-      colorLog('\n✅ Using library rules - Config files will be copied', 'green');
-    } else if (choice === '2') {
-      colorLog('\n✅ Using project rules - Existing configs preserved', 'green');
-    } else {
-      colorLog('\n✅ Custom setup - Configure as needed', 'green');
-    }
-    
-    colorLog('\n💡 To change this later, edit: .code-quality.json', 'cyan');
-    colorLog('💡 Or run: code-quality --config to reconfigure', 'cyan');
-    colorLog('─'.repeat(50), 'cyan');
-    
-    return config;
-  }
-  
-  try {
-    return JSON.parse(fs.readFileSync(configPath, 'utf8'));
-  } catch (error) {
-    colorLog('⚠️  Invalid config file, using defaults', 'yellow');
-    return {
-      useLibraryRules: true,
-      useProjectRules: false,
-      customSetup: false,
-      tools: ['TypeScript', 'ESLint', 'Prettier', 'Knip', 'Snyk'],
-      copyConfigs: true
-    };
-  }
-}
+loadEnvFile();
 
-// Copy config files from library to project
-function copyConfigFiles(packageManager) {
-  const libPath = path.dirname(__dirname);
-  const projectPath = process.cwd();
-  
-  const configs = [
-    { src: '.eslintrc.js', dest: '.eslintrc.js' },
-    { src: '.prettierrc', dest: '.prettierrc' },
-    { src: 'knip.json', dest: 'knip.json' },
-    { src: 'tsconfig.json', dest: 'tsconfig.json' }
-  ];
-  
-  configs.forEach(({ src, dest }) => {
-    const srcPath = path.join(libPath, src);
-    const destPath = path.join(projectPath, dest);
-    
-    try {
-      if (fs.existsSync(srcPath)) {
-        fs.copyFileSync(srcPath, destPath);
-        colorLog(`✅ Copied ${dest}`, 'green');
-      }
-    } catch (error) {
-      colorLog(`⚠️  Could not copy ${dest}: ${error.message}`, 'yellow');
-    }
-  });
-}
+console.log('\n🔍 Professional Code Quality Check\n');
+console.log('─'.repeat(50));
+console.log('📦 Using bun package manager\n');
 
-// Color codes for beautiful output
-const colors = {
-  reset: '\x1b[0m',
-  bright: '\x1b[1m',
-  red: '\x1b[31m',
-  green: '\x1b[32m',
-  yellow: '\x1b[33m',
-  blue: '\x1b[34m',
-  magenta: '\x1b[35m',
-  cyan: '\x1b[36m',
-  white: '\x1b[37m',
-  dim: '\x1b[2m',
-  header: '\x1b[1m\x1b[36m'
-};
-
-function colorLog(message, color = 'reset') {
-  console.log(`${colors[color]}${message}${colors.reset}`);
+if (showLogs) {
+  console.log('📋 Detailed error logging enabled (--logs flag)\n');
 }
 
-// Detect package manager
-function detectPackageManager() {
-  const cwd = process.cwd();
+// Prepare report
+const reportPath = path.join(process.cwd(), '.quality-report.md');
+const timestamp = new Date().toISOString();
+let reportContent = `# Code Quality Report\n\n`;
+reportContent += `**Generated**: ${timestamp}\n`;
+reportContent += `**Package Manager**: bun\n\n`;
+reportContent += `---\n\n`;
+
+// Run quality checks
+const checks = [
+  { name: 'TypeScript', cmd: 'npx tsc --noEmit', description: 'Type checking and compilation' },
+  { name: 'ESLint', cmd: 'npx eslint . --ext .js,.jsx,.ts,.tsx', description: 'Code linting and style checking' },
+  { name: 'Prettier', cmd: 'npx prettier --check .', description: 'Code formatting validation' },
+  { name: 'Knip', cmd: 'npx knip', description: 'Dead code detection' },
+  { name: 'Snyk', cmd: 'npx snyk test --severity-threshold=high', description: 'Security vulnerability scanning' }
+];
+
+let allPassed = true;
+const results = [];
+
+checks.forEach(({ name, cmd, description }) => {
+  console.log(`Running ${name}...`);
   
-  if (fs.existsSync(path.join(cwd, 'bun.lockb'))) {
-    return 'bun';
-  } else if (fs.existsSync(path.join(cwd, 'pnpm-lock.yaml'))) {
-    return 'pnpm';
-  } else if (fs.existsSync(path.join(cwd, 'yarn.lock'))) {
-    return 'yarn';
-  } else if (fs.existsSync(path.join(cwd, 'package-lock.json'))) {
-    return 'npm';
-  }
+  reportContent += `## ${name}\n\n`;
+  reportContent += `**Description**: ${description}\n\n`;
+  reportContent += `**Command**: \`${cmd}\`\n\n`;
   
-  // Default to npm if no lock file found
-  return 'npm';
-}
-
-// Get package manager run command
-function getRunCommand(packageManager) {
-  switch (packageManager) {
-    case 'bun': return 'bun run';
-    case 'pnpm': return 'pnpm run';
-    case 'yarn': return 'yarn';
-    case 'npm': return 'npm run';
-    default: return 'npm run';
-  }
-}
-
-// Get package manager exec command
-function getExecCommand(packageManager) {
-  switch (packageManager) {
-    case 'bun': return 'bunx';
-    case 'pnpm': return 'pnpm dlx';
-    case 'yarn': return 'yarn dlx';
-    case 'npm': return 'npx';
-    default: return 'npx';
-  }
-}
-
-// Main class for the library
-class CodeQualityChecker {
-  constructor(options = {}) {
-    // Check first run configuration
-    const config = checkFirstRun();
-    
-    this.options = {
-      loadEnv: true,
-      tools: config.tools || ['TypeScript', 'ESLint', 'Prettier', 'Knip', 'Snyk'],
-      packageManager: detectPackageManager(),
-      copyConfigs: config.copyConfigs !== false,
-      useLibraryRules: config.useLibraryRules !== false,
-      useProjectRules: config.useProjectRules || false,
-      customSetup: config.customSetup || false,
-      ...options
-    };
+  try {
+    const output = execSync(cmd, { stdio: 'pipe', encoding: 'utf8' });
+    console.log(`✅ ${name}: Passed`);
     
-    if (this.options.loadEnv) {
-      loadEnvFile();
+    reportContent += `**Status**: ✅ **PASSED**\n\n`;
+    if (output && output.trim()) {
+      reportContent += `**Output**:\n\`\`\`\n${output.trim()}\n\`\`\`\n\n`;
+      
+      if (showLogs) {
+        console.log(`\n📄 ${name} Output:`);
+        console.log(output.trim());
+        console.log('');
+      }
     }
     
-    if (this.options.copyConfigs && this.options.useLibraryRules) {
-      copyConfigFiles(this.options.packageManager);
-    }
-  }
-
-  runCommand(command, description) {
-    const startTime = Date.now();
-    const result = {
-      success: true,
-      message: ''
-    };
+    results.push({ name, status: 'passed', output: output.trim() });
+  } catch (error) {
+    allPassed = false;
+    const errorOutput = error.stdout || error.stderr || error.message || 'Unknown error';
+    console.log(`❌ ${name}: Failed`);
     
-    try {
-      const output = execSync(command, { encoding: 'utf8' });
-      result.message = output.trim();
-    } catch (error) {
-      result.success = false;
-      result.message = error.stdout.trim();
+    // Show errors in terminal if --logs flag is present
+    if (showLogs) {
+      console.log(`\n❌ ${name} Error Details:`);
+      console.log('─'.repeat(50));
+      console.log(errorOutput.trim());
+      console.log('─'.repeat(50));
+      console.log('');
     }
     
-    const endTime = Date.now();
-    const duration = (endTime - startTime) / 1000;
-    
-    return {
-      ...result,
-      duration
-    };
-  }
-
-  formatOutput(tool, result) {
-    return formatOutput(tool, result);
-  }
-
-  checkSnykToken() {
-    return checkSnykToken();
-  }
-
-  async run() {
-    console.log(colors.header('\n🔍 Professional Code Quality Check\n'));
-    console.log(colors.dim('─'.repeat(50)));
+    reportContent += `**Status**: ❌ **FAILED**\n\n`;
+    reportContent += `**Error Output**:\n\`\`\`\n${errorOutput.trim()}\n\`\`\`\n\n`;
     
-    // Show detected package manager
-    console.log(colors.dim(`📦 Using ${this.options.packageManager} package manager`));
-
-    // Check Snyk authentication first
-    const snykAuthenticated = this.checkSnykToken();
-
-    const results = this.options.tools.map(tool => ({
-      tool,
-      command: tool === 'Snyk' && !snykAuthenticated
-        ? `echo "Authentication required - add SNYK_TOKEN to .env or run ${getExecCommand(this.options.packageManager)} snyk auth"`
-        : this.options.commands[tool],
-      description: this.options.descriptions[tool]
-    }));
-
-    let allPassed = true;
-    const outputs = [];
-
-    for (const { tool, command, description } of results) {
-      const result = this.runCommand(command, description);
-      const output = this.formatOutput(tool, result);
-      outputs.push(output);
-      if (!result.success) {
-        allPassed = false;
-      }
-    }
-
-    const args = process.argv.slice(2);
-    for (const arg of args) {
-      if (arg === '--no-configs') {
-        this.options.copyConfigs = false;
-      } else if (arg === '--config') {
-        this.options.reconfigure = true;
-      }
-    }
-
-    console.log('\n');
-    outputs.forEach((output) => console.log(output));
-
-    console.log(colors.dim('─'.repeat(50)));
-
-    if (allPassed) {
-      console.log(
-        '\n🎉 All quality checks passed! Code is ready for production.\n'
-      );
-      return { success: true, message: 'All checks passed' };
-    } else {
-      console.log(
-        '\n❌ Some quality checks failed. Please fix the issues above.\n'
-      );
-      return { success: false, message: 'Some checks failed' };
+    // Add suggestions for common issues
+    reportContent += `**Suggestions**:\n`;
+    if (name === 'TypeScript') {
+      reportContent += `- Check type errors in the output above\n`;
+      reportContent += `- Run \`npx tsc --noEmit\` to see detailed errors\n`;
+      reportContent += `- Fix type mismatches and missing type definitions\n`;
+    } else if (name === 'ESLint') {
+      reportContent += `- Run \`bun run lint:fix\` to auto-fix issues\n`;
+      reportContent += `- Check ESLint errors in the output above\n`;
+      reportContent += `- Review and fix code style violations\n`;
+    } else if (name === 'Prettier') {
+      reportContent += `- Run \`bun run format:fix\` to auto-format files\n`;
+      reportContent += `- Check formatting issues in the output above\n`;
+    } else if (name === 'Knip') {
+      reportContent += `- Remove unused exports and dependencies\n`;
+      reportContent += `- Check dead code in the output above\n`;
+    } else if (name === 'Snyk') {
+      reportContent += `- Review security vulnerabilities in the output above\n`;
+      reportContent += `- Update vulnerable dependencies\n`;
+      reportContent += `- Run \`npx snyk wizard\` for guided fixes\n`;
     }
+    reportContent += `\n`;
+    
+    results.push({ name, status: 'failed', error: errorOutput.trim() });
   }
+  
+  reportContent += `---\n\n`;
+});
+
+// Add summary
+reportContent += `## Summary\n\n`;
+reportContent += `**Total Checks**: ${checks.length}\n`;
+reportContent += `**Passed**: ${results.filter(r => r.status === 'passed').length}\n`;
+reportContent += `**Failed**: ${results.filter(r => r.status === 'failed').length}\n\n`;
+
+if (allPassed) {
+  reportContent += `### ✅ All quality checks passed!\n\n`;
+  reportContent += `Your code is ready for production.\n\n`;
+} else {
+  reportContent += `### ❌ Some quality checks failed\n\n`;
+  reportContent += `Please review the errors above and fix the issues.\n\n`;
+  reportContent += `**Quick Fix Commands**:\n`;
+  reportContent += `- \`bun run fix\` - Auto-fix linting and formatting\n`;
+  reportContent += `- \`bun run type:check\` - Check TypeScript errors\n`;
+  reportContent += `- \`bun run lint:check\` - Check ESLint errors\n`;
+  reportContent += `- \`bun run format:check\` - Check Prettier formatting\n\n`;
 }
 
-// Export both the class and a simple function
-module.exports = { CodeQualityChecker };
-
-// If run directly, execute with default options
-if (require.main === module) {
-  const args = process.argv.slice(2);
-  const options = {};
-  
-  // Check for reconfigure flag
-  if (args.includes('--config')) {
-    // Remove existing config and run setup again
-    const configPath = path.join(process.cwd(), '.code-quality.json');
-    if (fs.existsSync(configPath)) {
-      fs.unlinkSync(configPath);
-      colorLog('🔧 Configuration reset - Running setup again', 'yellow');
-    }
-  }
-  
-  // Parse command line arguments
-  for (let i = 0; i < args.length; i++) {
-    const arg = args[i];
-    if (arg === '--no-env') {
-      options.loadEnv = false;
-    } else if (arg === '--no-configs') {
-      options.copyConfigs = false;
-    } else if (arg.startsWith('--tools=')) {
-      options.tools = arg.split('=')[1].split(',');
-    } else if (arg === '--help' || arg === '-h') {
-      console.log(`
-Professional Code Quality Checker
+// Add AI Agent section
+reportContent += `---\n\n`;
+reportContent += `## For AI Agents\n\n`;
+reportContent += `This report contains detailed error information for automated code quality fixes.\n\n`;
+reportContent += `**Failed Checks**: ${results.filter(r => r.status === 'failed').map(r => r.name).join(', ') || 'None'}\n\n`;
+if (!allPassed) {
+  reportContent += `**Action Required**:\n`;
+  results.filter(r => r.status === 'failed').forEach(r => {
+    reportContent += `- Fix ${r.name} errors\n`;
+  });
+  reportContent += `\n`;
+}
 
-Usage: code-quality [options]
+// Write report to file (overwrite existing)
+try {
+  fs.writeFileSync(reportPath, reportContent, 'utf8');
+  console.log(`\n📄 Quality report saved to: .quality-report.md`);
+} catch (error) {
+  console.error(`\n⚠️  Failed to write report: ${error.message}`);
+}
 
-Options:
-  --no-env          Skip loading .env file
-  --no-configs      Skip copying config files
-  --config          Reconfigure setup choices
-  --tools=tools     Comma-separated list of tools to run
-                    (TypeScript,ESLint,Prettier,Knip,Snyk)
-  --help, -h        Show this help message
+console.log('\n' + '─'.repeat(50));
 
-Examples:
-  code-quality                    # Run all tools
-  code-quality --tools=ESLint     # Run only ESLint
-  code-quality --no-env           # Skip .env loading
-  code-quality --config           # Reconfigure setup
-      `);
-      process.exit(0);
-    }
+if (allPassed) {
+  console.log('\n🎉 All quality checks passed! Code is ready for production.\n');
+  process.exit(0);
+} else {
+  console.log('\n❌ Some quality checks failed. Please fix the issues above.\n');
+  if (!showLogs) {
+    console.log('💡 Run with --logs flag to see detailed errors in terminal');
   }
-  
-  if (args.includes('--version') || args.includes('-v')) {
-    const pkg = require('./package.json');
-    console.log(pkg.version);
-    process.exit(0);
-  }
-  
-  const checker = new CodeQualityChecker(options);
-  checker.run().then(({ success }) => {
-    process.exit(success ? 0 : 1);
-  }).catch(error => {
-    console.error('Error running quality checks:', error);
-    process.exit(1);
-  });
+  console.log('📄 See .quality-report.md for detailed error information\n');
+  process.exit(1);
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "code-quality-lib",
-  "version": "1.0.4",
+  "version": "1.1.0",
   "description": "A configurable code quality checker library for Node.js projects",
   "main": "index.js",
   "bin": {