@aiready/doc-drift 0.13.1 → 0.13.3

package/.turbo/turbo-build.log

@@ -1,6 +1,6 @@
 
 
-> @aiready/doc-drift@0.13.0 build /Users/pengcao/projects/aiready/packages/doc-drift
+> @aiready/doc-drift@0.13.3 build /Users/pengcao/projects/aiready/packages/doc-drift
 > tsup src/index.ts src/cli.ts --format cjs,esm --dts
 
 CLI Building entry: src/cli.ts, src/index.ts
@@ -9,16 +9,16 @@
 CLI Target: es2020
 CJS Build start
 ESM Build start
-CJS dist/index.js 7.57 KB
+CJS dist/index.js 6.86 KB
 CJS dist/cli.js   6.48 KB
-CJS ⚡️ Build success in 209ms
+CJS ⚡️ Build success in 66ms
 ESM dist/cli.mjs            1.39 KB
-ESM dist/index.mjs          3.05 KB
+ESM dist/index.mjs          2.37 KB
 ESM dist/chunk-5BGWZWHD.mjs 3.81 KB
-ESM ⚡️ Build success in 211ms
+ESM ⚡️ Build success in 66ms
 DTS Build start
-DTS ⚡️ Build success in 2935ms
+DTS ⚡️ Build success in 3596ms
 DTS dist/cli.d.ts    108.00 B
-DTS dist/index.d.ts  1.25 KB
+DTS dist/index.d.ts  2.12 KB
 DTS dist/cli.d.mts   108.00 B
-DTS dist/index.d.mts 1.25 KB
+DTS dist/index.d.mts 2.12 KB

package/.turbo/turbo-lint.log

@@ -1,6 +1,10 @@
-
-
-> @aiready/doc-drift@0.11.18 lint /Users/pengcao/projects/aiready/packages/doc-drift
-> eslint src --ext .ts
-
- ELIFECYCLE  Command failed.
+
+> @aiready/doc-drift@0.13.2 lint /Users/pengcao/projects/aiready/packages/doc-drift
+> eslint src --ext .ts
+
+
+/Users/pengcao/projects/aiready/packages/doc-drift/src/analyzer.ts
+  10:3  warning  'Language' is defined but never used  @typescript-eslint/no-unused-vars
+
+✖ 1 problem (0 errors, 1 warning)
+

package/.turbo/turbo-test.log

@@ -1,69 +1,18 @@
 
 
-> @aiready/doc-drift@0.13.0 test /Users/pengcao/projects/aiready/packages/doc-drift
+> @aiready/doc-drift@0.13.2 test /Users/pengcao/projects/aiready/packages/doc-drift
 > vitest run
 
 [?25l
  RUN  v4.0.18 /Users/pengcao/projects/aiready/packages/doc-drift
 
-[?2026h
- ❯ src/__tests__/scoring.test.ts [queued]
-
- Test Files 0 passed (3)
-      Tests 0 passed (0)
-   Start at 17:20:11
-   Duration 787ms
-[?2026l[?2026h
- ❯ src/__tests__/analyzer.test.ts [queued]
- ❯ src/__tests__/provider.test.ts [queued]
- ❯ src/__tests__/scoring.test.ts [queued]
-
- Test Files 0 passed (3)
-      Tests 0 passed (0)
-   Start at 17:20:11
-   Duration 972ms
-[?2026l[?2026h
- ❯ src/__tests__/analyzer.test.ts [queued]
- ❯ src/__tests__/provider.test.ts [queued]
- ❯ src/__tests__/scoring.test.ts [queued]
-
- Test Files 0 passed (3)
-      Tests 0 passed (0)
-   Start at 17:20:11
-   Duration 2.21s
-[?2026l[?2026h
- ❯ src/__tests__/analyzer.test.ts [queued]
- ❯ src/__tests__/provider.test.ts [queued]
- ❯ src/__tests__/scoring.test.ts [queued]
-
- Test Files 0 passed (3)
-      Tests 0 passed (0)
-   Start at 17:20:11
-   Duration 3.13s
-[?2026l[?2026h
- ❯ src/__tests__/analyzer.test.ts 0/1
- ❯ src/__tests__/provider.test.ts [queued]
- ❯ src/__tests__/scoring.test.ts [queued]
-
- Test Files 0 passed (3)
-      Tests 0 passed (1)
-   Start at 17:20:11
-   Duration 3.44s
-[?2026l[?2026h ✓ src/__tests__/scoring.test.ts (2 tests) 1ms
-
- ❯ src/__tests__/analyzer.test.ts 0/1
- ❯ src/__tests__/provider.test.ts 0/2
-
- Test Files 1 passed (3)
-      Tests 2 passed (5)
-   Start at 17:20:11
-   Duration 3.54s
-[?2026l ✓ src/__tests__/provider.test.ts (2 tests) 4ms
- ✓ src/__tests__/analyzer.test.ts (1 test) 208ms
+ ✓ src/__tests__/scoring.test.ts (2 tests) 4ms
+ ✓ src/__tests__/provider.test.ts (2 tests) 3ms
+ ✓ src/__tests__/analyzer.test.ts (1 test) 143ms
 
  Test Files  3 passed (3)
       Tests  5 passed (5)
-   Start at  17:20:11
-   Duration  3.68s (transform 4.03s, setup 0ms, import 8.07s, tests 214ms, environment 0ms)
+   Start at  22:20:40
+   Duration  2.77s (transform 914ms, setup 0ms, import 3.95s, tests 150ms, environment 0ms)
 
 [?25h

package/dist/index.d.mts

@@ -1,33 +1,56 @@
-import { ToolProvider, Issue, IssueType, ScanOptions, ToolScoringOutput } from '@aiready/core';
+import * as _aiready_core from '@aiready/core';
+import { Issue, IssueType, ScanOptions, DocDriftRisk, ToolScoringOutput } from '@aiready/core';
 
 /**
  * Documentation Drift Tool Provider
  */
-declare const DocDriftProvider: ToolProvider;
+declare const DocDriftProvider: _aiready_core.ToolProvider;
 
+/**
+ * Options for documentation drift analysis
+ */
 interface DocDriftOptions extends ScanOptions {
     /** Maximum commit distance to check for drift */
     maxCommits?: number;
     /** Consider comments older than this many months as outdated */
     staleMonths?: number;
 }
+/**
+ * Documentation drift specific issue
+ */
 interface DocDriftIssue extends Issue {
+    /** Type identifier for doc-drift issues */
     type: IssueType.DocDrift;
 }
+/**
+ * Comprehensive report for doc-drift analysis
+ */
 interface DocDriftReport {
+    /** High-level summary of the drift status */
     summary: {
+        /** Total number of files checked */
         filesAnalyzed: number;
+        /** Total number of exported functions/classes checked */
         functionsAnalyzed: number;
+        /** Final doc-drift score (0-100) */
         score: number;
-        rating: 'minimal' | 'low' | 'moderate' | 'high' | 'severe';
+        /** Qualitative rating (minimal to severe) */
+        rating: DocDriftRisk['rating'];
     };
+    /** List of detected drift points */
     issues: DocDriftIssue[];
+    /** Detailed counts for the three drift dimensions */
     rawData: {
+        /** Number of exports without JSDoc/comments */
         uncommentedExports: number;
+        /** Total number of exports in the analyzed set */
         totalExports: number;
+        /** Number of comments considered stale/outdated */
         outdatedComments: number;
+        /** Count of complex functions without sufficient documentation */
         undocumentedComplexity: number;
     };
+    /** AI-generated remediation advice */
     recommendations: string[];
 }
 

package/dist/index.d.ts

@@ -1,33 +1,56 @@
-import { ToolProvider, Issue, IssueType, ScanOptions, ToolScoringOutput } from '@aiready/core';
+import * as _aiready_core from '@aiready/core';
+import { Issue, IssueType, ScanOptions, DocDriftRisk, ToolScoringOutput } from '@aiready/core';
 
 /**
  * Documentation Drift Tool Provider
  */
-declare const DocDriftProvider: ToolProvider;
+declare const DocDriftProvider: _aiready_core.ToolProvider;
 
+/**
+ * Options for documentation drift analysis
+ */
 interface DocDriftOptions extends ScanOptions {
     /** Maximum commit distance to check for drift */
     maxCommits?: number;
     /** Consider comments older than this many months as outdated */
     staleMonths?: number;
 }
+/**
+ * Documentation drift specific issue
+ */
 interface DocDriftIssue extends Issue {
+    /** Type identifier for doc-drift issues */
     type: IssueType.DocDrift;
 }
+/**
+ * Comprehensive report for doc-drift analysis
+ */
 interface DocDriftReport {
+    /** High-level summary of the drift status */
     summary: {
+        /** Total number of files checked */
         filesAnalyzed: number;
+        /** Total number of exported functions/classes checked */
         functionsAnalyzed: number;
+        /** Final doc-drift score (0-100) */
         score: number;
-        rating: 'minimal' | 'low' | 'moderate' | 'high' | 'severe';
+        /** Qualitative rating (minimal to severe) */
+        rating: DocDriftRisk['rating'];
     };
+    /** List of detected drift points */
     issues: DocDriftIssue[];
+    /** Detailed counts for the three drift dimensions */
     rawData: {
+        /** Number of exports without JSDoc/comments */
         uncommentedExports: number;
+        /** Total number of exports in the analyzed set */
         totalExports: number;
+        /** Number of comments considered stale/outdated */
         outdatedComments: number;
+        /** Count of complex functions without sufficient documentation */
         undocumentedComplexity: number;
     };
+    /** AI-generated remediation advice */
     recommendations: string[];
 }
 

package/dist/index.js

@@ -141,57 +141,29 @@ async function analyzeDocDrift(options) {
 }
 
 // src/provider.ts
-var DocDriftProvider = {
+var DocDriftProvider = (0, import_core2.createProvider)({
   id: import_core2.ToolName.DocDrift,
   alias: ["doc-drift", "docs", "jsdoc"],
-  async analyze(options) {
-    const report = await analyzeDocDrift(options);
-    const fileIssuesMap = /* @__PURE__ */ new Map();
-    for (const issue of report.issues) {
-      const file = issue.location.file;
-      if (!fileIssuesMap.has(file)) fileIssuesMap.set(file, []);
-      fileIssuesMap.get(file).push(issue);
-    }
-    const results = Array.from(fileIssuesMap.entries()).map(
-      ([fileName, issues]) => ({
-        fileName,
-        issues,
-        metrics: {}
-      })
-    );
-    return import_core2.SpokeOutputSchema.parse({
-      results,
-      summary: report.summary,
-      metadata: {
-        toolName: import_core2.ToolName.DocDrift,
-        version: "0.9.5",
-        timestamp: (/* @__PURE__ */ new Date()).toISOString(),
-        rawData: report.rawData
-      }
-    });
+  version: "0.9.5",
+  defaultWeight: 8,
+  async analyzeReport(options) {
+    return analyzeDocDrift(options);
+  },
+  getResults(report) {
+    return (0, import_core2.groupIssuesByFile)(report.issues);
+  },
+  getSummary(report) {
+    return report.summary;
   },
-  score(output, options) {
+  getMetadata(report) {
+    return { rawData: report.rawData };
+  },
+  score(output) {
     const summary = output.summary;
     const rawData = output.metadata?.rawData || {};
-    return {
-      toolName: import_core2.ToolName.DocDrift,
-      score: summary.score || 0,
-      rawMetrics: {
-        ...summary,
-        ...rawData
-      },
-      factors: [],
-      recommendations: (summary.recommendations || []).map(
-        (action) => ({
-          action,
-          estimatedImpact: 5,
-          priority: "medium"
-        })
-      )
-    };
-  },
-  defaultWeight: 8
-};
+    return (0, import_core2.buildSimpleProviderScore)(import_core2.ToolName.DocDrift, summary, rawData);
+  }
+});
 
 // src/scoring.ts
 var import_core3 = require("@aiready/core");

package/dist/index.mjs

@@ -7,60 +7,34 @@ import { ToolRegistry } from "@aiready/core";
 
 // src/provider.ts
 import {
+  createProvider,
   ToolName,
-  SpokeOutputSchema
+  groupIssuesByFile,
+  buildSimpleProviderScore
 } from "@aiready/core";
-var DocDriftProvider = {
+var DocDriftProvider = createProvider({
   id: ToolName.DocDrift,
   alias: ["doc-drift", "docs", "jsdoc"],
-  async analyze(options) {
-    const report = await analyzeDocDrift(options);
-    const fileIssuesMap = /* @__PURE__ */ new Map();
-    for (const issue of report.issues) {
-      const file = issue.location.file;
-      if (!fileIssuesMap.has(file)) fileIssuesMap.set(file, []);
-      fileIssuesMap.get(file).push(issue);
-    }
-    const results = Array.from(fileIssuesMap.entries()).map(
-      ([fileName, issues]) => ({
-        fileName,
-        issues,
-        metrics: {}
-      })
-    );
-    return SpokeOutputSchema.parse({
-      results,
-      summary: report.summary,
-      metadata: {
-        toolName: ToolName.DocDrift,
-        version: "0.9.5",
-        timestamp: (/* @__PURE__ */ new Date()).toISOString(),
-        rawData: report.rawData
-      }
-    });
+  version: "0.9.5",
+  defaultWeight: 8,
+  async analyzeReport(options) {
+    return analyzeDocDrift(options);
+  },
+  getResults(report) {
+    return groupIssuesByFile(report.issues);
+  },
+  getSummary(report) {
+    return report.summary;
   },
-  score(output, options) {
+  getMetadata(report) {
+    return { rawData: report.rawData };
+  },
+  score(output) {
     const summary = output.summary;
     const rawData = output.metadata?.rawData || {};
-    return {
-      toolName: ToolName.DocDrift,
-      score: summary.score || 0,
-      rawMetrics: {
-        ...summary,
-        ...rawData
-      },
-      factors: [],
-      recommendations: (summary.recommendations || []).map(
-        (action) => ({
-          action,
-          estimatedImpact: 5,
-          priority: "medium"
-        })
-      )
-    };
-  },
-  defaultWeight: 8
-};
+    return buildSimpleProviderScore(ToolName.DocDrift, summary, rawData);
+  }
+});
 
 // src/scoring.ts
 import { calculateDocDrift, ToolName as ToolName2 } from "@aiready/core";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aiready/doc-drift",
-  "version": "0.13.1",
+  "version": "0.13.3",
   "description": "AI-Readiness: Documentation Drift Detection",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
@@ -10,7 +10,7 @@
     "commander": "^14.0.0",
     "glob": "^13.0.0",
     "picocolors": "^1.0.0",
-    "@aiready/core": "0.23.1"
+    "@aiready/core": "0.23.3"
   },
   "devDependencies": {
     "@types/node": "^24.0.0",

package/src/__tests__/provider.test.ts

@@ -28,7 +28,7 @@ describe('Doc Drift Provider', () => {
     const output = await DocDriftProvider.analyze({ rootDir: '.' });
 
     expect(output.summary.filesAnalyzed).toBe(1);
-    expect(output.metadata.toolName).toBe('doc-drift');
+    expect(output.metadata!.toolName).toBe('doc-drift');
   });
 
   it('should score an output', () => {

package/src/__tests__/scoring.test.ts

@@ -9,7 +9,7 @@ describe('Doc Drift Scoring', () => {
       filesAnalyzed: 10,
       functionsAnalyzed: 50,
       score: 70,
-      rating: 'good',
+      rating: 'moderate',
     },
     issues: [],
     rawData: {

package/src/analyzer.ts

@@ -7,7 +7,6 @@ import {
   IssueType,
   emitProgress,
   getParser,
-  Language,
 } from '@aiready/core';
 import type { DocDriftOptions, DocDriftReport, DocDriftIssue } from './types';
 import { readFileSync } from 'fs';

package/src/provider.ts

@@ -1,74 +1,36 @@
 import {
-  ToolProvider,
+  createProvider,
   ToolName,
-  SpokeOutput,
   ScanOptions,
-  ToolScoringOutput,
-  AnalysisResult,
-  SpokeOutputSchema,
+  groupIssuesByFile,
+  buildSimpleProviderScore,
 } from '@aiready/core';
 import { analyzeDocDrift } from './analyzer';
-import { DocDriftOptions, DocDriftIssue } from './types';
+import { DocDriftOptions } from './types';
 
 /**
  * Documentation Drift Tool Provider
  */
-export const DocDriftProvider: ToolProvider = {
+export const DocDriftProvider = createProvider({
   id: ToolName.DocDrift,
   alias: ['doc-drift', 'docs', 'jsdoc'],
-
-  async analyze(options: ScanOptions): Promise<SpokeOutput> {
-    const report = await analyzeDocDrift(options as DocDriftOptions);
-
-    // Group issues by file for AnalysisResult format
-    const fileIssuesMap = new Map<string, DocDriftIssue[]>();
-    for (const issue of report.issues) {
-      const file = issue.location.file;
-      if (!fileIssuesMap.has(file)) fileIssuesMap.set(file, []);
-      fileIssuesMap.get(file)!.push(issue);
-    }
-
-    const results: AnalysisResult[] = Array.from(fileIssuesMap.entries()).map(
-      ([fileName, issues]) => ({
-        fileName,
-        issues: issues as any[],
-        metrics: {},
-      })
-    );
-
-    return SpokeOutputSchema.parse({
-      results,
-      summary: report.summary,
-      metadata: {
-        toolName: ToolName.DocDrift,
-        version: '0.9.5',
-        timestamp: new Date().toISOString(),
-        rawData: report.rawData,
-      },
-    });
+  version: '0.9.5',
+  defaultWeight: 8,
+  async analyzeReport(options: ScanOptions) {
+    return analyzeDocDrift(options as DocDriftOptions);
   },
-
-  score(output: SpokeOutput, options: ScanOptions): ToolScoringOutput {
+  getResults(report) {
+    return groupIssuesByFile(report.issues);
+  },
+  getSummary(report) {
+    return report.summary;
+  },
+  getMetadata(report) {
+    return { rawData: report.rawData };
+  },
+  score(output) {
     const summary = output.summary as any;
     const rawData = (output.metadata as any)?.rawData || {};
-
-    return {
-      toolName: ToolName.DocDrift,
-      score: summary.score || 0,
-      rawMetrics: {
-        ...summary,
-        ...rawData,
-      },
-      factors: [],
-      recommendations: (summary.recommendations || []).map(
-        (action: string) => ({
-          action,
-          estimatedImpact: 5,
-          priority: 'medium',
-        })
-      ),
-    };
+    return buildSimpleProviderScore(ToolName.DocDrift, summary, rawData);
   },
-
-  defaultWeight: 8,
-};
+});

package/src/types.ts

@@ -1,5 +1,13 @@
-import type { ScanOptions, Issue, IssueType } from '@aiready/core';
+import type {
+  ScanOptions,
+  Issue,
+  IssueType,
+  DocDriftRisk,
+} from '@aiready/core';
 
+/**
+ * Options for documentation drift analysis
+ */
 export interface DocDriftOptions extends ScanOptions {
   /** Maximum commit distance to check for drift */
   maxCommits?: number;
@@ -7,23 +15,42 @@ export interface DocDriftOptions extends ScanOptions {
   staleMonths?: number;
 }
 
+/**
+ * Documentation drift specific issue
+ */
 export interface DocDriftIssue extends Issue {
+  /** Type identifier for doc-drift issues */
   type: IssueType.DocDrift;
 }
 
+/**
+ * Comprehensive report for doc-drift analysis
+ */
 export interface DocDriftReport {
+  /** High-level summary of the drift status */
   summary: {
+    /** Total number of files checked */
     filesAnalyzed: number;
+    /** Total number of exported functions/classes checked */
     functionsAnalyzed: number;
+    /** Final doc-drift score (0-100) */
     score: number;
-    rating: 'minimal' | 'low' | 'moderate' | 'high' | 'severe';
+    /** Qualitative rating (minimal to severe) */
+    rating: DocDriftRisk['rating'];
   };
+  /** List of detected drift points */
   issues: DocDriftIssue[];
+  /** Detailed counts for the three drift dimensions */
   rawData: {
+    /** Number of exports without JSDoc/comments */
     uncommentedExports: number;
+    /** Total number of exports in the analyzed set */
     totalExports: number;
+    /** Number of comments considered stale/outdated */
     outdatedComments: number;
+    /** Count of complex functions without sufficient documentation */
     undocumentedComplexity: number;
   };
+  /** AI-generated remediation advice */
   recommendations: string[];
 }