@aiready/doc-drift 0.13.2 → 0.13.3

package/.turbo/turbo-build.log

@@ -1,6 +1,6 @@
 
 
-> @aiready/doc-drift@0.13.2 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/cli.js   6.48 KB
 CJS dist/index.js 6.86 KB
-CJS ⚡️ Build success in 58ms
-ESM dist/index.mjs          2.37 KB
+CJS dist/cli.js   6.48 KB
+CJS ⚡️ Build success in 66ms
 ESM dist/cli.mjs            1.39 KB
+ESM dist/index.mjs          2.37 KB
 ESM dist/chunk-5BGWZWHD.mjs 3.81 KB
-ESM ⚡️ Build success in 60ms
+ESM ⚡️ Build success in 66ms
 DTS Build start
-DTS ⚡️ Build success in 1820ms
+DTS ⚡️ Build success in 3596ms
 DTS dist/cli.d.ts    108.00 B
-DTS dist/index.d.ts  1.30 KB
+DTS dist/index.d.ts  2.12 KB
 DTS dist/cli.d.mts   108.00 B
-DTS dist/index.d.mts 1.30 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,18 +1,18 @@
 
 
-> @aiready/doc-drift@0.13.1 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
 
- ✓ src/__tests__/scoring.test.ts (2 tests) 2ms
- ✓ src/__tests__/provider.test.ts (2 tests) 41ms
- ✓ src/__tests__/analyzer.test.ts (1 test) 173ms
+ ✓ 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  02:00:17
-   Duration  2.90s (transform 530ms, setup 0ms, import 5.10s, tests 216ms, 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,34 +1,56 @@
 import * as _aiready_core from '@aiready/core';
-import { Issue, IssueType, ScanOptions, ToolScoringOutput } from '@aiready/core';
+import { Issue, IssueType, ScanOptions, DocDriftRisk, ToolScoringOutput } from '@aiready/core';
 
 /**
  * Documentation Drift Tool Provider
  */
 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,34 +1,56 @@
 import * as _aiready_core from '@aiready/core';
-import { Issue, IssueType, ScanOptions, ToolScoringOutput } from '@aiready/core';
+import { Issue, IssueType, ScanOptions, DocDriftRisk, ToolScoringOutput } from '@aiready/core';
 
 /**
  * Documentation Drift Tool Provider
  */
 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/package.json

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

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/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[];
 }