@aiready/doc-drift 0.13.22 → 0.14.0

package/.turbo/turbo-build.log

@@ -1,5 +1,5 @@
 
-> @aiready/doc-drift@0.13.22 build /Users/pengcao/projects/aiready/packages/doc-drift
+> @aiready/doc-drift@0.14.0 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
@@ -8,15 +8,15 @@ CLI tsup v8.5.1
 CLI Target: es2020
 CJS Build start
 ESM Build start
-ESM dist/cli.mjs            1.39 KB
 ESM dist/chunk-GZDN7B4K.mjs 4.40 KB
-ESM dist/index.mjs          2.59 KB
-ESM ⚡️ Build success in 53ms
-CJS dist/cli.js   7.11 KB
-CJS dist/index.js 7.71 KB
-CJS ⚡️ Build success in 53ms
+ESM dist/cli.mjs            1.07 KB
+ESM dist/index.mjs          1.87 KB
+ESM ⚡️ Build success in 217ms
+CJS dist/cli.js   6.71 KB
+CJS dist/index.js 6.98 KB
+CJS ⚡️ Build success in 219ms
 DTS Build start
-DTS ⚡️ Build success in 2579ms
+DTS ⚡️ Build success in 6867ms
 DTS dist/cli.d.ts    108.00 B
 DTS dist/index.d.ts  2.83 KB
 DTS dist/cli.d.mts   108.00 B

package/.turbo/turbo-test.log

@@ -1,16 +1,16 @@
 
-> @aiready/doc-drift@0.13.21 test /Users/pengcao/projects/aiready/packages/doc-drift
+> @aiready/doc-drift@0.13.23 test /Users/pengcao/projects/aiready/packages/doc-drift
 > vitest run
 
 
  RUN  v4.0.18 /Users/pengcao/projects/aiready/packages/doc-drift
 
- ✓ src/__tests__/scoring.test.ts (2 tests) 4ms
- ✓ src/__tests__/provider.test.ts (2 tests) 8ms
- ✓ src/__tests__/analyzer.test.ts (1 test) 94ms
+ ✓ src/__tests__/provider.test.ts (2 tests) 12ms
+ ✓ src/__tests__/scoring.test.ts (2 tests) 2ms
+ ✓ src/__tests__/analyzer.test.ts (1 test) 71ms
 
  Test Files  3 passed (3)
       Tests  5 passed (5)
-   Start at  19:39:18
-   Duration  3.04s (transform 1.88s, setup 0ms, import 6.70s, tests 106ms, environment 0ms)
+   Start at  15:17:51
+   Duration  2.73s (transform 880ms, setup 0ms, import 6.70s, tests 85ms, environment 0ms)
 

package/dist/cli.js

@@ -158,6 +158,7 @@ async function analyzeDocDrift(options) {
 }
 
 // src/cli.ts
+var import_core2 = require("@aiready/core");
 var import_picocolors = __toESM(require("picocolors"));
 function createCommand() {
   const program = new import_commander.Command("doc-drift").description(
@@ -167,23 +168,16 @@ function createCommand() {
     "Months before a comment is considered potentially outdated",
     "6"
   ).action(async (options) => {
-    console.log(import_picocolors.default.cyan("Analyzing documentation drift..."));
-    const report = await analyzeDocDrift({
-      rootDir: process.cwd(),
-      include: options.include,
-      exclude: options.exclude,
-      staleMonths: parseInt(options.staleMonths, 10)
-    });
-    console.log(import_picocolors.default.bold("Doc Drift Analysis Results:"));
-    console.log(
-      `Rating: ${report.summary.rating.toUpperCase()} (Score: ${report.summary.score})`
+    await (0, import_core2.executeSpokeCli)(
+      "Doc Drift",
+      "documentation drift",
+      {
+        include: options.include,
+        exclude: options.exclude,
+        staleMonths: parseInt(options.staleMonths, 10)
+      },
+      analyzeDocDrift
     );
-    if (report.issues.length > 0) {
-      console.log(import_picocolors.default.red(`
-Found ${report.issues.length} drift issues.`));
-    } else {
-      console.log(import_picocolors.default.green("\nNo documentation drift detected."));
-    }
   });
   return program;
 }

package/dist/cli.mjs

@@ -5,6 +5,7 @@ import {
 
 // src/cli.ts
 import { Command } from "commander";
+import { executeSpokeCli } from "@aiready/core";
 import pc from "picocolors";
 function createCommand() {
   const program = new Command("doc-drift").description(
@@ -14,23 +15,16 @@ function createCommand() {
     "Months before a comment is considered potentially outdated",
     "6"
   ).action(async (options) => {
-    console.log(pc.cyan("Analyzing documentation drift..."));
-    const report = await analyzeDocDrift({
-      rootDir: process.cwd(),
-      include: options.include,
-      exclude: options.exclude,
-      staleMonths: parseInt(options.staleMonths, 10)
-    });
-    console.log(pc.bold("Doc Drift Analysis Results:"));
-    console.log(
-      `Rating: ${report.summary.rating.toUpperCase()} (Score: ${report.summary.score})`
+    await executeSpokeCli(
+      "Doc Drift",
+      "documentation drift",
+      {
+        include: options.include,
+        exclude: options.exclude,
+        staleMonths: parseInt(options.staleMonths, 10)
+      },
+      analyzeDocDrift
     );
-    if (report.issues.length > 0) {
-      console.log(pc.red(`
-Found ${report.issues.length} drift issues.`));
-    } else {
-      console.log(pc.green("\nNo documentation drift detected."));
-    }
   });
   return program;
 }

package/dist/index.d.mts

@@ -73,7 +73,7 @@ declare function analyzeDocDrift(options: DocDriftOptions): Promise<DocDriftRepo
  *
  * @param report - The detailed doc-drift report including raw metrics.
  * @returns Standardized scoring and risk factor breakdown.
- * @lastUpdated 2026-03-18
+ * @lastUpdated 2026-03-24
  */
 declare function calculateDocDriftScore(report: DocDriftReport): ToolScoringOutput;
 

package/dist/index.d.ts

@@ -73,7 +73,7 @@ declare function analyzeDocDrift(options: DocDriftOptions): Promise<DocDriftRepo
  *
  * @param report - The detailed doc-drift report including raw metrics.
  * @returns Standardized scoring and risk factor breakdown.
- * @lastUpdated 2026-03-18
+ * @lastUpdated 2026-03-24
  */
 declare function calculateDocDriftScore(report: DocDriftReport): ToolScoringOutput;
 

package/dist/index.js

@@ -188,47 +188,19 @@ function calculateDocDriftScore(report) {
     undocumentedComplexity: rawData.undocumentedComplexity,
     actualDrift: rawData.actualDrift
   });
-  const factors = [
-    {
-      name: "Undocumented Complexity",
-      impact: -Math.min(
-        50,
-        rawData.undocumentedComplexity / Math.max(1, rawData.totalExports) / 0.2 * 100 * 0.5
-      ),
-      description: `${rawData.undocumentedComplexity} complex functions lack docs (high risk)`
-    },
-    {
-      name: "Outdated/Incomplete Comments",
-      impact: -Math.min(
-        30,
-        rawData.outdatedComments / Math.max(1, rawData.totalExports) / 0.4 * 100 * 0.3
-      ),
-      description: `${rawData.outdatedComments} functions with parameter-mismatch in docs`
-    },
-    {
-      name: "Uncommented Exports",
-      impact: -Math.min(
-        20,
-        rawData.uncommentedExports / Math.max(1, rawData.totalExports) / 0.8 * 100 * 0.2
-      ),
-      description: `${rawData.uncommentedExports} uncommented exports`
-    }
-  ];
-  const recommendations = riskResult.recommendations.map((rec) => ({
-    action: rec,
-    estimatedImpact: 8,
-    priority: summary.score < 50 ? "high" : "medium"
-  }));
-  return {
+  return (0, import_core3.buildStandardToolScore)({
     toolName: import_core3.ToolName.DocDrift,
     score: summary.score,
-    rawMetrics: {
-      ...rawData,
-      rating: summary.rating
+    rawData,
+    dimensions: riskResult.dimensions,
+    dimensionNames: {
+      undocumentedComplexityScore: "Undocumented Complexity",
+      outdatedCommentsScore: "Outdated/Incomplete Comments",
+      uncommentedExportsScore: "Uncommented Exports"
     },
-    factors,
-    recommendations
-  };
+    recommendations: riskResult.recommendations,
+    rating: summary.rating
+  });
 }
 
 // src/index.ts

package/dist/index.mjs

@@ -37,7 +37,11 @@ var DocDriftProvider = createProvider({
 });
 
 // src/scoring.ts
-import { calculateDocDrift, ToolName as ToolName2 } from "@aiready/core";
+import {
+  calculateDocDrift,
+  ToolName as ToolName2,
+  buildStandardToolScore
+} from "@aiready/core";
 function calculateDocDriftScore(report) {
   const { rawData, summary } = report;
   const riskResult = calculateDocDrift({
@@ -47,47 +51,19 @@ function calculateDocDriftScore(report) {
     undocumentedComplexity: rawData.undocumentedComplexity,
     actualDrift: rawData.actualDrift
   });
-  const factors = [
-    {
-      name: "Undocumented Complexity",
-      impact: -Math.min(
-        50,
-        rawData.undocumentedComplexity / Math.max(1, rawData.totalExports) / 0.2 * 100 * 0.5
-      ),
-      description: `${rawData.undocumentedComplexity} complex functions lack docs (high risk)`
-    },
-    {
-      name: "Outdated/Incomplete Comments",
-      impact: -Math.min(
-        30,
-        rawData.outdatedComments / Math.max(1, rawData.totalExports) / 0.4 * 100 * 0.3
-      ),
-      description: `${rawData.outdatedComments} functions with parameter-mismatch in docs`
-    },
-    {
-      name: "Uncommented Exports",
-      impact: -Math.min(
-        20,
-        rawData.uncommentedExports / Math.max(1, rawData.totalExports) / 0.8 * 100 * 0.2
-      ),
-      description: `${rawData.uncommentedExports} uncommented exports`
-    }
-  ];
-  const recommendations = riskResult.recommendations.map((rec) => ({
-    action: rec,
-    estimatedImpact: 8,
-    priority: summary.score < 50 ? "high" : "medium"
-  }));
-  return {
+  return buildStandardToolScore({
     toolName: ToolName2.DocDrift,
     score: summary.score,
-    rawMetrics: {
-      ...rawData,
-      rating: summary.rating
+    rawData,
+    dimensions: riskResult.dimensions,
+    dimensionNames: {
+      undocumentedComplexityScore: "Undocumented Complexity",
+      outdatedCommentsScore: "Outdated/Incomplete Comments",
+      uncommentedExportsScore: "Uncommented Exports"
     },
-    factors,
-    recommendations
-  };
+    recommendations: riskResult.recommendations,
+    rating: summary.rating
+  });
 }
 
 // src/index.ts

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aiready/doc-drift",
-  "version": "0.13.22",
+  "version": "0.14.0",
   "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.23"
+    "@aiready/core": "0.24.0"
   },
   "devDependencies": {
     "@types/node": "^24.0.0",

package/src/cli.ts

@@ -1,5 +1,6 @@
 import { Command } from 'commander';
 import { analyzeDocDrift } from './analyzer';
+import { executeSpokeCli } from '@aiready/core';
 import pc from 'picocolors';
 
 export function createCommand() {
@@ -15,23 +16,16 @@ export function createCommand() {
       '6'
     )
     .action(async (options) => {
-      console.log(pc.cyan('Analyzing documentation drift...'));
-      const report = await analyzeDocDrift({
-        rootDir: process.cwd(),
-        include: options.include,
-        exclude: options.exclude,
-        staleMonths: parseInt(options.staleMonths, 10),
-      });
-
-      console.log(pc.bold('Doc Drift Analysis Results:'));
-      console.log(
-        `Rating: ${report.summary.rating.toUpperCase()} (Score: ${report.summary.score})`
+      await executeSpokeCli(
+        'Doc Drift',
+        'documentation drift',
+        {
+          include: options.include,
+          exclude: options.exclude,
+          staleMonths: parseInt(options.staleMonths, 10),
+        },
+        analyzeDocDrift
       );
-      if (report.issues.length > 0) {
-        console.log(pc.red(`\nFound ${report.issues.length} drift issues.`));
-      } else {
-        console.log(pc.green('\nNo documentation drift detected.'));
-      }
     });
 
   return program;

package/src/scoring.ts

@@ -1,4 +1,8 @@
-import { calculateDocDrift, ToolName } from '@aiready/core';
+import {
+  calculateDocDrift,
+  ToolName,
+  buildStandardToolScore,
+} from '@aiready/core';
 import type { ToolScoringOutput } from '@aiready/core';
 import type { DocDriftReport } from './types';
 
@@ -7,7 +11,7 @@ import type { DocDriftReport } from './types';
  *
  * @param report - The detailed doc-drift report including raw metrics.
  * @returns Standardized scoring and risk factor breakdown.
- * @lastUpdated 2026-03-18
+ * @lastUpdated 2026-03-24
  */
 export function calculateDocDriftScore(
   report: DocDriftReport
@@ -23,56 +27,17 @@ export function calculateDocDriftScore(
     actualDrift: rawData.actualDrift,
   });
 
-  const factors: ToolScoringOutput['factors'] = [
-    {
-      name: 'Undocumented Complexity',
-      impact: -Math.min(
-        50,
-        (rawData.undocumentedComplexity /
-          Math.max(1, rawData.totalExports) /
-          0.2) *
-          100 *
-          0.5
-      ),
-      description: `${rawData.undocumentedComplexity} complex functions lack docs (high risk)`,
-    },
-    {
-      name: 'Outdated/Incomplete Comments',
-      impact: -Math.min(
-        30,
-        (rawData.outdatedComments / Math.max(1, rawData.totalExports) / 0.4) *
-          100 *
-          0.3
-      ),
-      description: `${rawData.outdatedComments} functions with parameter-mismatch in docs`,
-    },
-    {
-      name: 'Uncommented Exports',
-      impact: -Math.min(
-        20,
-        (rawData.uncommentedExports / Math.max(1, rawData.totalExports) / 0.8) *
-          100 *
-          0.2
-      ),
-      description: `${rawData.uncommentedExports} uncommented exports`,
-    },
-  ];
-
-  const recommendations: ToolScoringOutput['recommendations'] =
-    riskResult.recommendations.map((rec) => ({
-      action: rec,
-      estimatedImpact: 8,
-      priority: summary.score < 50 ? 'high' : 'medium',
-    }));
-
-  return {
+  return buildStandardToolScore({
     toolName: ToolName.DocDrift,
     score: summary.score,
-    rawMetrics: {
-      ...rawData,
-      rating: summary.rating,
+    rawData,
+    dimensions: riskResult.dimensions,
+    dimensionNames: {
+      undocumentedComplexityScore: 'Undocumented Complexity',
+      outdatedCommentsScore: 'Outdated/Incomplete Comments',
+      uncommentedExportsScore: 'Uncommented Exports',
     },
-    factors,
-    recommendations,
-  };
+    recommendations: riskResult.recommendations,
+    rating: summary.rating,
+  });
 }