npm - @aiready/cli - Versions diffs - 0.14.14 → 0.14.16 - Mend

@aiready/cli 0.14.14 → 0.14.16

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (98) hide show

package/CONTRIBUTING.md +86 -1
package/LICENSE +21 -0
package/README.md +152 -52
package/dist/cli.js +73 -12
package/dist/cli.mjs +73 -12
package/package.json +44 -14
package/.aiready/aiready-report-20260227-133806.json +0 -7805
package/.aiready/aiready-report-20260227-133938.json +0 -7951
package/.aiready/aiready-report-20260228-003433.json +0 -7939
package/.aiready/aiready-report-20260228-003613.json +0 -771
package/.aiready/aiready-report-20260314-164626.json +0 -59
package/.aiready/aiready-report-20260314-164741.json +0 -59
package/.aiready/aiready-report-20260319-201106.json +0 -5566
package/.aiready/aiready-report-20260319-201511.json +0 -5566
package/.aiready/aiready-report-20260319-202017.json +0 -5708
package/.github/FUNDING.yml +0 -5
package/.turbo/turbo-build.log +0 -29
package/.turbo/turbo-lint.log +0 -0
package/.turbo/turbo-test.log +0 -76
package/aiready-report.json +0 -30703
package/coverage/base.css +0 -224
package/coverage/block-navigation.js +0 -87
package/coverage/clover.xml +0 -865
package/coverage/coverage-final.json +0 -15
package/coverage/favicon.png +0 -0
package/coverage/index.html +0 -146
package/coverage/prettify.css +0 -1
package/coverage/prettify.js +0 -2
package/coverage/sort-arrow-sprite.png +0 -0
package/coverage/sorter.js +0 -210
package/coverage/src/commands/agent-grounding.ts.html +0 -271
package/coverage/src/commands/ai-signal-clarity.ts.html +0 -253
package/coverage/src/commands/change-amplification.ts.html +0 -94
package/coverage/src/commands/consistency.ts.html +0 -781
package/coverage/src/commands/context.ts.html +0 -871
package/coverage/src/commands/deps-health.ts.html +0 -280
package/coverage/src/commands/doc-drift.ts.html +0 -271
package/coverage/src/commands/index.html +0 -281
package/coverage/src/commands/patterns.ts.html +0 -745
package/coverage/src/commands/scan.ts.html +0 -1393
package/coverage/src/commands/testability.ts.html +0 -304
package/coverage/src/commands/upload.ts.html +0 -466
package/coverage/src/commands/visualize.ts.html +0 -1027
package/coverage/src/index.html +0 -116
package/coverage/src/index.ts.html +0 -1372
package/coverage/src/utils/helpers.ts.html +0 -559
package/coverage/src/utils/index.html +0 -116
package/docs/SPOKE_GUIDE.md +0 -184
package/packages/core/src/.aiready/aiready-report-20260314-161145.json +0 -224
package/packages/core/src/.aiready/aiready-report-20260314-161152.json +0 -235
package/packages/pattern-detect/src/.aiready/aiready-report-20260314-161139.json +0 -224
package/src/.aiready/aiready-report-20260312-103623.json +0 -32574
package/src/.aiready/aiready-report-20260312-110843.json +0 -28740
package/src/.aiready/aiready-report-20260312-110955.json +0 -28740
package/src/.aiready/aiready-report-20260314-203209.json +0 -30713
package/src/.aiready/aiready-report-20260314-203736.json +0 -30713
package/src/.aiready/aiready-report-20260314-203857.json +0 -30713
package/src/.aiready/aiready-report-20260314-204047.json +0 -30713
package/src/.aiready/aiready-report-20260318-002110.json +0 -28782
package/src/__tests__/cli.test.ts +0 -85
package/src/__tests__/config-shape.test.ts +0 -105
package/src/__tests__/unified.test.ts +0 -95
package/src/cli.ts +0 -333
package/src/commands/__tests__/agent-grounding.test.ts +0 -24
package/src/commands/__tests__/ai-signal-clarity.test.ts +0 -32
package/src/commands/__tests__/consistency.test.ts +0 -100
package/src/commands/__tests__/deps-health.test.ts +0 -26
package/src/commands/__tests__/doc-drift.test.ts +0 -26
package/src/commands/__tests__/extra-commands.test.ts +0 -168
package/src/commands/__tests__/init.test.ts +0 -51
package/src/commands/__tests__/scan.test.ts +0 -153
package/src/commands/__tests__/testability.test.ts +0 -36
package/src/commands/__tests__/upload.test.ts +0 -50
package/src/commands/__tests__/visualize.test.ts +0 -78
package/src/commands/agent-grounding.ts +0 -62
package/src/commands/ai-signal-clarity.ts +0 -1
package/src/commands/bug.ts +0 -99
package/src/commands/change-amplification.ts +0 -3
package/src/commands/consistency.ts +0 -232
package/src/commands/context.ts +0 -262
package/src/commands/deps-health.ts +0 -1
package/src/commands/doc-drift.ts +0 -1
package/src/commands/index.ts +0 -20
package/src/commands/init.ts +0 -199
package/src/commands/patterns.ts +0 -222
package/src/commands/report-formatter.ts +0 -267
package/src/commands/scan.ts +0 -432
package/src/commands/shared/configured-tool-action.ts +0 -35
package/src/commands/shared/standard-tool-actions.ts +0 -126
package/src/commands/testability.ts +0 -73
package/src/commands/upload.ts +0 -129
package/src/commands/visualize.ts +0 -321
package/src/index.ts +0 -465
package/src/utils/__tests__/helpers.test.ts +0 -35
package/src/utils/helpers.ts +0 -234
package/tsconfig.json +0 -11
package/tsconfig.tsbuildinfo +0 -1
package/vitest.config.ts +0 -13

package/coverage/src/utils/index.html DELETED Viewed

@@ -1,116 +0,0 @@
-<!doctype html>
-<html lang="en">
-<head>
-    <title>Code coverage report for src/utils</title>
-    <meta charset="utf-8" />
-    <link rel="stylesheet" href="../../prettify.css" />
-    <link rel="stylesheet" href="../../base.css" />
-    <link rel="shortcut icon" type="image/x-icon" href="../../favicon.png" />
-    <meta name="viewport" content="width=device-width, initial-scale=1" />
-    <style type='text/css'>
-        .coverage-summary .sorter {
-            background-image: url(../../sort-arrow-sprite.png);
-        }
-    </style>
-</head>
-<body>
-<div class='wrapper'>
-    <div class='pad1'>
-        <h1><a href="../../index.html">All files</a> src/utils</h1>
-        <div class='clearfix'>
-            <div class='fl pad1y space-right2'>
-                <span class="strong">52.23% </span>
-                <span class="quiet">Statements</span>
-                <span class='fraction'>35/67</span>
-            </div>
-            <div class='fl pad1y space-right2'>
-                <span class="strong">37.2% </span>
-                <span class="quiet">Branches</span>
-                <span class='fraction'>16/43</span>
-            </div>
-            <div class='fl pad1y space-right2'>
-                <span class="strong">53.84% </span>
-                <span class="quiet">Functions</span>
-                <span class='fraction'>7/13</span>
-            </div>
-            <div class='fl pad1y space-right2'>
-                <span class="strong">51.56% </span>
-                <span class="quiet">Lines</span>
-                <span class='fraction'>33/64</span>
-            </div>
-        </div>
-        <p class="quiet">
-            Press <em>n</em> or <em>j</em> to go to the next uncovered block, <em>b</em>, <em>p</em> or <em>k</em> for the previous block.
-        </p>
-        <template id="filterTemplate">
-            <div class="quiet">
-                Filter:
-                <input type="search" id="fileSearch">
-            </div>
-        </template>
-    </div>
-    <div class='status-line medium'></div>
-    <div class="pad1">
-<table class="coverage-summary">
-<thead>
-<tr>
-   <th data-col="file" data-fmt="html" data-html="true" class="file">File</th>
-   <th data-col="pic" data-type="number" data-fmt="html" data-html="true" class="pic"></th>
-   <th data-col="statements" data-type="number" data-fmt="pct" class="pct">Statements</th>
-   <th data-col="statements_raw" data-type="number" data-fmt="html" class="abs"></th>
-   <th data-col="branches" data-type="number" data-fmt="pct" class="pct">Branches</th>
-   <th data-col="branches_raw" data-type="number" data-fmt="html" class="abs"></th>
-   <th data-col="functions" data-type="number" data-fmt="pct" class="pct">Functions</th>
-   <th data-col="functions_raw" data-type="number" data-fmt="html" class="abs"></th>
-   <th data-col="lines" data-type="number" data-fmt="pct" class="pct">Lines</th>
-   <th data-col="lines_raw" data-type="number" data-fmt="html" class="abs"></th>
-</tr>
-</thead>
-<tbody><tr>
-	<td class="file medium" data-value="helpers.ts"><a href="helpers.ts.html">helpers.ts</a></td>
-	<td data-value="52.23" class="pic medium">
-	<div class="chart"><div class="cover-fill" style="width: 52%"></div><div class="cover-empty" style="width: 48%"></div></div>
-	</td>
-	<td data-value="52.23" class="pct medium">52.23%</td>
-	<td data-value="67" class="abs medium">35/67</td>
-	<td data-value="37.2" class="pct low">37.2%</td>
-	<td data-value="43" class="abs low">16/43</td>
-	<td data-value="53.84" class="pct medium">53.84%</td>
-	<td data-value="13" class="abs medium">7/13</td>
-	<td data-value="51.56" class="pct medium">51.56%</td>
-	<td data-value="64" class="abs medium">33/64</td>
-	</tr>
-</tbody>
-</table>
-</div>
-                <div class='push'></div><!-- for sticky footer -->
-            </div><!-- /wrapper -->
-            <div class='footer quiet pad2 space-top1 center small'>
-                Code coverage generated by
-                <a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
-                at 2026-03-09T03:44:16.153Z
-            </div>
-        <script src="../../prettify.js"></script>
-        <script>
-            window.onload = function () {
-                prettyPrint();
-            };
-        </script>
-        <script src="../../sorter.js"></script>
-        <script src="../../block-navigation.js"></script>
-    </body>
-</html>

package/docs/SPOKE_GUIDE.md DELETED Viewed

@@ -1,184 +0,0 @@
-# Building a New AIReady Spoke
-This guide explains how to build a new analysis tool ("spoke") and integrate it into the AIReady ecosystem. AIReady uses a hub-and-spoke architecture where independent tools are coordinated by a central CLI and Hub (@aiready/core).
-## 🚀 Getting Started
-### 1. Create Package Structure
-If you are contributing to the monorepo:
-```bash
-mkdir -p packages/your-tool/src
-cd packages/your-tool
-```
-### 2. Create `package.json`
-Your tool should depend on `@aiready/core` for shared types and utilities.
-```json
-{
-  "name": "@aiready/your-tool",
-  "version": "0.1.0",
-  "description": "Brief description of what this tool does",
-  "main": "./dist/index.js",
-  "module": "./dist/index.mjs",
-  "types": "./dist/index.d.ts",
-  "bin": {
-    "aiready-yourtool": "./dist/cli.js"
-  },
-  "scripts": {
-    "build": "tsup src/index.ts src/cli.ts --format cjs,esm --dts",
-    "dev": "tsup src/index.ts src/cli.ts --format cjs,esm --dts --watch",
-    "test": "vitest run",
-    "lint": "eslint src",
-    "clean": "rm -rf dist"
-  },
-  "dependencies": {
-    "@aiready/core": "workspace:*",
-    "commander": "^12.1.0"
-  },
-  "devDependencies": {
-    "tsup": "^8.3.5"
-  },
-  "keywords": ["aiready", "your-keywords"],
-  "license": "MIT"
-}
-```
-### 3. Implement the Analysis Logic
-Create `src/analyzer.ts` to contain your core logic.
-```typescript
-import { scanFiles, readFileContent } from '@aiready/core';
-import type {
-  AnalysisResult,
-  Issue,
-  ScanOptions,
-  SpokeOutput,
-} from '@aiready/core';
-export async function analyzeYourTool(
-  options: ScanOptions
-): Promise<SpokeOutput> {
-  const files = await scanFiles(options);
-  const results: AnalysisResult[] = [];
-  // Your analysis logic here
-  // 1. Iterate through files
-  // 2. Detect issues
-  // 3. Return standardized AnalysisResult[]
-  return {
-    results,
-    summary: {
-      totalFiles: files.length,
-      totalIssues: results.reduce((acc, r) => acc + r.issues.length, 0),
-      // ... other summary stats
-    },
-  };
-}
-```
-### 4. Implement ToolProvider and Register
-Every spoke must implement the `ToolProvider` interface and register with the global `ToolRegistry` so that it is automatically discovered by the unified CLI.
-1.  **Create `src/provider.ts`**:
-    ```typescript
-    import {
-      ToolProvider,
-      ToolName,
-      SpokeOutput,
-      ScanOptions,
-      ToolScoringOutput,
-    } from '@aiready/core';
-    import { analyzeYourTool } from './analyzer';
-    export const YourToolProvider: ToolProvider = {
-      id: ToolName.YourToolID, // Use an existing ToolName or request a new one
-      alias: ['your-alias'],
-      async analyze(options: ScanOptions): Promise<SpokeOutput> {
-        const output = await analyzeYourTool(options);
-        return {
-          ...output,
-          metadata: { toolName: ToolName.YourToolID, version: '0.1.0' },
-        };
-      },
-      score(output: SpokeOutput, options: ScanOptions): ToolScoringOutput {
-        // Implement scoring logic (0-100)
-        return {
-          score: 100, // Example
-          metrics: output.summary,
-        };
-      },
-      defaultWeight: 10,
-    };
-    ```
-2.  **Register in `src/index.ts`**:
-    ```typescript
-    import { ToolRegistry } from '@aiready/core';
-    import { YourToolProvider } from './provider';
-    // Register with global registry for automatic CLI discovery
-    ToolRegistry.register(YourToolProvider);
-    export { YourToolProvider };
-    export * from './analyzer';
-    ```
-### 5. Create Standalone CLI (`src/cli.ts`)
-```typescript
-#!/usr/bin/env node
-import { Command } from 'commander';
-import { analyzeYourTool } from './analyzer';
-import chalk from 'chalk';
-const program = new Command();
-program
-  .name('aiready-yourtool')
-  .description('Description of your tool')
-  .version('0.1.0')
-  .argument('<directory>', 'Directory to analyze')
-  .action(async (directory, options) => {
-    console.log(chalk.blue('🔍 Analyzing...\n'));
-    const output = await analyzeYourTool({ rootDir: directory });
-    console.log(JSON.stringify(output, null, 2));
-  });
-program.parse();
-```
-## 📋 Standard Specs to Follow
-To ensure your tool integrates perfectly with the AIReady ecosystem, it must follow these rules:
-1.  **Standard Options**: Support `--include`, `--exclude`, and `--output` (standardized via `ScanOptions`).
-2.  **No Direct Dependencies**: Spokes should never depend on other spokes. Only depend on `@aiready/core`.
-3.  **Standard Issue Types**: Use `IssueType` from `@aiready/core` whenever possible.
-4.  **Severity Levels**: Use `critical`, `major`, `minor`, and `info`.
-5.  **Non-Blocking**: The `analyze` function should be asynchronous and handle large codebases efficiently.
-## 🧪 Testing
-Use `vitest` for unit and integration tests. Ensure you test your `ToolProvider` implementation using the `validateSpokeOutput` utility from `@aiready/core`.
-```typescript
-import { validateSpokeOutput } from '@aiready/core/types/contract';
-test('output matches AIReady contract', async () => {
-  const output = await analyzeYourTool({ rootDir: './test' });
-  const validation = validateSpokeOutput('your-tool', output);
-  expect(validation.valid).toBe(true);
-});
-```

package/packages/core/src/.aiready/aiready-report-20260314-161145.json DELETED Viewed

@@ -1,224 +0,0 @@
-{
-  "summary": {
-    "totalIssues": 0,
-    "criticalIssues": 0,
-    "majorIssues": 0,
-    "totalFiles": 0,
-    "toolsRun": ["pattern-detect"],
-    "executionTime": 5,
-    "config": {
-      "scan": {
-        "tools": ["patterns"]
-      },
-      "tools": {
-        "pattern-detect": {
-          "minSimilarity": 0.5,
-          "minLines": 6,
-          "approx": true,
-          "minSharedTokens": 10,
-          "maxCandidatesPerBlock": 100,
-          "severity": "all"
-        }
-      }
-    },
-    "toolConfigs": {
-      "pattern-detect": {
-        "minSimilarity": 0.5,
-        "minLines": 6,
-        "approx": true,
-        "minSharedTokens": 10,
-        "maxCandidatesPerBlock": 100,
-        "severity": "all"
-      }
-    }
-  },
-  "pattern-detect": {
-    "results": [],
-    "summary": {
-      "totalFiles": 0,
-      "totalIssues": 0,
-      "duplicates": [],
-      "clusters": [],
-      "config": {
-        "rootDir": "/Users/pengcao/projects/aiready/packages/cli/packages/core/src",
-        "minSimilarity": 0.5,
-        "minLines": 6,
-        "approx": true,
-        "minSharedTokens": 10,
-        "maxCandidatesPerBlock": 100,
-        "severity": "all"
-      }
-    },
-    "metadata": {
-      "toolName": "pattern-detect",
-      "version": "0.12.5",
-      "timestamp": "2026-03-14T05:11:45.606Z",
-      "config": {
-        "minSimilarity": 0.5,
-        "minLines": 6,
-        "approx": true,
-        "minSharedTokens": 10,
-        "maxCandidatesPerBlock": 100,
-        "severity": "all",
-        "includeTests": false
-      }
-    }
-  },
-  "patterns": {
-    "results": [],
-    "summary": {
-      "totalFiles": 0,
-      "totalIssues": 0,
-      "duplicates": [],
-      "clusters": [],
-      "config": {
-        "rootDir": "/Users/pengcao/projects/aiready/packages/cli/packages/core/src",
-        "minSimilarity": 0.5,
-        "minLines": 6,
-        "approx": true,
-        "minSharedTokens": 10,
-        "maxCandidatesPerBlock": 100,
-        "severity": "all"
-      }
-    },
-    "metadata": {
-      "toolName": "pattern-detect",
-      "version": "0.12.5",
-      "timestamp": "2026-03-14T05:11:45.606Z",
-      "config": {
-        "minSimilarity": 0.5,
-        "minLines": 6,
-        "approx": true,
-        "minSharedTokens": 10,
-        "maxCandidatesPerBlock": 100,
-        "severity": "all",
-        "includeTests": false
-      }
-    }
-  },
-  "duplicates": {
-    "results": [],
-    "summary": {
-      "totalFiles": 0,
-      "totalIssues": 0,
-      "duplicates": [],
-      "clusters": [],
-      "config": {
-        "rootDir": "/Users/pengcao/projects/aiready/packages/cli/packages/core/src",
-        "minSimilarity": 0.5,
-        "minLines": 6,
-        "approx": true,
-        "minSharedTokens": 10,
-        "maxCandidatesPerBlock": 100,
-        "severity": "all"
-      }
-    },
-    "metadata": {
-      "toolName": "pattern-detect",
-      "version": "0.12.5",
-      "timestamp": "2026-03-14T05:11:45.606Z",
-      "config": {
-        "minSimilarity": 0.5,
-        "minLines": 6,
-        "approx": true,
-        "minSharedTokens": 10,
-        "maxCandidatesPerBlock": 100,
-        "severity": "all",
-        "includeTests": false
-      }
-    }
-  },
-  "duplication": {
-    "results": [],
-    "summary": {
-      "totalFiles": 0,
-      "totalIssues": 0,
-      "duplicates": [],
-      "clusters": [],
-      "config": {
-        "rootDir": "/Users/pengcao/projects/aiready/packages/cli/packages/core/src",
-        "minSimilarity": 0.5,
-        "minLines": 6,
-        "approx": true,
-        "minSharedTokens": 10,
-        "maxCandidatesPerBlock": 100,
-        "severity": "all"
-      }
-    },
-    "metadata": {
-      "toolName": "pattern-detect",
-      "version": "0.12.5",
-      "timestamp": "2026-03-14T05:11:45.606Z",
-      "config": {
-        "minSimilarity": 0.5,
-        "minLines": 6,
-        "approx": true,
-        "minSharedTokens": 10,
-        "maxCandidatesPerBlock": 100,
-        "severity": "all",
-        "includeTests": false
-      }
-    }
-  },
-  "patternDetect": {
-    "results": [],
-    "summary": {
-      "totalFiles": 0,
-      "totalIssues": 0,
-      "duplicates": [],
-      "clusters": [],
-      "config": {
-        "rootDir": "/Users/pengcao/projects/aiready/packages/cli/packages/core/src",
-        "minSimilarity": 0.5,
-        "minLines": 6,
-        "approx": true,
-        "minSharedTokens": 10,
-        "maxCandidatesPerBlock": 100,
-        "severity": "all"
-      }
-    },
-    "metadata": {
-      "toolName": "pattern-detect",
-      "version": "0.12.5",
-      "timestamp": "2026-03-14T05:11:45.606Z",
-      "config": {
-        "minSimilarity": 0.5,
-        "minLines": 6,
-        "approx": true,
-        "minSharedTokens": 10,
-        "maxCandidatesPerBlock": 100,
-        "severity": "all",
-        "includeTests": false
-      }
-    }
-  },
-  "results": [],
-  "scoring": {
-    "overall": 100,
-    "rating": "Excellent",
-    "timestamp": "2026-03-14T05:11:45.608Z",
-    "toolsUsed": ["pattern-detect"],
-    "breakdown": [
-      {
-        "toolName": "pattern-detect",
-        "score": 100,
-        "rawMetrics": {
-          "totalDuplicates": 0,
-          "totalTokenCost": 0,
-          "highImpactDuplicates": 0,
-          "totalFilesAnalyzed": 0
-        },
-        "factors": [],
-        "recommendations": []
-      }
-    ],
-    "calculation": {
-      "formula": "[(100 × 22)] / 22 = 100",
-      "weights": {
-        "pattern-detect": 22
-      },
-      "normalized": "[(100 × 22)] / 22 = 100"
-    }
-  },
-  "repository": {}
-}