@aiready/cli 0.14.14 → 0.14.16

package/src/__tests__/cli.test.ts

@@ -1,85 +0,0 @@
-import { describe, it, expect, beforeEach, afterEach } from 'vitest';
-import { analyzeUnified } from '../index';
-import { ToolRegistry, ToolName, SpokeOutputSchema } from '@aiready/core';
-
-describe('CLI Unified Analysis', () => {
-  beforeEach(() => {
-    ToolRegistry.clear();
-
-    // Register mock providers
-    ToolRegistry.register({
-      id: ToolName.PatternDetect,
-      alias: ['patterns'],
-      analyze: async () =>
-        SpokeOutputSchema.parse({
-          results: [],
-          summary: {},
-          metadata: { toolName: ToolName.PatternDetect, version: '1.0.0' },
-        }),
-      score: () => ({
-        toolName: ToolName.PatternDetect,
-        score: 80,
-        factors: [],
-        recommendations: [],
-        rawMetrics: {},
-      }),
-      defaultWeight: 10,
-    });
-
-    ToolRegistry.register({
-      id: ToolName.ContextAnalyzer,
-      alias: ['context'],
-      analyze: async () =>
-        SpokeOutputSchema.parse({
-          results: [],
-          summary: {},
-          metadata: { toolName: ToolName.ContextAnalyzer, version: '1.0.0' },
-        }),
-      score: () => ({
-        toolName: ToolName.ContextAnalyzer,
-        score: 70,
-        factors: [],
-        recommendations: [],
-        rawMetrics: {},
-      }),
-      defaultWeight: 10,
-    });
-  });
-
-  afterEach(() => {
-    ToolRegistry.clear();
-  });
-
-  it('should run unified analysis with both tools', async () => {
-    const results = await analyzeUnified({
-      rootDir: '/test',
-      tools: ['patterns', 'context'],
-    });
-
-    expect(results).toHaveProperty(ToolName.PatternDetect);
-    expect(results).toHaveProperty(ToolName.ContextAnalyzer);
-    expect(results).toHaveProperty('summary');
-  });
-
-  it('should run analysis with only patterns tool', async () => {
-    const results = await analyzeUnified({
-      rootDir: '/test',
-      tools: ['patterns'],
-    });
-
-    expect(results).toHaveProperty(ToolName.PatternDetect);
-    expect(results).not.toHaveProperty(ToolName.ContextAnalyzer);
-    expect(results).toHaveProperty('summary');
-  });
-
-  it('should run analysis with only context tool', async () => {
-    const results = await analyzeUnified({
-      rootDir: '/test',
-      tools: ['context'],
-    });
-
-    expect(results).not.toHaveProperty(ToolName.PatternDetect);
-    expect(results).toHaveProperty(ToolName.ContextAnalyzer);
-    expect(results).toHaveProperty('summary');
-  });
-});

package/src/__tests__/config-shape.test.ts

@@ -1,105 +0,0 @@
-import { describe, it, expect, beforeEach, afterEach } from 'vitest';
-import { analyzeUnified } from '../index';
-import { ToolRegistry, ToolName, SpokeOutputSchema } from '@aiready/core';
-
-describe('CLI Configuration Shape', () => {
-  beforeEach(() => {
-    ToolRegistry.clear();
-
-    // Register a mock provider that returns its input config in metadata
-    ToolRegistry.register({
-      id: ToolName.PatternDetect,
-      alias: ['patterns'],
-      analyze: async (options) =>
-        SpokeOutputSchema.parse({
-          results: [],
-          summary: { config: options },
-          metadata: {
-            toolName: ToolName.PatternDetect,
-            version: '1.0.0',
-            config: options,
-          },
-        }),
-      score: () => ({
-        toolName: ToolName.PatternDetect,
-        score: 80,
-        factors: [],
-        recommendations: [],
-        rawMetrics: {},
-      }),
-      defaultWeight: 10,
-    });
-  });
-
-  afterEach(() => {
-    ToolRegistry.clear();
-  });
-
-  it('should generate a strictly portable AIReadyConfig in summary', async () => {
-    const results = await analyzeUnified({
-      rootDir: '/tmp/fake-repo',
-      tools: [ToolName.PatternDetect],
-      exclude: ['**/node_modules/**'],
-      // Pass a tool-specific override
-      toolConfigs: {
-        [ToolName.PatternDetect]: {
-          minSimilarity: 0.9,
-          // This should be stripped
-          rootDir: '/tmp/fake-repo',
-        },
-      },
-    });
-
-    const config = results.summary.config;
-
-    // 1. Check top-level structure
-    expect(config).toHaveProperty('scan');
-    expect(config).toHaveProperty('tools');
-
-    // 2. Ensure rootDir is STRIPPED from top level
-    expect(config).not.toHaveProperty('rootDir');
-
-    // 3. Ensure internal keys are stripped from scan section
-    expect(config.scan).toHaveProperty('tools');
-    expect(config.scan).toHaveProperty('exclude');
-    expect(config.scan).not.toHaveProperty('rootDir');
-
-    // 4. Ensure recursive stripping in tools section
-    const patternConfig = config.tools[ToolName.PatternDetect];
-    expect(patternConfig).toHaveProperty('minSimilarity', 0.9);
-    expect(patternConfig).not.toHaveProperty('rootDir');
-    expect(patternConfig).not.toHaveProperty('onProgress');
-  });
-
-  it('should strip internal keys like useSmartDefaults and batchSize', async () => {
-    const results = await analyzeUnified({
-      rootDir: '/test',
-      tools: [ToolName.PatternDetect],
-      useSmartDefaults: true,
-      batchSize: 50,
-    });
-
-    const config = results.summary.config;
-
-    expect(config).not.toHaveProperty('useSmartDefaults');
-    expect(config.scan).not.toHaveProperty('useSmartDefaults');
-
-    // Check tool level too
-    const patternConfig = config.tools[ToolName.PatternDetect];
-    expect(patternConfig).not.toHaveProperty('useSmartDefaults');
-    expect(patternConfig).not.toHaveProperty('batchSize');
-  });
-
-  it('should produce a config that is compatible with tool specific collection', async () => {
-    // This test ensures that the toolConfigs collected from individual tools
-    // are also sanitized before being merged into the final report.
-    const results = await analyzeUnified({
-      rootDir: '/test',
-      tools: [ToolName.PatternDetect],
-    });
-
-    const toolConfigs = results.summary.toolConfigs;
-    expect(toolConfigs).toBeDefined();
-    expect(toolConfigs![ToolName.PatternDetect]).not.toHaveProperty('rootDir');
-  });
-});

package/src/__tests__/unified.test.ts

@@ -1,95 +0,0 @@
-import { describe, it, expect, vi, beforeEach } from 'vitest';
-import { analyzeUnified, scoreUnified, generateUnifiedSummary } from '../index';
-import { ToolRegistry } from '@aiready/core';
-
-vi.mock('@aiready/core', async () => {
-  const actual = await vi.importActual('@aiready/core');
-  return {
-    ...actual,
-    initializeParsers: vi.fn().mockResolvedValue(undefined),
-    calculateOverallScore: vi
-      .fn()
-      .mockReturnValue({ overall: 85, breakdown: [] }),
-    calculateTokenBudget: vi.fn().mockReturnValue({}),
-  };
-});
-
-describe('Unified CLI logic', () => {
-  beforeEach(() => {
-    vi.clearAllMocks();
-  });
-
-  describe('analyzeUnified', () => {
-    it('should run multiple tools and aggregate results', async () => {
-      const mockProvider1 = {
-        id: 'tool1',
-        analyze: vi.fn().mockResolvedValue({
-          results: [{ fileName: 'f1.ts', issues: [{}, {}] }],
-          summary: { totalFiles: 1 },
-        }),
-        score: vi.fn(),
-      };
-
-      vi.spyOn(ToolRegistry, 'find').mockImplementation((id) => {
-        if (id === 'tool1') return mockProvider1 as any;
-        return null;
-      });
-
-      const options = {
-        rootDir: '.',
-        tools: ['tool1'],
-      };
-
-      const result = await analyzeUnified(options as any);
-      expect(result.summary.totalIssues).toBe(2);
-      expect(result.summary.toolsRun).toContain('tool1');
-    });
-  });
-
-  describe('scoreUnified', () => {
-    it('should score results from multiple tools', async () => {
-      const mockProvider = {
-        id: 'tool1',
-        score: vi.fn().mockReturnValue({ score: 80 }),
-      };
-      vi.spyOn(ToolRegistry, 'get').mockReturnValue(mockProvider as any);
-
-      const results = {
-        summary: { toolsRun: ['tool1'] },
-        tool1: { results: [] },
-      };
-
-      const score = await scoreUnified(results as any, { rootDir: '.' } as any);
-      expect(score.overall).toBe(85); // From mocked calculateOverallScore
-      expect(mockProvider.score).toHaveBeenCalled();
-    });
-
-    it('should handle empty tools', async () => {
-      const results = { summary: { toolsRun: [] } };
-      const score = await scoreUnified(results as any, { rootDir: '.' } as any);
-      expect(score.overall).toBe(0);
-    });
-  });
-
-  describe('generateUnifiedSummary', () => {
-    it('should generate human-readable summary', () => {
-      const result = {
-        summary: {
-          toolsRun: ['tool1'],
-          totalIssues: 5,
-          executionTime: 1200,
-        },
-        tool1: { results: [{ issues: [{}, {}] }] },
-      };
-
-      vi.spyOn(ToolRegistry, 'getAll').mockReturnValue([
-        { id: 'tool1' },
-      ] as any);
-
-      const summary = generateUnifiedSummary(result as any);
-      expect(summary).toContain('AIReady Analysis Complete');
-      expect(summary).toContain('Total issues found: 5');
-      expect(summary).toContain('1.20s');
-    });
-  });
-});

package/src/cli.ts

@@ -1,333 +0,0 @@
-#!/usr/bin/env node
-
-import { Command } from 'commander';
-import { readFileSync } from 'fs';
-import { join, dirname } from 'path';
-import { fileURLToPath } from 'url';
-
-import {
-  scanAction,
-  scanHelpText,
-  initAction,
-  patternsAction,
-  patternsHelpText,
-  contextAction,
-  consistencyAction,
-  visualizeAction,
-  visualizeHelpText,
-  visualiseHelpText,
-  changeAmplificationAction,
-  testabilityAction,
-  uploadAction,
-  uploadHelpText,
-  bugAction,
-  bugHelpText,
-} from './commands';
-
-const getDirname = () => {
-  if (typeof __dirname !== 'undefined') return __dirname;
-  return dirname(fileURLToPath(import.meta.url));
-};
-
-const packageJson = JSON.parse(
-  readFileSync(join(getDirname(), '../package.json'), 'utf8')
-);
-
-const program = new Command();
-
-program
-  .name('aiready')
-  .description('AIReady - Assess and improve AI-readiness of codebases')
-  .version(packageJson.version)
-  .addHelpText(
-    'after',
-    `
-AI READINESS SCORING:
-  Get a 0-100 score indicating how AI-ready your codebase is.
-  Use --score flag with any analysis command for detailed breakdown.
-
-EXAMPLES:
-  $ aiready scan                          # Comprehensive analysis with AI Readiness Score
-  $ aiready scan --no-score               # Run scan without score calculation
-  $ aiready init                          # Create a default aiready.json configuration
-  $ aiready init --full                   # Create configuration with ALL available options
-  $ npx @aiready/cli scan                 # Industry standard way to run standard scan
-  $ aiready scan --output json            # Output raw JSON for piping
-
-GETTING STARTED:
-  1. Run 'aiready init' to create a persistent 'aiready.json' config file
-  2. Run 'aiready scan' to analyze your codebase and get an AI Readiness Score
-  3. Use 'aiready init --full' to see every fine-tuning parameter available
-  4. Use '--profile agentic' for agent-focused analysis
-  5. Set up CI/CD with '--threshold' for quality gates
-
-CONFIGURATION:
-  Config files (searched upward): aiready.json, .aiready.json, aiready.config.*
-  CLI options override config file settings
-
-  Example aiready.json:
-  {
-    "scan": { "exclude": ["**/dist/**", "**/node_modules/**"] },
-    "tools": {
-      "pattern-detect": { "minSimilarity": 0.5 },
-      "context-analyzer": { "maxContextBudget": 15000 }
-    },
-    "output": { "format": "json", "directory": ".aiready" }
-  }
-
-VERSION: ${packageJson.version}
-DOCUMENTATION: https://aiready.dev/docs/cli
-GITHUB: https://github.com/caopengau/aiready-cli
-LANDING: https://github.com/caopengau/aiready-landing`
-  );
-
-// Scan command - Run comprehensive AI-readiness analysis
-program
-  .command('scan')
-  .description(
-    'Run comprehensive AI-readiness analysis (patterns + context + consistency)'
-  )
-  .argument('[directory]', 'Directory to analyze', '.')
-  .option(
-    '-t, --tools <tools>',
-    'Tools to run (comma-separated: patterns,context,consistency,doc-drift,deps-health,aiSignalClarity,grounding,testability,changeAmplification)'
-  )
-  .option(
-    '--profile <type>',
-    'Scan profile to use (agentic, cost, logic, ui, security, onboarding)'
-  )
-  .option(
-    '--compare-to <path>',
-    'Compare results against a previous AIReady report JSON'
-  )
-  .option('--include <patterns>', 'File patterns to include (comma-separated)')
-  .option('--exclude <patterns>', 'File patterns to exclude (comma-separated)')
-  .option('-o, --output <format>', 'Output format: console, json', 'console')
-  .option('--output-file <path>', 'Output file path (for json)')
-  .option('--score', 'Calculate and display AI Readiness Score (0-100)', true)
-  .option('--no-score', 'Disable calculating AI Readiness Score')
-  .option('--weights <weights>', 'Custom scoring weights')
-  .option('--threshold <score>', 'Fail CI/CD if score below threshold (0-100)')
-  .option(
-    '--ci',
-    'CI mode: GitHub Actions annotations, no colors, fail on threshold'
-  )
-  .option(
-    '--fail-on <level>',
-    'Fail on issues: critical, major, any',
-    'critical'
-  )
-  .option('--api-key <key>', 'Platform API key for automatic upload')
-  .option('--upload', 'Automatically upload results to the platform')
-  .option('--server <url>', 'Custom platform URL')
-  .addHelpText('after', scanHelpText)
-  .action(async (directory, options) => {
-    await scanAction(directory, options);
-  });
-
-// Init command - Generate default configuration
-program
-  .command('init')
-  .description('Generate a default configuration (aiready.json)')
-  .option('-f, --force', 'Overwrite existing configuration file')
-  .option(
-    '--js',
-    'Generate configuration as a JavaScript file (aiready.config.js)'
-  )
-  .option('--full', 'Generate a full configuration with all available options')
-  .action(async (options) => {
-    const format = options.js ? 'js' : 'json';
-    await initAction({ force: options.force, format, full: options.full });
-  });
-
-// Patterns command - Detect duplicate code patterns
-program
-  .command('patterns')
-  .description('Detect duplicate code patterns that confuse AI models')
-  .argument('[directory]', 'Directory to analyze', '.')
-  .option('-s, --similarity <number>', 'Minimum similarity score (0-1)', '0.40')
-  .option('-l, --min-lines <number>', 'Minimum lines to consider', '5')
-  .option(
-    '--max-candidates <number>',
-    'Maximum candidates per block (performance tuning)'
-  )
-  .option(
-    '--min-shared-tokens <number>',
-    'Minimum shared tokens for candidates (performance tuning)'
-  )
-  .option(
-    '--full-scan',
-    'Disable smart defaults for comprehensive analysis (slower)'
-  )
-  .option('--include <patterns>', 'File patterns to include (comma-separated)')
-  .option('--exclude <patterns>', 'File patterns to exclude (comma-separated)')
-  .option('-o, --output <format>', 'Output format: console, json', 'console')
-  .option('--output-file <path>', 'Output file path (for json)')
-  .option('--score', 'Calculate and display AI Readiness Score (0-100)', true)
-  .option('--no-score', 'Disable calculating AI Readiness Score')
-  .addHelpText('after', patternsHelpText)
-  .action(async (directory, options) => {
-    await patternsAction(directory, options);
-  });
-
-// Context command - Analyze context window costs
-program
-  .command('context')
-  .description('Analyze context window costs and dependency fragmentation')
-  .argument('[directory]', 'Directory to analyze', '.')
-  .option('--max-depth <number>', 'Maximum acceptable import depth', '5')
-  .option(
-    '--max-context <number>',
-    'Maximum acceptable context budget (tokens)',
-    '10000'
-  )
-  .option('--include <patterns>', 'File patterns to include (comma-separated)')
-  .option('--exclude <patterns>', 'File patterns to exclude (comma-separated)')
-  .option('-o, --output <format>', 'Output format: console, json', 'console')
-  .option('--output-file <path>', 'Output file path (for json)')
-  .option('--score', 'Calculate and display AI Readiness Score (0-100)', true)
-  .option('--no-score', 'Disable calculating AI Readiness Score')
-  .action(async (directory, options) => {
-    await contextAction(directory, options);
-  });
-
-// Consistency command - Check naming conventions
-program
-  .command('consistency')
-  .description('Check naming conventions and architectural consistency')
-  .argument('[directory]', 'Directory to analyze', '.')
-  .option('--naming', 'Check naming conventions (default: true)')
-  .option('--no-naming', 'Skip naming analysis')
-  .option('--patterns', 'Check code patterns (default: true)')
-  .option('--no-patterns', 'Skip pattern analysis')
-  .option(
-    '--min-severity <level>',
-    'Minimum severity: info|minor|major|critical',
-    'info'
-  )
-  .option('--include <patterns>', 'File patterns to include (comma-separated)')
-  .option('--exclude <patterns>', 'File patterns to exclude (comma-separated)')
-  .option(
-    '-o, --output <format>',
-    'Output format: console, json, markdown',
-    'console'
-  )
-  .option('--output-file <path>', 'Output file path (for json/markdown)')
-  .option('--score', 'Calculate and display AI Readiness Score (0-100)', true)
-  .option('--no-score', 'Disable calculating AI Readiness Score')
-  .action(async (directory, options) => {
-    await consistencyAction(directory, options);
-  });
-
-// Visualise command (British spelling alias)
-program
-  .command('visualise')
-  .description('Alias for visualize (British spelling)')
-  .argument('[directory]', 'Directory to analyze', '.')
-  .option(
-    '--report <path>',
-    'Report path (auto-detects latest .aiready/aiready-report-*.json if not provided)'
-  )
-  .option(
-    '-o, --output <path>',
-    'Output HTML path (relative to directory)',
-    'packages/visualizer/visualization.html'
-  )
-  .option('--open', 'Open generated HTML in default browser')
-  .option(
-    '--serve [port]',
-    'Start a local static server to serve the visualization (optional port number)',
-    false
-  )
-  .option(
-    '--dev',
-    'Start Vite dev server (live reload) for interactive development',
-    true
-  )
-  .addHelpText('after', visualiseHelpText)
-  .action(async (directory, options) => {
-    await visualizeAction(directory, options);
-  });
-
-// Visualize command - Generate interactive visualization
-program
-  .command('visualize')
-  .description('Generate interactive visualization from an AIReady report')
-  .argument('[directory]', 'Directory to analyze', '.')
-  .option(
-    '--report <path>',
-    'Report path (auto-detects latest .aiready/aiready-report-*.json if not provided)'
-  )
-  .option(
-    '-o, --output <path>',
-    'Output HTML path (relative to directory)',
-    'packages/visualizer/visualization.html'
-  )
-  .option('--open', 'Open generated HTML in default browser')
-  .option(
-    '--serve [port]',
-    'Start a local static server to serve the visualization (optional port number)',
-    false
-  )
-  .option(
-    '--dev',
-    'Start Vite dev server (live reload) for interactive development',
-    false
-  )
-  .addHelpText('after', visualizeHelpText)
-  .action(async (directory, options) => {
-    await visualizeAction(directory, options);
-  });
-
-// Change Amplification command
-program
-  .command('change-amplification')
-  .description('Analyze graph metrics for change amplification')
-  .argument('[directory]', 'Directory to analyze', '.')
-  .option('--include <patterns>', 'File patterns to include (comma-separated)')
-  .option('--exclude <patterns>', 'File patterns to exclude (comma-separated)')
-  .option('-o, --output <format>', 'Output format: console, json', 'console')
-  .option('--output-file <path>', 'Output file path (for json)')
-  .action(async (directory, options) => {
-    await changeAmplificationAction(directory, options);
-  });
-
-// Testability command
-program
-  .command('testability')
-  .description('Analyze test coverage and AI readiness')
-  .argument('[directory]', 'Directory to analyze', '.')
-  .option('--min-coverage <ratio>', 'Minimum acceptable coverage ratio', '0.3')
-  .option('--include <patterns>', 'File patterns to include (comma-separated)')
-  .option('--exclude <patterns>', 'File patterns to exclude (comma-separated)')
-  .option('-o, --output <format>', 'Output format: console, json', 'console')
-  .option('--output-file <path>', 'Output file path (for json)')
-  .action(async (directory, options) => {
-    await testabilityAction(directory, options);
-  });
-
-// Upload command - Upload report JSON to platform
-program
-  .command('upload')
-  .description('Upload an AIReady report JSON to the platform')
-  .argument('<file>', 'Report JSON file to upload')
-  .option('--api-key <key>', 'Platform API key')
-  .option('--repo-id <id>', 'Platform repository ID (optional)')
-  .option('--server <url>', 'Custom platform URL')
-  .addHelpText('after', uploadHelpText)
-  .action(async (file, options) => {
-    await uploadAction(file, options);
-  });
-
-program
-  .command('bug')
-  .description('Report a bug or provide feedback (Agent-friendly)')
-  .argument('[message]', 'Short description of the issue')
-  .option('-t, --type <type>', 'Issue type: bug, feature, metric', 'bug')
-  .option('--submit', 'Submit the issue directly using the GitHub CLI (gh)')
-  .addHelpText('after', bugHelpText)
-  .action(async (message, options) => {
-    await bugAction(message, options);
-  });
-
-program.parse();

package/src/commands/__tests__/agent-grounding.test.ts

@@ -1,24 +0,0 @@
-import { describe, it, expect, vi } from 'vitest';
-import { agentGroundingAction } from '../agent-grounding';
-
-vi.mock('@aiready/agent-grounding', () => ({
-  analyzeAgentGrounding: vi.fn().mockResolvedValue({
-    summary: { score: 75, rating: 'good', dimensions: { apiClarityScore: 60 } },
-    results: [],
-  }),
-  calculateGroundingScore: vi.fn().mockReturnValue({ score: 75 }),
-}));
-
-vi.mock('@aiready/core', () => ({
-  loadConfig: vi.fn().mockResolvedValue({}),
-  mergeConfigWithDefaults: vi
-    .fn()
-    .mockImplementation((c, d) => ({ ...d, ...c })),
-}));
-
-describe('Agent Grounding CLI Action', () => {
-  it('should run analysis and return scoring', async () => {
-    const result = await agentGroundingAction('.', { output: 'json' });
-    expect(result?.score).toBe(75);
-  });
-});

package/src/commands/__tests__/ai-signal-clarity.test.ts

@@ -1,32 +0,0 @@
-import { describe, it, expect, vi } from 'vitest';
-import { aiSignalClarityAction } from '../ai-signal-clarity';
-
-vi.mock('@aiready/ai-signal-clarity', () => ({
-  analyzeAiSignalClarity: vi.fn().mockResolvedValue({
-    summary: {
-      score: 85,
-      rating: 'low',
-      topRisk: 'none',
-      totalSignals: 0,
-      criticalSignals: 0,
-      majorSignals: 0,
-      minorSignals: 0,
-    },
-    results: [],
-  }),
-  calculateAiSignalClarityScore: vi.fn().mockReturnValue({ score: 85 }),
-}));
-
-vi.mock('@aiready/core', () => ({
-  loadConfig: vi.fn().mockResolvedValue({}),
-  mergeConfigWithDefaults: vi
-    .fn()
-    .mockImplementation((c, d) => ({ ...d, ...c })),
-}));
-
-describe('AI Signal Clarity CLI Action', () => {
-  it('should run analysis and return scoring', async () => {
-    const result = await aiSignalClarityAction('.', { output: 'json' });
-    expect(result?.score).toBe(85);
-  });
-});