@aiready/doc-drift 0.13.4 → 0.13.6

package/dist/chunk-CGSYYULO.mjs

@@ -1,145 +0,0 @@
-var __require = /* @__PURE__ */ ((x) => typeof require !== "undefined" ? require : typeof Proxy !== "undefined" ? new Proxy(x, {
-  get: (a, b) => (typeof require !== "undefined" ? require : a)[b]
-}) : x)(function(x) {
-  if (typeof require !== "undefined") return require.apply(this, arguments);
-  throw Error('Dynamic require of "' + x + '" is not supported');
-});
-
-// src/analyzer.ts
-import {
-  scanFiles,
-  calculateDocDrift,
-  getFileCommitTimestamps,
-  getLineRangeLastModifiedCached,
-  Severity,
-  IssueType
-} from "@aiready/core";
-import { readFileSync } from "fs";
-import { parse } from "@typescript-eslint/typescript-estree";
-async function analyzeDocDrift(options) {
-  const files = await scanFiles(options);
-  const issues = [];
-  const staleMonths = options.staleMonths ?? 6;
-  const staleSeconds = staleMonths * 30 * 24 * 60 * 60;
-  let uncommentedExports = 0;
-  let totalExports = 0;
-  let outdatedComments = 0;
-  let undocumentedComplexity = 0;
-  const now = Math.floor(Date.now() / 1e3);
-  let processed = 0;
-  for (const file of files) {
-    processed++;
-    options.onProgress?.(processed, files.length, `doc-drift: analyzing files`);
-    let code;
-    try {
-      code = readFileSync(file, "utf-8");
-    } catch {
-      continue;
-    }
-    let ast;
-    try {
-      ast = parse(code, {
-        jsx: file.endsWith(".tsx") || file.endsWith(".jsx"),
-        loc: true,
-        comment: true
-      });
-    } catch {
-      continue;
-    }
-    const comments = ast.comments || [];
-    let fileLineStamps;
-    for (const node of ast.body) {
-      if (node.type === "ExportNamedDeclaration" || node.type === "ExportDefaultDeclaration") {
-        const decl = node.declaration;
-        if (!decl) continue;
-        if (decl.type === "FunctionDeclaration" || decl.type === "ClassDeclaration" || decl.type === "VariableDeclaration") {
-          totalExports++;
-          const nodeLine = node.loc.start.line;
-          const jsdocs = comments.filter(
-            (c) => c.type === "Block" && c.value.startsWith("*") && c.loc.end.line === nodeLine - 1
-          );
-          if (jsdocs.length === 0) {
-            uncommentedExports++;
-            if (decl.type === "FunctionDeclaration" && decl.body?.loc) {
-              const lines = decl.body.loc.end.line - decl.body.loc.start.line;
-              if (lines > 20) undocumentedComplexity++;
-            }
-          } else {
-            const jsdoc = jsdocs[0];
-            const jsdocText = jsdoc.value;
-            if (decl.type === "FunctionDeclaration") {
-              const params = decl.params.map((p) => p.name || p.left && p.left.name).filter(Boolean);
-              const paramTags = Array.from(
-                jsdocText.matchAll(/@param\s+(?:\{[^}]+\}\s+)?([a-zA-Z0-9_]+)/g)
-              ).map((m) => m[1]);
-              const missingParams = params.filter(
-                (p) => !paramTags.includes(p)
-              );
-              if (missingParams.length > 0) {
-                outdatedComments++;
-                issues.push({
-                  type: IssueType.DocDrift,
-                  severity: Severity.Major,
-                  message: `JSDoc @param mismatch: function has parameters (${missingParams.join(", ")}) not documented in JSDoc.`,
-                  location: { file, line: nodeLine }
-                });
-                continue;
-              }
-            }
-            if (!fileLineStamps) {
-              fileLineStamps = getFileCommitTimestamps(file);
-            }
-            const commentModified = getLineRangeLastModifiedCached(
-              fileLineStamps,
-              jsdoc.loc.start.line,
-              jsdoc.loc.end.line
-            );
-            const bodyModified = getLineRangeLastModifiedCached(
-              fileLineStamps,
-              decl.loc.start.line,
-              decl.loc.end.line
-            );
-            if (commentModified > 0 && bodyModified > 0) {
-              if (now - commentModified > staleSeconds && bodyModified - commentModified > staleSeconds / 2) {
-                outdatedComments++;
-                issues.push({
-                  type: IssueType.DocDrift,
-                  severity: Severity.Minor,
-                  message: `JSDoc is significantly older than the function body implementation. Code may have drifted.`,
-                  location: { file, line: jsdoc.loc.start.line }
-                });
-              }
-            }
-          }
-        }
-      }
-    }
-  }
-  const riskResult = calculateDocDrift({
-    uncommentedExports,
-    totalExports,
-    outdatedComments,
-    undocumentedComplexity
-  });
-  return {
-    summary: {
-      filesAnalyzed: files.length,
-      functionsAnalyzed: totalExports,
-      score: riskResult.score,
-      rating: riskResult.rating
-    },
-    issues,
-    rawData: {
-      uncommentedExports,
-      totalExports,
-      outdatedComments,
-      undocumentedComplexity
-    },
-    recommendations: riskResult.recommendations
-  };
-}
-
-export {
-  __require,
-  analyzeDocDrift
-};

package/dist/chunk-E3YCVHHH.mjs

@@ -1,152 +0,0 @@
-var __require = /* @__PURE__ */ ((x) => typeof require !== "undefined" ? require : typeof Proxy !== "undefined" ? new Proxy(x, {
-  get: (a, b) => (typeof require !== "undefined" ? require : a)[b]
-}) : x)(function(x) {
-  if (typeof require !== "undefined") return require.apply(this, arguments);
-  throw Error('Dynamic require of "' + x + '" is not supported');
-});
-
-// src/analyzer.ts
-import {
-  scanFiles,
-  calculateDocDrift,
-  getFileCommitTimestamps,
-  getLineRangeLastModifiedCached,
-  Severity,
-  IssueType,
-  emitProgress
-} from "@aiready/core";
-import { readFileSync } from "fs";
-import { parse } from "@typescript-eslint/typescript-estree";
-async function analyzeDocDrift(options) {
-  const files = await scanFiles(options);
-  const issues = [];
-  const staleMonths = options.staleMonths ?? 6;
-  const staleSeconds = staleMonths * 30 * 24 * 60 * 60;
-  let uncommentedExports = 0;
-  let totalExports = 0;
-  let outdatedComments = 0;
-  let undocumentedComplexity = 0;
-  const now = Math.floor(Date.now() / 1e3);
-  let processed = 0;
-  for (const file of files) {
-    processed++;
-    emitProgress(
-      processed,
-      files.length,
-      "doc-drift",
-      "analyzing files",
-      options.onProgress
-    );
-    let code;
-    try {
-      code = readFileSync(file, "utf-8");
-    } catch {
-      continue;
-    }
-    let ast;
-    try {
-      ast = parse(code, {
-        jsx: file.endsWith(".tsx") || file.endsWith(".jsx"),
-        loc: true,
-        comment: true
-      });
-    } catch {
-      continue;
-    }
-    const comments = ast.comments || [];
-    let fileLineStamps;
-    for (const node of ast.body) {
-      if (node.type === "ExportNamedDeclaration" || node.type === "ExportDefaultDeclaration") {
-        const decl = node.declaration;
-        if (!decl) continue;
-        if (decl.type === "FunctionDeclaration" || decl.type === "ClassDeclaration" || decl.type === "VariableDeclaration") {
-          totalExports++;
-          const nodeLine = node.loc.start.line;
-          const jsdocs = comments.filter(
-            (c) => c.type === "Block" && c.value.startsWith("*") && c.loc.end.line === nodeLine - 1
-          );
-          if (jsdocs.length === 0) {
-            uncommentedExports++;
-            if (decl.type === "FunctionDeclaration" && decl.body?.loc) {
-              const lines = decl.body.loc.end.line - decl.body.loc.start.line;
-              if (lines > 20) undocumentedComplexity++;
-            }
-          } else {
-            const jsdoc = jsdocs[0];
-            const jsdocText = jsdoc.value;
-            if (decl.type === "FunctionDeclaration") {
-              const params = decl.params.map((p) => p.name || p.left && p.left.name).filter(Boolean);
-              const paramTags = Array.from(
-                jsdocText.matchAll(/@param\s+(?:\{[^}]+\}\s+)?([a-zA-Z0-9_]+)/g)
-              ).map((m) => m[1]);
-              const missingParams = params.filter(
-                (p) => !paramTags.includes(p)
-              );
-              if (missingParams.length > 0) {
-                outdatedComments++;
-                issues.push({
-                  type: IssueType.DocDrift,
-                  severity: Severity.Major,
-                  message: `JSDoc @param mismatch: function has parameters (${missingParams.join(", ")}) not documented in JSDoc.`,
-                  location: { file, line: nodeLine }
-                });
-                continue;
-              }
-            }
-            if (!fileLineStamps) {
-              fileLineStamps = getFileCommitTimestamps(file);
-            }
-            const commentModified = getLineRangeLastModifiedCached(
-              fileLineStamps,
-              jsdoc.loc.start.line,
-              jsdoc.loc.end.line
-            );
-            const bodyModified = getLineRangeLastModifiedCached(
-              fileLineStamps,
-              decl.loc.start.line,
-              decl.loc.end.line
-            );
-            if (commentModified > 0 && bodyModified > 0) {
-              if (now - commentModified > staleSeconds && bodyModified - commentModified > staleSeconds / 2) {
-                outdatedComments++;
-                issues.push({
-                  type: IssueType.DocDrift,
-                  severity: Severity.Minor,
-                  message: `JSDoc is significantly older than the function body implementation. Code may have drifted.`,
-                  location: { file, line: jsdoc.loc.start.line }
-                });
-              }
-            }
-          }
-        }
-      }
-    }
-  }
-  const riskResult = calculateDocDrift({
-    uncommentedExports,
-    totalExports,
-    outdatedComments,
-    undocumentedComplexity
-  });
-  return {
-    summary: {
-      filesAnalyzed: files.length,
-      functionsAnalyzed: totalExports,
-      score: riskResult.score,
-      rating: riskResult.rating
-    },
-    issues,
-    rawData: {
-      uncommentedExports,
-      totalExports,
-      outdatedComments,
-      undocumentedComplexity
-    },
-    recommendations: riskResult.recommendations
-  };
-}
-
-export {
-  __require,
-  analyzeDocDrift
-};

package/dist/chunk-FMK4O4O7.mjs

@@ -1,143 +0,0 @@
-var __require = /* @__PURE__ */ ((x) => typeof require !== "undefined" ? require : typeof Proxy !== "undefined" ? new Proxy(x, {
-  get: (a, b) => (typeof require !== "undefined" ? require : a)[b]
-}) : x)(function(x) {
-  if (typeof require !== "undefined") return require.apply(this, arguments);
-  throw Error('Dynamic require of "' + x + '" is not supported');
-});
-
-// src/analyzer.ts
-import {
-  scanFiles,
-  calculateDocDrift,
-  getFileCommitTimestamps,
-  getLineRangeLastModifiedCached
-} from "@aiready/core";
-import { readFileSync } from "fs";
-import { parse } from "@typescript-eslint/typescript-estree";
-async function analyzeDocDrift(options) {
-  const files = await scanFiles(options);
-  const issues = [];
-  const staleMonths = options.staleMonths ?? 6;
-  const staleSeconds = staleMonths * 30 * 24 * 60 * 60;
-  let uncommentedExports = 0;
-  let totalExports = 0;
-  let outdatedComments = 0;
-  let undocumentedComplexity = 0;
-  const now = Math.floor(Date.now() / 1e3);
-  let processed = 0;
-  for (const file of files) {
-    processed++;
-    options.onProgress?.(processed, files.length, `doc-drift: analyzing files`);
-    let code;
-    try {
-      code = readFileSync(file, "utf-8");
-    } catch {
-      continue;
-    }
-    let ast;
-    try {
-      ast = parse(code, {
-        jsx: file.endsWith(".tsx") || file.endsWith(".jsx"),
-        loc: true,
-        comment: true
-      });
-    } catch {
-      continue;
-    }
-    const comments = ast.comments || [];
-    let fileLineStamps;
-    for (const node of ast.body) {
-      if (node.type === "ExportNamedDeclaration" || node.type === "ExportDefaultDeclaration") {
-        const decl = node.declaration;
-        if (!decl) continue;
-        if (decl.type === "FunctionDeclaration" || decl.type === "ClassDeclaration" || decl.type === "VariableDeclaration") {
-          totalExports++;
-          const nodeLine = node.loc.start.line;
-          const jsdocs = comments.filter(
-            (c) => c.type === "Block" && c.value.startsWith("*") && c.loc.end.line === nodeLine - 1
-          );
-          if (jsdocs.length === 0) {
-            uncommentedExports++;
-            if (decl.type === "FunctionDeclaration" && decl.body?.loc) {
-              const lines = decl.body.loc.end.line - decl.body.loc.start.line;
-              if (lines > 20) undocumentedComplexity++;
-            }
-          } else {
-            const jsdoc = jsdocs[0];
-            const jsdocText = jsdoc.value;
-            if (decl.type === "FunctionDeclaration") {
-              const params = decl.params.map((p) => p.name || p.left && p.left.name).filter(Boolean);
-              const paramTags = Array.from(
-                jsdocText.matchAll(/@param\s+(?:\{[^}]+\}\s+)?([a-zA-Z0-9_]+)/g)
-              ).map((m) => m[1]);
-              const missingParams = params.filter(
-                (p) => !paramTags.includes(p)
-              );
-              if (missingParams.length > 0) {
-                outdatedComments++;
-                issues.push({
-                  type: "doc-drift",
-                  severity: "major",
-                  message: `JSDoc @param mismatch: function has parameters (${missingParams.join(", ")}) not documented in JSDoc.`,
-                  location: { file, line: nodeLine }
-                });
-                continue;
-              }
-            }
-            if (!fileLineStamps) {
-              fileLineStamps = getFileCommitTimestamps(file);
-            }
-            const commentModified = getLineRangeLastModifiedCached(
-              fileLineStamps,
-              jsdoc.loc.start.line,
-              jsdoc.loc.end.line
-            );
-            const bodyModified = getLineRangeLastModifiedCached(
-              fileLineStamps,
-              decl.loc.start.line,
-              decl.loc.end.line
-            );
-            if (commentModified > 0 && bodyModified > 0) {
-              if (now - commentModified > staleSeconds && bodyModified - commentModified > staleSeconds / 2) {
-                outdatedComments++;
-                issues.push({
-                  type: "doc-drift",
-                  severity: "minor",
-                  message: `JSDoc is significantly older than the function body implementation. Code may have drifted.`,
-                  location: { file, line: jsdoc.loc.start.line }
-                });
-              }
-            }
-          }
-        }
-      }
-    }
-  }
-  const riskResult = calculateDocDrift({
-    uncommentedExports,
-    totalExports,
-    outdatedComments,
-    undocumentedComplexity
-  });
-  return {
-    summary: {
-      filesAnalyzed: files.length,
-      functionsAnalyzed: totalExports,
-      score: riskResult.score,
-      rating: riskResult.rating
-    },
-    issues,
-    rawData: {
-      uncommentedExports,
-      totalExports,
-      outdatedComments,
-      undocumentedComplexity
-    },
-    recommendations: riskResult.recommendations
-  };
-}
-
-export {
-  __require,
-  analyzeDocDrift
-};

package/dist/chunk-TSLAGWBV.mjs

@@ -1,165 +0,0 @@
-var __require = /* @__PURE__ */ ((x) => typeof require !== "undefined" ? require : typeof Proxy !== "undefined" ? new Proxy(x, {
-  get: (a, b) => (typeof require !== "undefined" ? require : a)[b]
-}) : x)(function(x) {
-  if (typeof require !== "undefined") return require.apply(this, arguments);
-  throw Error('Dynamic require of "' + x + '" is not supported');
-});
-
-// src/analyzer.ts
-import { calculateDocDrift } from "@aiready/core";
-import { readdirSync, statSync, readFileSync } from "fs";
-import { join, extname } from "path";
-import { parse } from "@typescript-eslint/typescript-estree";
-import { execSync } from "child_process";
-var SRC_EXTENSIONS = /* @__PURE__ */ new Set([".ts", ".tsx", ".js", ".jsx"]);
-var DEFAULT_EXCLUDES = ["node_modules", "dist", ".git", "coverage", ".turbo", "build"];
-function collectFiles(dir, options, depth = 0) {
-  if (depth > 20) return [];
-  const excludes = [...DEFAULT_EXCLUDES, ...options.exclude ?? []];
-  let entries;
-  try {
-    entries = readdirSync(dir);
-  } catch {
-    return [];
-  }
-  const files = [];
-  for (const entry of entries) {
-    if (excludes.some((ex) => entry === ex || entry.includes(ex))) continue;
-    const full = join(dir, entry);
-    let stat;
-    try {
-      stat = statSync(full);
-    } catch {
-      continue;
-    }
-    if (stat.isDirectory()) {
-      files.push(...collectFiles(full, options, depth + 1));
-    } else if (stat.isFile() && SRC_EXTENSIONS.has(extname(full))) {
-      if (!options.include || options.include.some((p) => full.includes(p))) {
-        files.push(full);
-      }
-    }
-  }
-  return files;
-}
-function getLineRangeLastModified(file, startLine, endLine) {
-  try {
-    const output = execSync(`git log -1 --format=%ct -L ${startLine},${endLine}:"${file}"`, {
-      encoding: "utf-8",
-      stdio: ["ignore", "pipe", "ignore"]
-    });
-    const match = output.trim().split("\n")[0];
-    if (match && !isNaN(parseInt(match, 10))) {
-      return parseInt(match, 10);
-    }
-  } catch {
-  }
-  return 0;
-}
-async function analyzeDocDrift(options) {
-  const rootDir = options.rootDir;
-  const files = collectFiles(rootDir, options);
-  const staleMonths = options.staleMonths ?? 6;
-  const staleSeconds = staleMonths * 30 * 24 * 60 * 60;
-  let uncommentedExports = 0;
-  let totalExports = 0;
-  let outdatedComments = 0;
-  let undocumentedComplexity = 0;
-  const issues = [];
-  const now = Math.floor(Date.now() / 1e3);
-  for (const file of files) {
-    let code;
-    try {
-      code = readFileSync(file, "utf-8");
-    } catch {
-      continue;
-    }
-    let ast;
-    try {
-      ast = parse(code, {
-        jsx: file.endsWith(".tsx") || file.endsWith(".jsx"),
-        loc: true,
-        comment: true
-      });
-    } catch {
-      continue;
-    }
-    const comments = ast.comments || [];
-    for (const node of ast.body) {
-      if (node.type === "ExportNamedDeclaration" || node.type === "ExportDefaultDeclaration") {
-        const decl = node.declaration;
-        if (!decl) continue;
-        if (decl.type === "FunctionDeclaration" || decl.type === "ClassDeclaration" || decl.type === "VariableDeclaration") {
-          totalExports++;
-          const nodeLine = node.loc.start.line;
-          const jsdocs = comments.filter((c) => c.type === "Block" && c.value.startsWith("*") && c.loc.end.line === nodeLine - 1);
-          if (jsdocs.length === 0) {
-            uncommentedExports++;
-            if (decl.type === "FunctionDeclaration" && decl.body?.loc) {
-              const lines = decl.body.loc.end.line - decl.body.loc.start.line;
-              if (lines > 20) undocumentedComplexity++;
-            }
-          } else {
-            const jsdoc = jsdocs[0];
-            const jsdocText = jsdoc.value;
-            if (decl.type === "FunctionDeclaration") {
-              const params = decl.params.map((p) => p.name || p.left && p.left.name).filter(Boolean);
-              const paramTags = Array.from(jsdocText.matchAll(/@param\s+(?:\{[^}]+\}\s+)?([a-zA-Z0-9_]+)/g)).map((m) => m[1]);
-              const missingParams = params.filter((p) => !paramTags.includes(p));
-              if (missingParams.length > 0) {
-                outdatedComments++;
-                issues.push({
-                  type: "doc-drift",
-                  severity: "major",
-                  message: `JSDoc @param mismatch: function has parameters (${missingParams.join(", ")}) not documented in JSDoc.`,
-                  location: { file, line: nodeLine }
-                });
-                continue;
-              }
-            }
-            const commentModified = getLineRangeLastModified(file, jsdoc.loc.start.line, jsdoc.loc.end.line);
-            const bodyModified = getLineRangeLastModified(file, decl.loc.start.line, decl.loc.end.line);
-            if (commentModified > 0 && bodyModified > 0) {
-              if (now - commentModified > staleSeconds && bodyModified - commentModified > staleSeconds / 2) {
-                outdatedComments++;
-                issues.push({
-                  type: "doc-drift",
-                  severity: "minor",
-                  message: `JSDoc is significantly older than the function body implementation. Code may have drifted.`,
-                  location: { file, line: jsdoc.loc.start.line }
-                });
-              }
-            }
-          }
-        }
-      }
-    }
-  }
-  const riskResult = calculateDocDrift({
-    uncommentedExports,
-    totalExports,
-    outdatedComments,
-    undocumentedComplexity
-  });
-  return {
-    summary: {
-      filesAnalyzed: files.length,
-      functionsAnalyzed: totalExports,
-      score: riskResult.score,
-      rating: riskResult.rating
-    },
-    issues,
-    rawData: {
-      uncommentedExports,
-      totalExports,
-      outdatedComments,
-      undocumentedComplexity
-    },
-    recommendations: riskResult.recommendations
-  };
-}
-
-export {
-  __require,
-  analyzeDocDrift
-};