ready-to-ship 1.0.0

package/src/utils/fixHelpers.js

@@ -0,0 +1,203 @@
+const fs = require('fs-extra');
+const path = require('path');
+const { fileExists, readFile } = require('./fileHelpers');
+
+/**
+ * Generate auto-fix suggestions
+ */
+async function generateFixes(issues, projectPath) {
+  const fixes = [];
+  
+  issues.forEach(issue => {
+    const issueLower = issue.toLowerCase();
+    
+    // .env.example fixes
+    if (issueLower.includes('.env.example')) {
+      fixes.push({
+        type: 'create_file',
+        file: '.env.example',
+        content: generateEnvExampleTemplate(),
+        description: 'Create .env.example file'
+      });
+    }
+    
+    // README fixes
+    if (issueLower.includes('readme')) {
+      fixes.push({
+        type: 'create_file',
+        file: 'README.md',
+        content: generateReadmeTemplate(),
+        description: 'Create README.md file'
+      });
+    }
+    
+    // Weak secret fixes
+    if (issueLower.includes('weak secret')) {
+      const match = issue.match(/WEAK SECRET: (\w+)/);
+      if (match) {
+        fixes.push({
+          type: 'suggestion',
+          description: `Generate a strong ${match[1]} using: node -e "console.log(require('crypto').randomBytes(32).toString('hex'))"`
+        });
+      }
+    }
+    
+    // Missing env variable fixes
+    if (issueLower.includes('missing:')) {
+      const match = issue.match(/MISSING: (\w+)/);
+      if (match) {
+        fixes.push({
+          type: 'suggestion',
+          description: `Add ${match[1]} to your .env file`
+        });
+      }
+    }
+    
+    // Security headers fixes
+    if (issueLower.includes('security headers')) {
+      fixes.push({
+        type: 'suggestion',
+        description: 'Install and configure Helmet.js: npm install helmet && app.use(require("helmet")())'
+      });
+    }
+    
+    // CORS fixes
+    if (issueLower.includes('cors')) {
+      fixes.push({
+        type: 'suggestion',
+        description: 'Install and configure CORS: npm install cors && app.use(require("cors")({ origin: process.env.ALLOWED_ORIGINS?.split(",") }))'
+      });
+    }
+    
+    // Rate limiting fixes
+    if (issueLower.includes('rate limit')) {
+      fixes.push({
+        type: 'suggestion',
+        description: 'Install express-rate-limit: npm install express-rate-limit && app.use(require("express-rate-limit")({ windowMs: 15 * 60 * 1000, max: 100 }))'
+      });
+    }
+    
+    // Health endpoint fixes
+    if (issueLower.includes('health endpoint')) {
+      fixes.push({
+        type: 'suggestion',
+        description: 'Add health endpoint: app.get("/health", (req, res) => res.json({ status: "ok", timestamp: Date.now() }))'
+      });
+    }
+  });
+  
+  return fixes;
+}
+
+/**
+ * Generate .env.example template
+ */
+function generateEnvExampleTemplate() {
+  return `# Environment Variables
+# Copy this file to .env and fill in your values
+
+# Server
+PORT=3000
+NODE_ENV=development
+
+# Database
+DATABASE_URL=postgresql://user:password@localhost:5432/dbname
+
+# JWT
+JWT_SECRET=your-super-secret-jwt-key-min-32-chars
+JWT_EXPIRY=7d
+
+# CORS
+ALLOWED_ORIGINS=http://localhost:3000
+
+# API Keys (if needed)
+# API_KEY=your-api-key
+`;
+}
+
+/**
+ * Generate README template
+ */
+function generateReadmeTemplate() {
+  return `# Project Name
+
+Brief description of your project.
+
+## Installation
+
+\`\`\`bash
+npm install
+\`\`\`
+
+## Configuration
+
+Copy \`.env.example\` to \`.env\` and configure your environment variables.
+
+\`\`\`bash
+cp .env.example .env
+\`\`\`
+
+## Usage
+
+\`\`\`bash
+npm start
+\`\`\`
+
+## API Endpoints
+
+- \`GET /health\` - Health check endpoint
+
+## License
+
+MIT
+`;
+}
+
+/**
+ * Apply fixes (with user confirmation in real usage)
+ */
+async function applyFixes(fixes, projectPath, dryRun = true) {
+  const results = [];
+  
+  for (const fix of fixes) {
+    if (fix.type === 'create_file') {
+      const filePath = path.join(projectPath, fix.file);
+      const exists = await fileExists(filePath);
+      
+      if (exists && !dryRun) {
+        results.push({
+          fix,
+          status: 'skipped',
+          reason: 'File already exists'
+        });
+      } else if (dryRun) {
+        results.push({
+          fix,
+          status: 'would_create',
+          filePath
+        });
+      } else {
+        await fs.writeFile(filePath, fix.content);
+        results.push({
+          fix,
+          status: 'created',
+          filePath
+        });
+      }
+    } else if (fix.type === 'suggestion') {
+      results.push({
+        fix,
+        status: 'suggestion',
+        description: fix.description
+      });
+    }
+  }
+  
+  return results;
+}
+
+module.exports = {
+  generateFixes,
+  applyFixes
+};
+

package/src/utils/logHelpers.js

@@ -0,0 +1,77 @@
+const chalk = require('chalk');
+
+/**
+ * Print success message
+ */
+function success(message) {
+  console.log(chalk.green('✅'), message);
+}
+
+/**
+ * Print error message
+ */
+function error(message) {
+  console.log(chalk.red('❌'), message);
+}
+
+/**
+ * Print warning message
+ */
+function warning(message) {
+  console.log(chalk.yellow('⚠️'), message);
+}
+
+/**
+ * Print info message
+ */
+function info(message) {
+  console.log(chalk.blue('ℹ️'), message);
+}
+
+/**
+ * Print section header
+ */
+function header(message) {
+  console.log(chalk.bold.cyan('\n' + '='.repeat(50)));
+  console.log(chalk.bold.cyan(message));
+  console.log(chalk.bold.cyan('='.repeat(50) + '\n'));
+}
+
+/**
+ * Print verdict
+ */
+function verdict(passed, message) {
+  if (passed) {
+    console.log(chalk.bold.green('\n✅ ' + message));
+  } else {
+    console.log(chalk.bold.red('\n❌ ' + message));
+  }
+}
+
+/**
+ * Print list of issues
+ */
+function printIssues(issues, type = 'error') {
+  if (issues.length === 0) return;
+  
+  issues.forEach(issue => {
+    if (type === 'error') {
+      error(issue);
+    } else if (type === 'warning') {
+      warning(issue);
+    } else {
+      info(issue);
+    }
+  });
+}
+
+module.exports = {
+  success,
+  error,
+  warning,
+  info,
+  header,
+  verdict,
+  printIssues
+};
+

package/src/utils/parseHelpers.js

@@ -0,0 +1,151 @@
+/**
+ * Check if string is a valid URL
+ */
+function isValidUrl(str) {
+  try {
+    new URL(str);
+    return true;
+  } catch {
+    return false;
+  }
+}
+
+/**
+ * Check if string is a valid email
+ */
+function isValidEmail(str) {
+  const emailRegex = /^[^\s@]+@[^\s@]+\.[^\s@]+$/;
+  return emailRegex.test(str);
+}
+
+/**
+ * Check if string is a valid number
+ */
+function isValidNumber(str) {
+  return !isNaN(str) && !isNaN(parseFloat(str));
+}
+
+/**
+ * Extract route definitions from code
+ */
+function extractRoutes(code) {
+  const routes = [];
+  
+  // Match common route patterns
+  const patterns = [
+    /(?:app|router)\.(get|post|put|delete|patch)\s*\(['"`]([^'"`]+)['"`]/g,
+    /(?:app|router)\.(get|post|put|delete|patch)\s*\(['"`]([^'"`]+)['"`]/g,
+    /Route\.(get|post|put|delete|patch)\s*\(['"`]([^'"`]+)['"`]/g,
+  ];
+  
+  patterns.forEach(pattern => {
+    let match;
+    while ((match = pattern.exec(code)) !== null) {
+      routes.push({
+        method: match[1].toUpperCase(),
+        path: match[2],
+        line: code.substring(0, match.index).split('\n').length
+      });
+    }
+  });
+  
+  return routes;
+}
+
+/**
+ * Check if route has auth middleware
+ */
+function hasAuthMiddleware(code, routeIndex) {
+  const lines = code.split('\n');
+  const routeLine = lines[routeIndex - 1] || '';
+  
+  // Check for common auth middleware patterns
+  const authPatterns = [
+    /authenticate|auth|jwt|verifyToken|requireAuth|isAuthenticated/i,
+    /passport\.authenticate/,
+    /middleware.*auth/i
+  ];
+  
+  // Check the route line and a few lines before/after
+  const context = lines.slice(Math.max(0, routeIndex - 3), routeIndex + 3).join('\n');
+  
+  return authPatterns.some(pattern => pattern.test(context));
+}
+
+/**
+ * Extract middleware usage
+ */
+function extractMiddleware(code) {
+  const middleware = [];
+  const patterns = [
+    /\.use\s*\(['"`]([^'"`]+)['"`]/g,
+    /\.use\s*\(([a-zA-Z_$][a-zA-Z0-9_$]*)/g
+  ];
+  
+  patterns.forEach(pattern => {
+    let match;
+    while ((match = pattern.exec(code)) !== null) {
+      middleware.push(match[1]);
+    }
+  });
+  
+  return middleware;
+}
+
+/**
+ * Check if code has error handling
+ */
+function hasErrorHandling(code) {
+  const errorPatterns = [
+    /catch\s*\(/,
+    /\.catch\s*\(/,
+    /errorHandler|error-handler|errorMiddleware/i,
+    /express\.errorHandler/,
+    /app\.use.*error/i
+  ];
+  
+  return errorPatterns.some(pattern => pattern.test(code));
+}
+
+/**
+ * Check JWT expiry configuration
+ */
+function extractJWTExpiry(code) {
+  const patterns = [
+    /expiresIn\s*[:=]\s*['"`]?(\d+)\s*([a-z]+)['"`]?/i,
+    /expiresIn\s*[:=]\s*(\d+)/i,
+    /JWT_EXPIRY\s*[:=]\s*['"`]?(\d+)\s*([a-z]+)['"`]?/i
+  ];
+  
+  for (const pattern of patterns) {
+    const match = code.match(pattern);
+    if (match) {
+      const value = parseInt(match[1]);
+      const unit = (match[2] || 's').toLowerCase();
+      
+      // Convert to seconds
+      let seconds = value;
+      if (unit.includes('year') || unit === 'y') seconds = value * 365 * 24 * 60 * 60;
+      else if (unit.includes('month') || unit === 'm') seconds = value * 30 * 24 * 60 * 60;
+      else if (unit.includes('day') || unit === 'd') seconds = value * 24 * 60 * 60;
+      else if (unit.includes('hour') || unit === 'h') seconds = value * 60 * 60;
+      else if (unit.includes('minute') || unit === 'min') seconds = value * 60;
+      
+      return seconds;
+    }
+  }
+  
+  return null;
+}
+
+module.exports = {
+  isValidUrl,
+  isValidEmail,
+  isValidNumber,
+  extractRoutes,
+  hasAuthMiddleware,
+  extractMiddleware,
+  hasErrorHandling,
+  extractJWTExpiry
+};
+

package/templates/.github/workflows/ready-to-ship.yml

@@ -0,0 +1,35 @@
+name: Ready-to-Ship Validation
+
+on:
+  push:
+    branches: [ main, master, develop ]
+  pull_request:
+    branches: [ main, master, develop ]
+
+jobs:
+  validate:
+    runs-on: ubuntu-latest
+    
+    steps:
+    - uses: actions/checkout@v3
+    
+    - name: Setup Node.js
+      uses: actions/setup-node@v3
+      with:
+        node-version: '18'
+        cache: 'npm'
+    
+    - name: Install dependencies
+      run: npm ci
+    
+    - name: Run Ready-to-Ship
+      run: npx ready-to-ship report --json
+      continue-on-error: true
+    
+    - name: Upload report
+      uses: actions/upload-artifact@v3
+      if: always()
+      with:
+        name: ready-to-ship-report
+        path: ready-to-ship-report.json
+

package/templates/README.md

@@ -0,0 +1,23 @@
+# Templates
+
+This directory contains ready-to-use templates for CI/CD integration.
+
+## GitHub Actions
+
+Copy `github-actions.yml` to `.github/workflows/ready-to-ship.yml` in your project:
+
+```bash
+mkdir -p .github/workflows
+cp templates/github-actions.yml .github/workflows/ready-to-ship.yml
+```
+
+This will automatically run Ready-to-Ship validation on every push and PR.
+
+## Customization
+
+You can customize the workflow to:
+- Run only on specific branches
+- Add notifications (Slack, email)
+- Upload reports as artifacts
+- Block merges if validation fails
+

package/templates/github-actions.yml

@@ -0,0 +1,35 @@
+name: Ready-to-Ship Validation
+
+on:
+  push:
+    branches: [ main, master, develop ]
+  pull_request:
+    branches: [ main, master, develop ]
+
+jobs:
+  validate:
+    runs-on: ubuntu-latest
+    
+    steps:
+    - uses: actions/checkout@v3
+    
+    - name: Setup Node.js
+      uses: actions/setup-node@v3
+      with:
+        node-version: '18'
+        cache: 'npm'
+    
+    - name: Install dependencies
+      run: npm ci
+    
+    - name: Run Ready-to-Ship
+      run: npx ready-to-ship report --json
+      continue-on-error: true
+    
+    - name: Upload report
+      uses: actions/upload-artifact@v3
+      if: always()
+      with:
+        name: ready-to-ship-report
+        path: ready-to-ship-report.json
+