@aiready/doc-drift 0.9.5 → 0.11.0

package/.turbo/turbo-build.log

@@ -1,6 +1,6 @@
 
 
-> @aiready/doc-drift@0.9.4 build /Users/pengcao/projects/aiready/packages/doc-drift
+> @aiready/doc-drift@0.10.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
@@ -9,58 +9,16 @@
 CLI Target: es2020
 CJS Build start
 ESM Build start
-
- WARN  ▲ [WARNING] The condition "types" here will never be used as it comes after both "import" and "require" [package.json]       9:38:41 pm
-
-    package.json:33:6:
-      33 │       "types": "./dist/index.d.ts"
-         ╵       ~~~~~~~
-
-  The "import" condition comes earlier and will be used for all "import" statements:
-
-    package.json:31:6:
-      31 │       "import": "./dist/index.mjs",
-         ╵       ~~~~~~~~
-
-  The "require" condition comes earlier and will be used for all "require" calls:
-
-    package.json:32:6:
-      32 │       "require": "./dist/index.js",
-         ╵       ~~~~~~~~~
-
-
-
-
- WARN  ▲ [WARNING] The condition "types" here will never be used as it comes after both "import" and "require" [package.json]       9:38:41 pm
-
-    package.json:33:6:
-      33 │       "types": "./dist/index.d.ts"
-         ╵       ~~~~~~~
-
-  The "import" condition comes earlier and will be used for all "import" statements:
-
-    package.json:31:6:
-      31 │       "import": "./dist/index.mjs",
-         ╵       ~~~~~~~~
-
-  The "require" condition comes earlier and will be used for all "require" calls:
-
-    package.json:32:6:
-      32 │       "require": "./dist/index.js",
-         ╵       ~~~~~~~~~
-
-
-
-CJS dist/index.js 5.57 KB
-CJS dist/cli.js   7.60 KB
-CJS ⚡️ Build success in 92ms
-ESM dist/chunk-CGSYYULO.mjs 4.85 KB
-ESM dist/index.mjs          88.00 B
 ESM dist/cli.mjs            1.39 KB
-ESM ⚡️ Build success in 92ms
+ESM dist/index.mjs          1.63 KB
+ESM dist/chunk-CGSYYULO.mjs 4.85 KB
+ESM ⚡️ Build success in 44ms
+CJS dist/cli.js   7.60 KB
+CJS dist/index.js 7.21 KB
+CJS ⚡️ Build success in 44ms
 DTS Build start
-DTS ⚡️ Build success in 3989ms
+DTS ⚡️ Build success in 2730ms
 DTS dist/cli.d.ts    108.00 B
-DTS dist/index.d.ts  968.00 B
+DTS dist/index.d.ts  1.07 KB
 DTS dist/cli.d.mts   108.00 B
-DTS dist/index.d.mts 968.00 B
+DTS dist/index.d.mts 1.07 KB

package/.turbo/turbo-lint.log

@@ -1,5 +1,5 @@
 
 
-> @aiready/doc-drift@0.1.6 lint /Users/pengcao/projects/aiready/packages/doc-drift
+> @aiready/doc-drift@0.9.5 lint /Users/pengcao/projects/aiready/packages/doc-drift
 > eslint src --ext .ts
 

package/.turbo/turbo-test.log

@@ -1,16 +1,16 @@
 
 
-> @aiready/doc-drift@0.9.4 test /Users/pengcao/projects/aiready/packages/doc-drift
+> @aiready/doc-drift@0.10.0 test /Users/pengcao/projects/aiready/packages/doc-drift
 > vitest run
 
 [?25l
  RUN  v4.0.18 /Users/pengcao/projects/aiready/packages/doc-drift
 
- ✓ src/__tests__/analyzer.test.ts (1 test) 141ms
+ ✓ src/__tests__/analyzer.test.ts (1 test) 19ms
 
  Test Files  1 passed (1)
       Tests  1 passed (1)
-   Start at  21:39:02
-   Duration  1.20s (transform 184ms, setup 0ms, import 739ms, tests 141ms, environment 0ms)
+   Start at  09:33:04
+   Duration  442ms (transform 132ms, setup 0ms, import 317ms, tests 19ms, environment 0ms)
 
 [?25h

package/dist/index.d.mts

@@ -1,4 +1,9 @@
-import { Issue, IssueType, ScanOptions } from '@aiready/core';
+import { ToolProvider, Issue, IssueType, ScanOptions } from '@aiready/core';
+
+/**
+ * Documentation Drift Tool Provider
+ */
+declare const DocDriftProvider: ToolProvider;
 
 interface DocDriftOptions extends ScanOptions {
     /** Maximum commit distance to check for drift */
@@ -28,4 +33,4 @@ interface DocDriftReport {
 
 declare function analyzeDocDrift(options: DocDriftOptions): Promise<DocDriftReport>;
 
-export { type DocDriftIssue, type DocDriftOptions, type DocDriftReport, analyzeDocDrift };
+export { type DocDriftIssue, type DocDriftOptions, DocDriftProvider, type DocDriftReport, analyzeDocDrift };

package/dist/index.d.ts

@@ -1,4 +1,9 @@
-import { Issue, IssueType, ScanOptions } from '@aiready/core';
+import { ToolProvider, Issue, IssueType, ScanOptions } from '@aiready/core';
+
+/**
+ * Documentation Drift Tool Provider
+ */
+declare const DocDriftProvider: ToolProvider;
 
 interface DocDriftOptions extends ScanOptions {
     /** Maximum commit distance to check for drift */
@@ -28,4 +33,4 @@ interface DocDriftReport {
 
 declare function analyzeDocDrift(options: DocDriftOptions): Promise<DocDriftReport>;
 
-export { type DocDriftIssue, type DocDriftOptions, type DocDriftReport, analyzeDocDrift };
+export { type DocDriftIssue, type DocDriftOptions, DocDriftProvider, type DocDriftReport, analyzeDocDrift };

package/dist/index.js

@@ -20,9 +20,14 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/index.ts
 var index_exports = {};
 __export(index_exports, {
+  DocDriftProvider: () => DocDriftProvider,
   analyzeDocDrift: () => analyzeDocDrift
 });
 module.exports = __toCommonJS(index_exports);
+var import_core3 = require("@aiready/core");
+
+// src/provider.ts
+var import_core2 = require("@aiready/core");
 
 // src/analyzer.ts
 var import_core = require("@aiready/core");
@@ -150,7 +155,64 @@ async function analyzeDocDrift(options) {
     recommendations: riskResult.recommendations
   };
 }
+
+// src/provider.ts
+var DocDriftProvider = {
+  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
+      }
+    });
+  },
+  score(output, options) {
+    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
+};
+
+// src/index.ts
+import_core3.ToolRegistry.register(DocDriftProvider);
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  DocDriftProvider,
   analyzeDocDrift
 });

package/dist/index.mjs

@@ -1,6 +1,70 @@
 import {
   analyzeDocDrift
 } from "./chunk-CGSYYULO.mjs";
+
+// src/index.ts
+import { ToolRegistry } from "@aiready/core";
+
+// src/provider.ts
+import {
+  ToolName,
+  SpokeOutputSchema
+} from "@aiready/core";
+var DocDriftProvider = {
+  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
+      }
+    });
+  },
+  score(output, options) {
+    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
+};
+
+// src/index.ts
+ToolRegistry.register(DocDriftProvider);
 export {
+  DocDriftProvider,
   analyzeDocDrift
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aiready/doc-drift",
-  "version": "0.9.5",
+  "version": "0.11.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.19.5"
+    "@aiready/core": "0.21.0"
   },
   "devDependencies": {
     "@types/node": "^24.0.0",
@@ -21,9 +21,9 @@
   },
   "exports": {
     ".": {
+      "types": "./dist/index.d.ts",
       "import": "./dist/index.mjs",
-      "require": "./dist/index.js",
-      "types": "./dist/index.d.ts"
+      "require": "./dist/index.js"
     }
   },
   "scripts": {

package/src/index.ts

@@ -1,2 +1,9 @@
+import { ToolRegistry } from '@aiready/core';
+import { DocDriftProvider } from './provider';
+
+// Register with global registry
+ToolRegistry.register(DocDriftProvider);
+
 export * from './types';
 export * from './analyzer';
+export { DocDriftProvider };

package/src/provider.ts

@@ -0,0 +1,74 @@
+import {
+  ToolProvider,
+  ToolName,
+  SpokeOutput,
+  ScanOptions,
+  ToolScoringOutput,
+  AnalysisResult,
+  SpokeOutputSchema,
+} from '@aiready/core';
+import { analyzeDocDrift } from './analyzer';
+import { DocDriftOptions, DocDriftIssue } from './types';
+
+/**
+ * Documentation Drift Tool Provider
+ */
+export const DocDriftProvider: ToolProvider = {
+  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,
+      },
+    });
+  },
+
+  score(output: SpokeOutput, options: ScanOptions): ToolScoringOutput {
+    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',
+        })
+      ),
+    };
+  },
+
+  defaultWeight: 8,
+};