@aiready/doc-drift 0.11.18 → 0.11.21

package/coverage/sorter.js

@@ -0,0 +1,210 @@
+/* eslint-disable */
+var addSorting = (function() {
+    'use strict';
+    var cols,
+        currentSort = {
+            index: 0,
+            desc: false
+        };
+
+    // returns the summary table element
+    function getTable() {
+        return document.querySelector('.coverage-summary');
+    }
+    // returns the thead element of the summary table
+    function getTableHeader() {
+        return getTable().querySelector('thead tr');
+    }
+    // returns the tbody element of the summary table
+    function getTableBody() {
+        return getTable().querySelector('tbody');
+    }
+    // returns the th element for nth column
+    function getNthColumn(n) {
+        return getTableHeader().querySelectorAll('th')[n];
+    }
+
+    function onFilterInput() {
+        const searchValue = document.getElementById('fileSearch').value;
+        const rows = document.getElementsByTagName('tbody')[0].children;
+
+        // Try to create a RegExp from the searchValue. If it fails (invalid regex),
+        // it will be treated as a plain text search
+        let searchRegex;
+        try {
+            searchRegex = new RegExp(searchValue, 'i'); // 'i' for case-insensitive
+        } catch (error) {
+            searchRegex = null;
+        }
+
+        for (let i = 0; i < rows.length; i++) {
+            const row = rows[i];
+            let isMatch = false;
+
+            if (searchRegex) {
+                // If a valid regex was created, use it for matching
+                isMatch = searchRegex.test(row.textContent);
+            } else {
+                // Otherwise, fall back to the original plain text search
+                isMatch = row.textContent
+                    .toLowerCase()
+                    .includes(searchValue.toLowerCase());
+            }
+
+            row.style.display = isMatch ? '' : 'none';
+        }
+    }
+
+    // loads the search box
+    function addSearchBox() {
+        var template = document.getElementById('filterTemplate');
+        var templateClone = template.content.cloneNode(true);
+        templateClone.getElementById('fileSearch').oninput = onFilterInput;
+        template.parentElement.appendChild(templateClone);
+    }
+
+    // loads all columns
+    function loadColumns() {
+        var colNodes = getTableHeader().querySelectorAll('th'),
+            colNode,
+            cols = [],
+            col,
+            i;
+
+        for (i = 0; i < colNodes.length; i += 1) {
+            colNode = colNodes[i];
+            col = {
+                key: colNode.getAttribute('data-col'),
+                sortable: !colNode.getAttribute('data-nosort'),
+                type: colNode.getAttribute('data-type') || 'string'
+            };
+            cols.push(col);
+            if (col.sortable) {
+                col.defaultDescSort = col.type === 'number';
+                colNode.innerHTML =
+                    colNode.innerHTML + '<span class="sorter"></span>';
+            }
+        }
+        return cols;
+    }
+    // attaches a data attribute to every tr element with an object
+    // of data values keyed by column name
+    function loadRowData(tableRow) {
+        var tableCols = tableRow.querySelectorAll('td'),
+            colNode,
+            col,
+            data = {},
+            i,
+            val;
+        for (i = 0; i < tableCols.length; i += 1) {
+            colNode = tableCols[i];
+            col = cols[i];
+            val = colNode.getAttribute('data-value');
+            if (col.type === 'number') {
+                val = Number(val);
+            }
+            data[col.key] = val;
+        }
+        return data;
+    }
+    // loads all row data
+    function loadData() {
+        var rows = getTableBody().querySelectorAll('tr'),
+            i;
+
+        for (i = 0; i < rows.length; i += 1) {
+            rows[i].data = loadRowData(rows[i]);
+        }
+    }
+    // sorts the table using the data for the ith column
+    function sortByIndex(index, desc) {
+        var key = cols[index].key,
+            sorter = function(a, b) {
+                a = a.data[key];
+                b = b.data[key];
+                return a < b ? -1 : a > b ? 1 : 0;
+            },
+            finalSorter = sorter,
+            tableBody = document.querySelector('.coverage-summary tbody'),
+            rowNodes = tableBody.querySelectorAll('tr'),
+            rows = [],
+            i;
+
+        if (desc) {
+            finalSorter = function(a, b) {
+                return -1 * sorter(a, b);
+            };
+        }
+
+        for (i = 0; i < rowNodes.length; i += 1) {
+            rows.push(rowNodes[i]);
+            tableBody.removeChild(rowNodes[i]);
+        }
+
+        rows.sort(finalSorter);
+
+        for (i = 0; i < rows.length; i += 1) {
+            tableBody.appendChild(rows[i]);
+        }
+    }
+    // removes sort indicators for current column being sorted
+    function removeSortIndicators() {
+        var col = getNthColumn(currentSort.index),
+            cls = col.className;
+
+        cls = cls.replace(/ sorted$/, '').replace(/ sorted-desc$/, '');
+        col.className = cls;
+    }
+    // adds sort indicators for current column being sorted
+    function addSortIndicators() {
+        getNthColumn(currentSort.index).className += currentSort.desc
+            ? ' sorted-desc'
+            : ' sorted';
+    }
+    // adds event listeners for all sorter widgets
+    function enableUI() {
+        var i,
+            el,
+            ithSorter = function ithSorter(i) {
+                var col = cols[i];
+
+                return function() {
+                    var desc = col.defaultDescSort;
+
+                    if (currentSort.index === i) {
+                        desc = !currentSort.desc;
+                    }
+                    sortByIndex(i, desc);
+                    removeSortIndicators();
+                    currentSort.index = i;
+                    currentSort.desc = desc;
+                    addSortIndicators();
+                };
+            };
+        for (i = 0; i < cols.length; i += 1) {
+            if (cols[i].sortable) {
+                // add the click event handler on the th so users
+                // dont have to click on those tiny arrows
+                el = getNthColumn(i).querySelector('.sorter').parentElement;
+                if (el.addEventListener) {
+                    el.addEventListener('click', ithSorter(i));
+                } else {
+                    el.attachEvent('onclick', ithSorter(i));
+                }
+            }
+        }
+    }
+    // adds sorting functionality to the UI
+    return function() {
+        if (!getTable()) {
+            return;
+        }
+        cols = loadColumns();
+        loadData();
+        addSearchBox();
+        addSortIndicators();
+        enableUI();
+    };
+})();
+
+window.addEventListener('load', addSorting);

package/dist/index.d.mts

@@ -1,4 +1,4 @@
-import { ToolProvider, Issue, IssueType, ScanOptions } from '@aiready/core';
+import { ToolProvider, Issue, IssueType, ScanOptions, ToolScoringOutput } from '@aiready/core';
 
 /**
  * Documentation Drift Tool Provider
@@ -33,4 +33,9 @@ interface DocDriftReport {
 
 declare function analyzeDocDrift(options: DocDriftOptions): Promise<DocDriftReport>;
 
-export { type DocDriftIssue, type DocDriftOptions, DocDriftProvider, type DocDriftReport, analyzeDocDrift };
+/**
+ * Convert doc-drift report into a ToolScoringOutput.
+ */
+declare function calculateDocDriftScore(report: DocDriftReport): ToolScoringOutput;
+
+export { type DocDriftIssue, type DocDriftOptions, DocDriftProvider, type DocDriftReport, analyzeDocDrift, calculateDocDriftScore };

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { ToolProvider, Issue, IssueType, ScanOptions } from '@aiready/core';
+import { ToolProvider, Issue, IssueType, ScanOptions, ToolScoringOutput } from '@aiready/core';
 
 /**
  * Documentation Drift Tool Provider
@@ -33,4 +33,9 @@ interface DocDriftReport {
 
 declare function analyzeDocDrift(options: DocDriftOptions): Promise<DocDriftReport>;
 
-export { type DocDriftIssue, type DocDriftOptions, DocDriftProvider, type DocDriftReport, analyzeDocDrift };
+/**
+ * Convert doc-drift report into a ToolScoringOutput.
+ */
+declare function calculateDocDriftScore(report: DocDriftReport): ToolScoringOutput;
+
+export { type DocDriftIssue, type DocDriftOptions, DocDriftProvider, type DocDriftReport, analyzeDocDrift, calculateDocDriftScore };

package/dist/index.js

@@ -21,10 +21,11 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 var index_exports = {};
 __export(index_exports, {
   DocDriftProvider: () => DocDriftProvider,
-  analyzeDocDrift: () => analyzeDocDrift
+  analyzeDocDrift: () => analyzeDocDrift,
+  calculateDocDriftScore: () => calculateDocDriftScore
 });
 module.exports = __toCommonJS(index_exports);
-var import_core3 = require("@aiready/core");
+var import_core4 = require("@aiready/core");
 
 // src/provider.ts
 var import_core2 = require("@aiready/core");
@@ -192,10 +193,58 @@ var DocDriftProvider = {
   defaultWeight: 8
 };
 
+// src/scoring.ts
+var import_core3 = require("@aiready/core");
+function calculateDocDriftScore(report) {
+  const { rawData, summary } = report;
+  const riskResult = (0, import_core3.calculateDocDrift)({
+    uncommentedExports: rawData.uncommentedExports,
+    totalExports: rawData.totalExports,
+    outdatedComments: rawData.outdatedComments,
+    undocumentedComplexity: rawData.undocumentedComplexity
+  });
+  const factors = [
+    {
+      name: "Uncommented Exports",
+      impact: -Math.min(
+        20,
+        rawData.uncommentedExports / Math.max(1, rawData.totalExports) * 100 * 0.2
+      ),
+      description: `${rawData.uncommentedExports} uncommented exports`
+    },
+    {
+      name: "Outdated Comments",
+      impact: -Math.min(60, rawData.outdatedComments * 15 * 0.6),
+      description: `${rawData.outdatedComments} outdated comments`
+    },
+    {
+      name: "Undocumented Complexity",
+      impact: -Math.min(20, rawData.undocumentedComplexity * 10 * 0.2),
+      description: `${rawData.undocumentedComplexity} complex functions lack docs`
+    }
+  ];
+  const recommendations = riskResult.recommendations.map((rec) => ({
+    action: rec,
+    estimatedImpact: 8,
+    priority: summary.score < 50 ? "high" : "medium"
+  }));
+  return {
+    toolName: import_core3.ToolName.DocDrift,
+    score: summary.score,
+    rawMetrics: {
+      ...rawData,
+      rating: summary.rating
+    },
+    factors,
+    recommendations
+  };
+}
+
 // src/index.ts
-import_core3.ToolRegistry.register(DocDriftProvider);
+import_core4.ToolRegistry.register(DocDriftProvider);
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   DocDriftProvider,
-  analyzeDocDrift
+  analyzeDocDrift,
+  calculateDocDriftScore
 });

package/dist/index.mjs

@@ -62,9 +62,57 @@ var DocDriftProvider = {
   defaultWeight: 8
 };
 
+// src/scoring.ts
+import { calculateDocDrift, ToolName as ToolName2 } from "@aiready/core";
+function calculateDocDriftScore(report) {
+  const { rawData, summary } = report;
+  const riskResult = calculateDocDrift({
+    uncommentedExports: rawData.uncommentedExports,
+    totalExports: rawData.totalExports,
+    outdatedComments: rawData.outdatedComments,
+    undocumentedComplexity: rawData.undocumentedComplexity
+  });
+  const factors = [
+    {
+      name: "Uncommented Exports",
+      impact: -Math.min(
+        20,
+        rawData.uncommentedExports / Math.max(1, rawData.totalExports) * 100 * 0.2
+      ),
+      description: `${rawData.uncommentedExports} uncommented exports`
+    },
+    {
+      name: "Outdated Comments",
+      impact: -Math.min(60, rawData.outdatedComments * 15 * 0.6),
+      description: `${rawData.outdatedComments} outdated comments`
+    },
+    {
+      name: "Undocumented Complexity",
+      impact: -Math.min(20, rawData.undocumentedComplexity * 10 * 0.2),
+      description: `${rawData.undocumentedComplexity} complex functions lack docs`
+    }
+  ];
+  const recommendations = riskResult.recommendations.map((rec) => ({
+    action: rec,
+    estimatedImpact: 8,
+    priority: summary.score < 50 ? "high" : "medium"
+  }));
+  return {
+    toolName: ToolName2.DocDrift,
+    score: summary.score,
+    rawMetrics: {
+      ...rawData,
+      rating: summary.rating
+    },
+    factors,
+    recommendations
+  };
+}
+
 // src/index.ts
 ToolRegistry.register(DocDriftProvider);
 export {
   DocDriftProvider,
-  analyzeDocDrift
+  analyzeDocDrift,
+  calculateDocDriftScore
 };

package/package.json

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

package/src/__tests__/provider.test.ts

@@ -0,0 +1,45 @@
+import { describe, it, expect, vi } from 'vitest';
+import { DocDriftProvider } from '../provider';
+import * as analyzer from '../analyzer';
+
+vi.mock('../analyzer', () => ({
+  analyzeDocDrift: vi.fn(),
+}));
+
+describe('Doc Drift Provider', () => {
+  it('should analyze and return SpokeOutput', async () => {
+    vi.mocked(analyzer.analyzeDocDrift).mockResolvedValue({
+      summary: {
+        filesAnalyzed: 1,
+        functionsAnalyzed: 5,
+        score: 90,
+        rating: 'minimal',
+      },
+      issues: [],
+      rawData: {
+        uncommentedExports: 0,
+        totalExports: 5,
+        outdatedComments: 0,
+        undocumentedComplexity: 0,
+      },
+      recommendations: [],
+    });
+
+    const output = await DocDriftProvider.analyze({ rootDir: '.' });
+
+    expect(output.summary.filesAnalyzed).toBe(1);
+    expect(output.metadata.toolName).toBe('doc-drift');
+  });
+
+  it('should score an output', () => {
+    const mockOutput = {
+      summary: { score: 80, recommendations: ['Fix it'] } as any,
+      metadata: { rawData: {} },
+      results: [],
+    };
+
+    const scoring = DocDriftProvider.score(mockOutput as any, { rootDir: '.' });
+    expect(scoring.score).toBe(80);
+    expect(scoring.recommendations[0].action).toBe('Fix it');
+  });
+});

package/src/__tests__/scoring.test.ts

@@ -0,0 +1,51 @@
+import { describe, it, expect } from 'vitest';
+import { calculateDocDriftScore } from '../scoring';
+import { DocDriftReport } from '../types';
+import { ToolName } from '@aiready/core';
+
+describe('Doc Drift Scoring', () => {
+  const mockReport: DocDriftReport = {
+    summary: {
+      filesAnalyzed: 10,
+      functionsAnalyzed: 50,
+      score: 70,
+      rating: 'good',
+    },
+    issues: [],
+    rawData: {
+      uncommentedExports: 20,
+      totalExports: 50,
+      outdatedComments: 2,
+      undocumentedComplexity: 1,
+    },
+    recommendations: [
+      'Update or remove 2 outdated comments that contradict the code.',
+      'Add JSDoc to 20 uncommented exports.',
+      'Explain the business logic for 1 highly complex functions.',
+    ],
+  };
+
+  it('should map report to ToolScoringOutput correctly', () => {
+    const scoring = calculateDocDriftScore(mockReport);
+
+    expect(scoring.toolName).toBe(ToolName.DocDrift);
+    expect(scoring.score).toBe(70);
+    expect(scoring.factors.length).toBeGreaterThan(0);
+    expect(scoring.recommendations[0].action).toBe(
+      'Update or remove 2 outdated comments that contradict the code.'
+    );
+  });
+
+  it('should set high priority for low scores', () => {
+    const lowScoreReport: DocDriftReport = {
+      ...mockReport,
+      summary: {
+        ...mockReport.summary,
+        score: 40,
+      },
+    };
+
+    const scoring = calculateDocDriftScore(lowScoreReport);
+    expect(scoring.recommendations[0].priority).toBe('high');
+  });
+});

package/src/index.ts

@@ -6,4 +6,5 @@ ToolRegistry.register(DocDriftProvider);
 
 export * from './types';
 export * from './analyzer';
+export * from './scoring';
 export { DocDriftProvider };

package/src/scoring.ts

@@ -0,0 +1,61 @@
+import { calculateDocDrift, ToolName } from '@aiready/core';
+import type { ToolScoringOutput } from '@aiready/core';
+import type { DocDriftReport } from './types';
+
+/**
+ * Convert doc-drift report into a ToolScoringOutput.
+ */
+export function calculateDocDriftScore(
+  report: DocDriftReport
+): ToolScoringOutput {
+  const { rawData, summary } = report;
+
+  // Recalculate using core math to get risk contribution breakdown
+  const riskResult = calculateDocDrift({
+    uncommentedExports: rawData.uncommentedExports,
+    totalExports: rawData.totalExports,
+    outdatedComments: rawData.outdatedComments,
+    undocumentedComplexity: rawData.undocumentedComplexity,
+  });
+
+  const factors: ToolScoringOutput['factors'] = [
+    {
+      name: 'Uncommented Exports',
+      impact: -Math.min(
+        20,
+        (rawData.uncommentedExports / Math.max(1, rawData.totalExports)) *
+          100 *
+          0.2
+      ),
+      description: `${rawData.uncommentedExports} uncommented exports`,
+    },
+    {
+      name: 'Outdated Comments',
+      impact: -Math.min(60, rawData.outdatedComments * 15 * 0.6),
+      description: `${rawData.outdatedComments} outdated comments`,
+    },
+    {
+      name: 'Undocumented Complexity',
+      impact: -Math.min(20, rawData.undocumentedComplexity * 10 * 0.2),
+      description: `${rawData.undocumentedComplexity} complex functions lack docs`,
+    },
+  ];
+
+  const recommendations: ToolScoringOutput['recommendations'] =
+    riskResult.recommendations.map((rec) => ({
+      action: rec,
+      estimatedImpact: 8,
+      priority: summary.score < 50 ? 'high' : 'medium',
+    }));
+
+  return {
+    toolName: ToolName.DocDrift,
+    score: summary.score,
+    rawMetrics: {
+      ...rawData,
+      rating: summary.rating,
+    },
+    factors,
+    recommendations,
+  };
+}