@objectstack/cli 4.0.4 → 4.1.0

package/src/commands/doctor.ts

@@ -1,572 +0,0 @@
-// Copyright (c) 2025 ObjectStack. Licensed under the Apache-2.0 license.
-
-import { Command, Flags } from '@oclif/core';
-import chalk from 'chalk';
-import { execSync } from 'child_process';
-import fs from 'fs';
-import path from 'path';
-import { normalizeStackInput } from '@objectstack/spec';
-import { printHeader, printSuccess, printWarning, printError, printStep, printInfo } from '../utils/format.js';
-import { loadConfig, configExists } from '../utils/config.js';
-
-interface HealthCheckResult {
-  name: string;
-  status: 'ok' | 'warning' | 'error';
-  message: string;
-  fix?: string;
-}
-
-// ─── Config-Aware Checks ────────────────────────────────────────────
-
-function detectCircularDependencies(objects: any[]): string[] {
-  const issues: string[] = [];
-  const graph = new Map<string, string[]>();
-
-  for (const obj of objects) {
-    const deps: string[] = [];
-    if (obj.fields && typeof obj.fields === 'object') {
-      for (const field of Object.values(obj.fields) as any[]) {
-        if (field?.type === 'lookup' && field?.reference) {
-          deps.push(field.reference);
-        }
-      }
-    }
-    graph.set(obj.name, deps);
-  }
-
-  // DFS cycle detection
-  const visited = new Set<string>();
-  const stack = new Set<string>();
-
-  function dfs(node: string, path: string[]): boolean {
-    if (stack.has(node)) {
-      const cycleStart = path.indexOf(node);
-      const cycle = path.slice(cycleStart).concat(node);
-      issues.push(`Circular dependency: ${cycle.join(' → ')}`);
-      return true;
-    }
-    if (visited.has(node)) return false;
-
-    visited.add(node);
-    stack.add(node);
-
-    for (const dep of graph.get(node) || []) {
-      if (graph.has(dep)) {
-        dfs(dep, [...path, node]);
-      }
-    }
-
-    stack.delete(node);
-    return false;
-  }
-
-  for (const name of graph.keys()) {
-    if (!visited.has(name)) {
-      dfs(name, []);
-    }
-  }
-
-  return issues;
-}
-
-function findOrphanViews(config: any): string[] {
-  const objectNames = new Set<string>();
-  if (Array.isArray(config.objects)) {
-    for (const obj of config.objects) {
-      if (obj.name) objectNames.add(obj.name);
-    }
-  }
-
-  const orphans: string[] = [];
-  if (Array.isArray(config.views)) {
-    for (const view of config.views) {
-      if (view.object && !objectNames.has(view.object)) {
-        orphans.push(`View "${view.name || '?'}" references non-existent object "${view.object}"`);
-      }
-    }
-  }
-  return orphans;
-}
-
-function findUnusedObjects(config: any): string[] {
-  const objectNames = new Set<string>();
-  if (Array.isArray(config.objects)) {
-    for (const obj of config.objects) {
-      if (obj.name) objectNames.add(obj.name);
-    }
-  }
-
-  const referencedObjects = new Set<string>();
-
-  // Views reference objects
-  if (Array.isArray(config.views)) {
-    for (const view of config.views) {
-      if (view.object) referencedObjects.add(view.object);
-    }
-  }
-
-  // Flows may reference objects via trigger
-  if (Array.isArray(config.flows)) {
-    for (const flow of config.flows) {
-      if (flow.trigger?.object) referencedObjects.add(flow.trigger.object);
-      if (flow.object) referencedObjects.add(flow.object);
-    }
-  }
-
-  // Apps may reference objects via navigation
-  if (Array.isArray(config.apps)) {
-    for (const app of config.apps) {
-      if (Array.isArray(app.navigation)) {
-        for (const nav of app.navigation) {
-          if (nav.object) referencedObjects.add(nav.object);
-        }
-      }
-    }
-  }
-
-  // Agents may reference objects
-  if (Array.isArray(config.agents)) {
-    for (const agent of config.agents) {
-      if (Array.isArray(agent.objects)) {
-        for (const o of agent.objects) referencedObjects.add(o);
-      }
-    }
-  }
-
-  // Lookup fields reference other objects
-  if (Array.isArray(config.objects)) {
-    for (const obj of config.objects) {
-      if (obj.fields && typeof obj.fields === 'object') {
-        for (const field of Object.values(obj.fields) as any[]) {
-          if (field?.type === 'lookup' && field?.reference) {
-            referencedObjects.add(field.reference);
-          }
-        }
-      }
-    }
-  }
-
-  const unused: string[] = [];
-  for (const name of objectNames) {
-    if (!referencedObjects.has(name)) {
-      unused.push(`Object "${name}" is defined but not referenced by any view, flow, app, or agent`);
-    }
-  }
-  return unused;
-}
-
-// ─── Filesystem Checks ──────────────────────────────────────────────
-
-function walkDir(dir: string, ext: string): string[] {
-  const results: string[] = [];
-  if (!fs.existsSync(dir)) return results;
-
-  const entries = fs.readdirSync(dir, { withFileTypes: true });
-  for (const entry of entries) {
-    if (entry.name === 'node_modules') continue;
-    const fullPath = path.join(dir, entry.name);
-    if (entry.isDirectory()) {
-      results.push(...walkDir(fullPath, ext));
-    } else if (entry.name.endsWith(ext)) {
-      results.push(fullPath);
-    }
-  }
-  return results;
-}
-
-function findMissingTests(cwd: string): string[] {
-  const specSrcDir = path.join(cwd, 'packages/spec/src');
-  if (!fs.existsSync(specSrcDir)) return [];
-
-  const missing: string[] = [];
-  const zodFiles = walkDir(specSrcDir, '.zod.ts');
-
-  for (const zodFile of zodFiles) {
-    const testFile = zodFile.replace('.zod.ts', '.test.ts');
-    if (!fs.existsSync(testFile)) {
-      const relZod = path.relative(specSrcDir, zodFile);
-      const relTest = path.relative(specSrcDir, testFile);
-      missing.push(`Missing test: ${relTest} (for ${relZod})`);
-    }
-  }
-  return missing;
-}
-
-function findDeprecatedUsages(cwd: string): string[] {
-  const specSrcDir = path.join(cwd, 'packages/spec/src');
-  if (!fs.existsSync(specSrcDir)) return [];
-
-  const deprecated: string[] = [];
-  const tsFiles = walkDir(specSrcDir, '.ts')
-    .filter((f) => !f.endsWith('.test.ts'));
-
-  for (const tsFile of tsFiles) {
-    try {
-      const content = fs.readFileSync(tsFile, 'utf-8');
-      const lines = content.split('\n');
-      const relPath = path.relative(specSrcDir, tsFile);
-      for (let i = 0; i < lines.length; i++) {
-        if (lines[i].includes('@deprecated')) {
-          deprecated.push(`${relPath}:${i + 1} — @deprecated tag found`);
-        }
-      }
-    } catch {
-      // Skip unreadable files
-    }
-  }
-  return deprecated;
-}
-
-// ─── Deprecated Pattern Detection ───────────────────────────────────
-
-const DEPRECATED_PATTERNS: Array<{
-  pattern: RegExp;
-  description: string;
-  replacement: string;
-}> = [
-  {
-    pattern: /\bEnhancedObjectKernel\b/,
-    description: 'EnhancedObjectKernel is deprecated in v3',
-    replacement: 'Use ObjectKernel instead',
-  },
-  {
-    pattern: /\bmax_length\b/,
-    description: 'snake_case config key: max_length',
-    replacement: 'Use maxLength (camelCase)',
-  },
-  {
-    pattern: /\bdefault_value\b/,
-    description: 'snake_case config key: default_value',
-    replacement: 'Use defaultValue (camelCase)',
-  },
-  {
-    pattern: /\bmin_length\b/,
-    description: 'snake_case config key: min_length',
-    replacement: 'Use minLength (camelCase)',
-  },
-  {
-    pattern: /\breference_filters\b/,
-    description: 'snake_case config key: reference_filters',
-    replacement: 'Use referenceFilters (camelCase)',
-  },
-  {
-    pattern: /\bunique_name\b/,
-    description: 'snake_case config key: unique_name',
-    replacement: 'Use uniqueName (camelCase)',
-  },
-  {
-    pattern: /from\s+['"]@objectstack\/core\/enhanced['"]/,
-    description: 'Import from deprecated @objectstack/core/enhanced path',
-    replacement: "Use import from '@objectstack/core'",
-  },
-  {
-    pattern: /from\s+['"]@objectstack\/spec\/dist\/[^'"]+['"]/,
-    description: 'Import from deprecated @objectstack/spec/dist/ deep path',
-    replacement: "Use import from '@objectstack/spec'",
-  },
-];
-
-function scanDeprecatedPatterns(dir: string): Array<{ file: string; line: number; description: string; replacement: string }> {
-  const results: Array<{ file: string; line: number; description: string; replacement: string }> = [];
-  if (!fs.existsSync(dir)) return results;
-
-  const tsFiles = walkDir(dir, '.ts').filter(f => !f.endsWith('.test.ts'));
-
-  for (const tsFile of tsFiles) {
-    try {
-      const content = fs.readFileSync(tsFile, 'utf-8');
-      const lines = content.split('\n');
-      const relPath = path.relative(process.cwd(), tsFile);
-
-      for (let i = 0; i < lines.length; i++) {
-        for (const dp of DEPRECATED_PATTERNS) {
-          if (dp.pattern.test(lines[i])) {
-            results.push({
-              file: relPath,
-              line: i + 1,
-              description: dp.description,
-              replacement: dp.replacement,
-            });
-          }
-        }
-      }
-    } catch {
-      // Skip unreadable files
-    }
-  }
-  return results;
-}
-
-// ─── Command ────────────────────────────────────────────────────────
-
-export default class Doctor extends Command {
-  static override description = 'Check development environment and configuration health';
-
-  static override flags = {
-    verbose: Flags.boolean({ char: 'v', description: 'Show detailed information' }),
-    'scan-deprecations': Flags.boolean({ description: 'Scan for deprecated ObjectStack patterns' }),
-  };
-
-  async run(): Promise<void> {
-    const { flags } = await this.parse(Doctor);
-
-    printHeader('Environment Health Check');
-    
-    const results: HealthCheckResult[] = [];
-    
-    // Check Node.js version
-    try {
-      const nodeVersion = process.version;
-      const majorVersion = parseInt(nodeVersion.slice(1).split('.')[0]);
-      
-      if (majorVersion >= 18) {
-        results.push({
-          name: 'Node.js',
-          status: 'ok',
-          message: `Version ${nodeVersion}`,
-        });
-      } else {
-        results.push({
-          name: 'Node.js',
-          status: 'error',
-          message: `Version ${nodeVersion} (requires >= 18.0.0)`,
-          fix: 'Upgrade Node.js: https://nodejs.org',
-        });
-      }
-    } catch (error) {
-      results.push({
-        name: 'Node.js',
-        status: 'error',
-        message: 'Not found',
-        fix: 'Install Node.js: https://nodejs.org',
-      });
-    }
-    
-    // Check pnpm
-    try {
-      const pnpmVersion = execSync('pnpm -v', { encoding: 'utf-8' }).trim();
-      results.push({
-        name: 'pnpm',
-        status: 'ok',
-        message: `Version ${pnpmVersion}`,
-      });
-    } catch (error) {
-      results.push({
-        name: 'pnpm',
-        status: 'error',
-        message: 'Not found',
-        fix: 'Install pnpm: npm install -g pnpm@10.28.1',
-      });
-    }
-    
-    // Check TypeScript
-    try {
-      const tscVersion = execSync('tsc -v', { encoding: 'utf-8' }).trim();
-      results.push({
-        name: 'TypeScript',
-        status: 'ok',
-        message: tscVersion,
-      });
-    } catch (error) {
-      results.push({
-        name: 'TypeScript',
-        status: 'warning',
-        message: 'Not found in PATH',
-        fix: 'Installed locally via pnpm',
-      });
-    }
-    
-    // Check if dependencies are installed
-    const cwd = process.cwd();
-    const nodeModulesPath = path.join(cwd, 'node_modules');
-    
-    if (fs.existsSync(nodeModulesPath)) {
-      results.push({
-        name: 'Dependencies',
-        status: 'ok',
-        message: 'Installed',
-      });
-    } else {
-      results.push({
-        name: 'Dependencies',
-        status: 'error',
-        message: 'Not installed',
-        fix: 'Run: pnpm install',
-      });
-    }
-    
-    // Check if spec package is built
-    const specDistPath = path.join(cwd, 'packages/spec/dist');
-    
-    if (fs.existsSync(specDistPath)) {
-      results.push({
-        name: '@objectstack/spec',
-        status: 'ok',
-        message: 'Built',
-      });
-    } else {
-      results.push({
-        name: '@objectstack/spec',
-        status: 'warning',
-        message: 'Not built',
-        fix: 'Run: pnpm --filter @objectstack/spec build',
-      });
-    }
-    
-    // Check Git
-    try {
-      const gitVersion = execSync('git --version', { encoding: 'utf-8' }).trim();
-      results.push({
-        name: 'Git',
-        status: 'ok',
-        message: gitVersion,
-      });
-    } catch (error) {
-      results.push({
-        name: 'Git',
-        status: 'warning',
-        message: 'Not found',
-        fix: 'Install Git for version control',
-      });
-    }
-    
-    // Display environment results
-    let hasErrors = false;
-    let hasWarnings = false;
-    
-    console.log('');
-    results.forEach((result) => {
-      const padded = result.name.padEnd(20);
-      if (result.status === 'ok') {
-        printSuccess(`${padded} ${result.message}`);
-      } else if (result.status === 'warning') {
-        printWarning(`${padded} ${result.message}`);
-      } else {
-        printError(`${padded} ${result.message}`);
-      }
-      
-      if (result.fix && (flags.verbose || result.status === 'error')) {
-        console.log(chalk.dim(`      → ${result.fix}`));
-      }
-      
-      if (result.status === 'error') hasErrors = true;
-      if (result.status === 'warning') hasWarnings = true;
-    });
-
-    // ── Extended Checks ──────────────────────────────────────────────
-
-    // Missing test files
-    printStep('Checking for missing test files...');
-    const missingTests = findMissingTests(cwd);
-    if (missingTests.length > 0) {
-      hasWarnings = true;
-      for (const msg of missingTests) {
-        printWarning(msg);
-      }
-    } else {
-      printSuccess('Test coverage         All *.zod.ts files have matching tests');
-    }
-
-    // Deprecated usage detection
-    printStep('Scanning for @deprecated usage...');
-    const deprecatedUsages = findDeprecatedUsages(cwd);
-    if (deprecatedUsages.length > 0) {
-      hasWarnings = true;
-      for (const msg of deprecatedUsages) {
-        printWarning(`Deprecated: ${msg}`);
-      }
-    } else {
-      printSuccess('Deprecations          No @deprecated tags found');
-    }
-
-    // Config-aware checks (only if config exists)
-    if (configExists()) {
-      printStep('Loading configuration for analysis...');
-      try {
-        const { config: rawConfig } = await loadConfig();
-        const config: any = normalizeStackInput(rawConfig as Record<string, unknown>);
-
-        // Circular dependency detection
-        if (Array.isArray(config.objects) && config.objects.length > 0) {
-          printStep('Checking for circular dependencies...');
-          const cycles = detectCircularDependencies(config.objects);
-          if (cycles.length > 0) {
-            hasWarnings = true;
-            for (const msg of cycles) {
-              printWarning(msg);
-            }
-          } else {
-            printSuccess('Dependencies          No circular references detected');
-          }
-
-          // Unused objects
-          printStep('Checking for unused objects...');
-          const unused = findUnusedObjects(config);
-          if (unused.length > 0) {
-            hasWarnings = true;
-            for (const msg of unused) {
-              printWarning(msg);
-            }
-          } else {
-            printSuccess('Object usage          All objects are referenced');
-          }
-        }
-
-        // Orphan views
-        if (Array.isArray(config.views) && config.views.length > 0) {
-          printStep('Checking for orphan views...');
-          const orphans = findOrphanViews(config);
-          if (orphans.length > 0) {
-            hasWarnings = true;
-            for (const msg of orphans) {
-              printWarning(msg);
-            }
-          } else {
-            printSuccess('View integrity        All views reference valid objects');
-          }
-        }
-      } catch {
-        printWarning('Could not load config for analysis (config checks skipped)');
-        hasWarnings = true;
-      }
-    }
-
-    // ── Deprecation Pattern Scan ─────────────────────────────────────
-    if (flags['scan-deprecations']) {
-      printStep('Scanning for deprecated ObjectStack patterns...');
-      const scanDir = path.join(cwd, 'src');
-      const deprecations = scanDeprecatedPatterns(scanDir);
-      if (deprecations.length > 0) {
-        hasWarnings = true;
-        for (const dep of deprecations) {
-          printWarning(`${dep.file}:${dep.line} — ${dep.description}`);
-          if (flags.verbose) {
-            console.log(chalk.dim(`      → ${dep.replacement}`));
-          }
-        }
-        console.log('');
-        printInfo(`Found ${deprecations.length} deprecated pattern(s). Run \`objectstack codemod v2-to-v3\` to auto-fix.`);
-      } else {
-        printSuccess('Deprecation scan      No deprecated patterns found');
-      }
-    }
-    
-    console.log('');
-    
-    // Summary
-    if (hasErrors) {
-      console.log(chalk.red('❌ Some critical issues found. Please fix them before continuing.'));
-      results
-        .filter(r => r.status === 'error' && r.fix)
-        .forEach(r => console.log(chalk.dim(`   ${r.fix}`)));
-      process.exit(1);
-    } else if (hasWarnings) {
-      console.log(chalk.yellow('⚠️  Environment is functional but has some warnings.'));
-      console.log(chalk.dim('   Run with --verbose to see fix suggestions.'));
-    } else {
-      console.log(chalk.green('✅ Environment is healthy and ready for development!'));
-    }
-    
-    console.log('');
-  }
-}