@aiready/agent-grounding 0.1.6 → 0.1.8

package/.turbo/turbo-build.log

@@ -1,6 +1,6 @@
 
 
-> @aiready/agent-grounding@0.1.6 build /Users/pengcao/projects/aiready/packages/agent-grounding
+> @aiready/agent-grounding@0.1.8 build /Users/pengcao/projects/aiready/packages/agent-grounding
 > tsup src/index.ts src/cli.ts --format cjs,esm --dts
 
 CLI Building entry: src/cli.ts, src/index.ts
@@ -9,15 +9,15 @@
 CLI Target: es2020
 CJS Build start
 ESM Build start
-ESM dist/chunk-NHDH733I.mjs 10.51 KB
+CJS dist/cli.js   16.22 KB
+CJS dist/index.js 10.75 KB
+CJS ⚡️ Build success in 267ms
 ESM dist/index.mjs          154.00 B
 ESM dist/cli.mjs            5.16 KB
-ESM ⚡️ Build success in 39ms
-CJS dist/index.js 11.76 KB
-CJS dist/cli.js   17.24 KB
-CJS ⚡️ Build success in 39ms
+ESM dist/chunk-NXIMJNCK.mjs 9.55 KB
+ESM ⚡️ Build success in 266ms
 DTS Build start
-DTS ⚡️ Build success in 4273ms
+DTS ⚡️ Build success in 10475ms
 DTS dist/cli.d.ts    20.00 B
 DTS dist/index.d.ts  2.34 KB
 DTS dist/cli.d.mts   20.00 B

package/.turbo/turbo-lint.log

@@ -0,0 +1,5 @@
+
+
+> @aiready/agent-grounding@0.1.6 lint /Users/pengcao/projects/aiready/packages/agent-grounding
+> eslint src
+

package/.turbo/turbo-test.log

@@ -1,16 +1,17 @@
 
 
-> @aiready/agent-grounding@0.1.6 test /Users/pengcao/projects/aiready/packages/agent-grounding
+> @aiready/agent-grounding@0.1.8 test /Users/pengcao/projects/aiready/packages/agent-grounding
 > vitest run
 
 [?25l
  RUN  v4.0.18 /Users/pengcao/projects/aiready/packages/agent-grounding
 
- ✓ src/__tests__/analyzer.test.ts (3 tests) 16ms
+ ✓ src/__tests__/analyzer.test.ts (3 tests) 719ms
+       ✓ should detect deep directories and vague file names  336ms
 
  Test Files  1 passed (1)
       Tests  3 passed (3)
-   Start at  22:19:17
-   Duration  829ms (transform 144ms, setup 0ms, import 656ms, tests 16ms, environment 0ms)
+   Start at  00:56:24
+   Duration  5.49s (transform 1.39s, setup 0ms, import 3.93s, tests 719ms, environment 0ms)
 
 [?25h

package/dist/chunk-NXIMJNCK.mjs

@@ -0,0 +1,294 @@
+// src/analyzer.ts
+import {
+  scanEntries,
+  calculateAgentGrounding,
+  VAGUE_FILE_NAMES
+} from "@aiready/core";
+import { readFileSync, existsSync, statSync } from "fs";
+import { join, extname, basename, relative } from "path";
+import { parse } from "@typescript-eslint/typescript-estree";
+function analyzeFile(filePath) {
+  let code;
+  try {
+    code = readFileSync(filePath, "utf-8");
+  } catch {
+    return {
+      isBarrel: false,
+      exportedNames: [],
+      untypedExports: 0,
+      totalExports: 0,
+      domainTerms: []
+    };
+  }
+  let ast;
+  try {
+    ast = parse(code, {
+      jsx: filePath.endsWith(".tsx") || filePath.endsWith(".jsx"),
+      range: false,
+      loc: false
+    });
+  } catch {
+    return {
+      isBarrel: false,
+      exportedNames: [],
+      untypedExports: 0,
+      totalExports: 0,
+      domainTerms: []
+    };
+  }
+  let isBarrel = false;
+  const exportedNames = [];
+  let untypedExports = 0;
+  let totalExports = 0;
+  const domainTerms = [];
+  for (const node of ast.body) {
+    if (node.type === "ExportAllDeclaration") {
+      isBarrel = true;
+      continue;
+    }
+    if (node.type === "ExportNamedDeclaration") {
+      totalExports++;
+      const decl = node.declaration;
+      if (decl) {
+        const name = decl.id?.name ?? decl.declarations?.[0]?.id?.name;
+        if (name) {
+          exportedNames.push(name);
+          domainTerms.push(
+            ...name.replace(/([A-Z])/g, " $1").toLowerCase().split(/\s+/).filter(Boolean)
+          );
+          const hasType = decl.returnType != null || decl.declarations?.[0]?.id?.typeAnnotation != null || decl.typeParameters != null;
+          if (!hasType) untypedExports++;
+        }
+      } else if (node.specifiers && node.specifiers.length > 0) {
+        isBarrel = true;
+      }
+    }
+    if (node.type === "ExportDefaultDeclaration") {
+      totalExports++;
+    }
+  }
+  return { isBarrel, exportedNames, untypedExports, totalExports, domainTerms };
+}
+function detectInconsistentTerms(allTerms) {
+  const termFreq = /* @__PURE__ */ new Map();
+  for (const term of allTerms) {
+    if (term.length >= 3) {
+      termFreq.set(term, (termFreq.get(term) ?? 0) + 1);
+    }
+  }
+  const orphans = [...termFreq.values()].filter((count) => count === 1).length;
+  const common = [...termFreq.values()].filter((count) => count >= 3).length;
+  const vocabularySize = termFreq.size;
+  const inconsistent = Math.max(0, orphans - common * 2);
+  return { inconsistent, vocabularySize };
+}
+async function analyzeAgentGrounding(options) {
+  const rootDir = options.rootDir;
+  const maxRecommendedDepth = options.maxRecommendedDepth ?? 4;
+  const readmeStaleDays = options.readmeStaleDays ?? 90;
+  const { files, dirs: rawDirs } = await scanEntries({
+    ...options,
+    include: options.include || ["**/*.{ts,tsx,js,jsx}"]
+  });
+  const dirs = rawDirs.map((d) => ({
+    path: d,
+    depth: relative(rootDir, d).split(/[/\\]/).filter(Boolean).length
+  }));
+  const deepDirectories = dirs.filter(
+    (d) => d.depth > maxRecommendedDepth
+  ).length;
+  const additionalVague = new Set(
+    (options.additionalVagueNames ?? []).map((n) => n.toLowerCase())
+  );
+  let vagueFileNames = 0;
+  for (const f of files) {
+    const base = basename(f, extname(f)).toLowerCase();
+    if (VAGUE_FILE_NAMES.has(base) || additionalVague.has(base)) {
+      vagueFileNames++;
+    }
+  }
+  const readmePath = join(rootDir, "README.md");
+  const hasRootReadme = existsSync(readmePath);
+  let readmeIsFresh = false;
+  if (hasRootReadme) {
+    try {
+      const stat = statSync(readmePath);
+      const ageDays = (Date.now() - stat.mtimeMs) / (1e3 * 60 * 60 * 24);
+      readmeIsFresh = ageDays < readmeStaleDays;
+    } catch {
+    }
+  }
+  const allDomainTerms = [];
+  let barrelExports = 0;
+  let untypedExports = 0;
+  let totalExports = 0;
+  let processed = 0;
+  for (const f of files) {
+    processed++;
+    options.onProgress?.(
+      processed,
+      files.length,
+      `agent-grounding: analyzing files`
+    );
+    const analysis = analyzeFile(f);
+    if (analysis.isBarrel) barrelExports++;
+    untypedExports += analysis.untypedExports;
+    totalExports += analysis.totalExports;
+    allDomainTerms.push(...analysis.domainTerms);
+  }
+  const {
+    inconsistent: inconsistentDomainTerms,
+    vocabularySize: domainVocabularySize
+  } = detectInconsistentTerms(allDomainTerms);
+  const groundingResult = calculateAgentGrounding({
+    deepDirectories,
+    totalDirectories: dirs.length,
+    vagueFileNames,
+    totalFiles: files.length,
+    hasRootReadme,
+    readmeIsFresh,
+    barrelExports,
+    untypedExports,
+    totalExports: Math.max(1, totalExports),
+    inconsistentDomainTerms,
+    domainVocabularySize: Math.max(1, domainVocabularySize)
+  });
+  const issues = [];
+  if (groundingResult.dimensions.structureClarityScore < 70) {
+    issues.push({
+      type: "agent-navigation-failure",
+      dimension: "structure-clarity",
+      severity: "major",
+      message: `${deepDirectories} directories exceed recommended depth of ${maxRecommendedDepth} \u2014 agents struggle to navigate deep trees.`,
+      location: { file: rootDir, line: 0 },
+      suggestion: `Flatten nested directories to ${maxRecommendedDepth} levels or fewer.`
+    });
+  }
+  if (groundingResult.dimensions.selfDocumentationScore < 70) {
+    issues.push({
+      type: "agent-navigation-failure",
+      dimension: "self-documentation",
+      severity: "major",
+      message: `${vagueFileNames} files use vague names (utils, helpers, misc) \u2014 an agent cannot determine their purpose from the name alone.`,
+      location: { file: rootDir, line: 0 },
+      suggestion: "Rename to domain-specific names: e.g., userAuthUtils \u2192 tokenValidator."
+    });
+  }
+  if (!hasRootReadme) {
+    issues.push({
+      type: "agent-navigation-failure",
+      dimension: "entry-point",
+      severity: "critical",
+      message: "No root README.md found \u2014 agents have no orientation document to start from.",
+      location: { file: join(rootDir, "README.md"), line: 0 },
+      suggestion: "Add a README.md explaining the project structure, entry points, and key conventions."
+    });
+  } else if (!readmeIsFresh) {
+    issues.push({
+      type: "agent-navigation-failure",
+      dimension: "entry-point",
+      severity: "minor",
+      message: `README.md is stale (>${readmeStaleDays} days without updates) \u2014 agents may be misled by outdated context.`,
+      location: { file: readmePath, line: 0 },
+      suggestion: "Update README.md to reflect the current codebase structure."
+    });
+  }
+  if (groundingResult.dimensions.apiClarityScore < 70) {
+    issues.push({
+      type: "agent-navigation-failure",
+      dimension: "api-clarity",
+      severity: "major",
+      message: `${untypedExports} of ${totalExports} public exports lack TypeScript type annotations \u2014 agents cannot infer the API contract.`,
+      location: { file: rootDir, line: 0 },
+      suggestion: "Add explicit return type and parameter annotations to all exported functions."
+    });
+  }
+  if (groundingResult.dimensions.domainConsistencyScore < 70) {
+    issues.push({
+      type: "agent-navigation-failure",
+      dimension: "domain-consistency",
+      severity: "major",
+      message: `${inconsistentDomainTerms} domain terms appear to be used inconsistently \u2014 agents get confused when one concept has multiple names.`,
+      location: { file: rootDir, line: 0 },
+      suggestion: "Establish a domain glossary and enforce one term per concept across the codebase."
+    });
+  }
+  return {
+    summary: {
+      filesAnalyzed: files.length,
+      directoriesAnalyzed: dirs.length,
+      score: groundingResult.score,
+      rating: groundingResult.rating,
+      dimensions: groundingResult.dimensions
+    },
+    issues,
+    rawData: {
+      deepDirectories,
+      totalDirectories: dirs.length,
+      vagueFileNames,
+      totalFiles: files.length,
+      hasRootReadme,
+      readmeIsFresh,
+      barrelExports,
+      untypedExports,
+      totalExports,
+      inconsistentDomainTerms,
+      domainVocabularySize
+    },
+    recommendations: groundingResult.recommendations
+  };
+}
+
+// src/scoring.ts
+function calculateGroundingScore(report) {
+  const { summary, rawData, recommendations } = report;
+  const factors = [
+    {
+      name: "Structure Clarity",
+      impact: Math.round(summary.dimensions.structureClarityScore - 50),
+      description: `${rawData.deepDirectories} of ${rawData.totalDirectories} dirs exceed recommended depth`
+    },
+    {
+      name: "Self-Documentation",
+      impact: Math.round(summary.dimensions.selfDocumentationScore - 50),
+      description: `${rawData.vagueFileNames} of ${rawData.totalFiles} files have vague names`
+    },
+    {
+      name: "Entry Points",
+      impact: Math.round(summary.dimensions.entryPointScore - 50),
+      description: rawData.hasRootReadme ? rawData.readmeIsFresh ? "README present and fresh" : "README present but stale" : "No root README"
+    },
+    {
+      name: "API Clarity",
+      impact: Math.round(summary.dimensions.apiClarityScore - 50),
+      description: `${rawData.untypedExports} of ${rawData.totalExports} exports lack type annotations`
+    },
+    {
+      name: "Domain Consistency",
+      impact: Math.round(summary.dimensions.domainConsistencyScore - 50),
+      description: `${rawData.inconsistentDomainTerms} inconsistent domain terms detected`
+    }
+  ];
+  const recs = recommendations.map(
+    (action) => ({
+      action,
+      estimatedImpact: 6,
+      priority: summary.score < 50 ? "high" : "medium"
+    })
+  );
+  return {
+    toolName: "agent-grounding",
+    score: summary.score,
+    rawMetrics: {
+      ...rawData,
+      rating: summary.rating
+    },
+    factors,
+    recommendations: recs
+  };
+}
+
+export {
+  analyzeAgentGrounding,
+  calculateGroundingScore
+};

package/dist/chunk-ZOE5BFWE.mjs

@@ -0,0 +1,339 @@
+// src/analyzer.ts
+import { readdirSync, statSync, existsSync, readFileSync } from "fs";
+import { join, extname, basename } from "path";
+import { parse } from "@typescript-eslint/typescript-estree";
+import { calculateAgentGrounding } from "@aiready/core";
+var VAGUE_FILE_NAMES = /* @__PURE__ */ new Set([
+  "utils",
+  "helpers",
+  "helper",
+  "misc",
+  "common",
+  "shared",
+  "tools",
+  "util",
+  "lib",
+  "libs",
+  "stuff",
+  "functions",
+  "methods",
+  "handlers",
+  "data",
+  "temp",
+  "tmp",
+  "test-utils",
+  "test-helpers",
+  "mocks"
+]);
+var SUPPORTED_EXTENSIONS = /* @__PURE__ */ new Set([".ts", ".tsx", ".js", ".jsx"]);
+var DEFAULT_EXCLUDES = [
+  "node_modules",
+  "dist",
+  ".git",
+  "coverage",
+  ".turbo",
+  "build"
+];
+function collectEntries(dir, options, depth = 0, dirs = [], files = []) {
+  if (depth > (options.maxDepth ?? 20)) return { dirs, files };
+  const excludes = [...DEFAULT_EXCLUDES, ...options.exclude ?? []];
+  let entries;
+  try {
+    entries = readdirSync(dir);
+  } catch {
+    return { dirs, 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()) {
+      dirs.push({ path: full, depth });
+      collectEntries(full, options, depth + 1, dirs, files);
+    } else if (stat.isFile() && SUPPORTED_EXTENSIONS.has(extname(full))) {
+      if (!options.include || options.include.some((p) => full.includes(p))) {
+        files.push(full);
+      }
+    }
+  }
+  return { dirs, files };
+}
+function analyzeFile(filePath) {
+  let code;
+  try {
+    code = readFileSync(filePath, "utf-8");
+  } catch {
+    return {
+      isBarrel: false,
+      exportedNames: [],
+      untypedExports: 0,
+      totalExports: 0,
+      domainTerms: []
+    };
+  }
+  let ast;
+  try {
+    ast = parse(code, {
+      jsx: filePath.endsWith(".tsx") || filePath.endsWith(".jsx"),
+      range: false,
+      loc: false
+    });
+  } catch {
+    return {
+      isBarrel: false,
+      exportedNames: [],
+      untypedExports: 0,
+      totalExports: 0,
+      domainTerms: []
+    };
+  }
+  let isBarrel = false;
+  const exportedNames = [];
+  let untypedExports = 0;
+  let totalExports = 0;
+  const domainTerms = [];
+  for (const node of ast.body) {
+    if (node.type === "ExportAllDeclaration") {
+      isBarrel = true;
+      continue;
+    }
+    if (node.type === "ExportNamedDeclaration") {
+      totalExports++;
+      const decl = node.declaration;
+      if (decl) {
+        const name = decl.id?.name ?? decl.declarations?.[0]?.id?.name;
+        if (name) {
+          exportedNames.push(name);
+          domainTerms.push(
+            ...name.replace(/([A-Z])/g, " $1").toLowerCase().split(/\s+/).filter(Boolean)
+          );
+          const hasType = decl.returnType != null || decl.declarations?.[0]?.id?.typeAnnotation != null || decl.typeParameters != null;
+          if (!hasType) untypedExports++;
+        }
+      } else if (node.specifiers && node.specifiers.length > 0) {
+        isBarrel = true;
+      }
+    }
+    if (node.type === "ExportDefaultDeclaration") {
+      totalExports++;
+    }
+  }
+  return { isBarrel, exportedNames, untypedExports, totalExports, domainTerms };
+}
+function detectInconsistentTerms(allTerms) {
+  const termFreq = /* @__PURE__ */ new Map();
+  for (const term of allTerms) {
+    if (term.length >= 3) {
+      termFreq.set(term, (termFreq.get(term) ?? 0) + 1);
+    }
+  }
+  const orphans = [...termFreq.values()].filter((count) => count === 1).length;
+  const common = [...termFreq.values()].filter((count) => count >= 3).length;
+  const vocabularySize = termFreq.size;
+  const inconsistent = Math.max(0, orphans - common * 2);
+  return { inconsistent, vocabularySize };
+}
+async function analyzeAgentGrounding(options) {
+  const rootDir = options.rootDir;
+  const maxRecommendedDepth = options.maxRecommendedDepth ?? 4;
+  const readmeStaleDays = options.readmeStaleDays ?? 90;
+  const { dirs, files } = collectEntries(rootDir, options);
+  const deepDirectories = dirs.filter(
+    (d) => d.depth > maxRecommendedDepth
+  ).length;
+  const additionalVague = new Set(
+    (options.additionalVagueNames ?? []).map((n) => n.toLowerCase())
+  );
+  let vagueFileNames = 0;
+  for (const f of files) {
+    const base = basename(f, extname(f)).toLowerCase();
+    if (VAGUE_FILE_NAMES.has(base) || additionalVague.has(base)) {
+      vagueFileNames++;
+    }
+  }
+  const readmePath = join(rootDir, "README.md");
+  const hasRootReadme = existsSync(readmePath);
+  let readmeIsFresh = false;
+  if (hasRootReadme) {
+    try {
+      const stat = statSync(readmePath);
+      const ageDays = (Date.now() - stat.mtimeMs) / (1e3 * 60 * 60 * 24);
+      readmeIsFresh = ageDays < readmeStaleDays;
+    } catch {
+    }
+  }
+  const allDomainTerms = [];
+  let barrelExports = 0;
+  let untypedExports = 0;
+  let totalExports = 0;
+  let processed = 0;
+  for (const f of files) {
+    processed++;
+    options.onProgress?.(processed, files.length, `agent-grounding: analyzing ${f.substring(rootDir.length + 1)}`);
+    const analysis = analyzeFile(f);
+    if (analysis.isBarrel) barrelExports++;
+    untypedExports += analysis.untypedExports;
+    totalExports += analysis.totalExports;
+    allDomainTerms.push(...analysis.domainTerms);
+  }
+  const {
+    inconsistent: inconsistentDomainTerms,
+    vocabularySize: domainVocabularySize
+  } = detectInconsistentTerms(allDomainTerms);
+  const groundingResult = calculateAgentGrounding({
+    deepDirectories,
+    totalDirectories: dirs.length,
+    vagueFileNames,
+    totalFiles: files.length,
+    hasRootReadme,
+    readmeIsFresh,
+    barrelExports,
+    untypedExports,
+    totalExports: Math.max(1, totalExports),
+    inconsistentDomainTerms,
+    domainVocabularySize: Math.max(1, domainVocabularySize)
+  });
+  const issues = [];
+  if (groundingResult.dimensions.structureClarityScore < 70) {
+    issues.push({
+      type: "agent-navigation-failure",
+      dimension: "structure-clarity",
+      severity: "major",
+      message: `${deepDirectories} directories exceed recommended depth of ${maxRecommendedDepth} \u2014 agents struggle to navigate deep trees.`,
+      location: { file: rootDir, line: 0 },
+      suggestion: `Flatten nested directories to ${maxRecommendedDepth} levels or fewer.`
+    });
+  }
+  if (groundingResult.dimensions.selfDocumentationScore < 70) {
+    issues.push({
+      type: "agent-navigation-failure",
+      dimension: "self-documentation",
+      severity: "major",
+      message: `${vagueFileNames} files use vague names (utils, helpers, misc) \u2014 an agent cannot determine their purpose from the name alone.`,
+      location: { file: rootDir, line: 0 },
+      suggestion: "Rename to domain-specific names: e.g., userAuthUtils \u2192 tokenValidator."
+    });
+  }
+  if (!hasRootReadme) {
+    issues.push({
+      type: "agent-navigation-failure",
+      dimension: "entry-point",
+      severity: "critical",
+      message: "No root README.md found \u2014 agents have no orientation document to start from.",
+      location: { file: join(rootDir, "README.md"), line: 0 },
+      suggestion: "Add a README.md explaining the project structure, entry points, and key conventions."
+    });
+  } else if (!readmeIsFresh) {
+    issues.push({
+      type: "agent-navigation-failure",
+      dimension: "entry-point",
+      severity: "minor",
+      message: `README.md is stale (>${readmeStaleDays} days without updates) \u2014 agents may be misled by outdated context.`,
+      location: { file: readmePath, line: 0 },
+      suggestion: "Update README.md to reflect the current codebase structure."
+    });
+  }
+  if (groundingResult.dimensions.apiClarityScore < 70) {
+    issues.push({
+      type: "agent-navigation-failure",
+      dimension: "api-clarity",
+      severity: "major",
+      message: `${untypedExports} of ${totalExports} public exports lack TypeScript type annotations \u2014 agents cannot infer the API contract.`,
+      location: { file: rootDir, line: 0 },
+      suggestion: "Add explicit return type and parameter annotations to all exported functions."
+    });
+  }
+  if (groundingResult.dimensions.domainConsistencyScore < 70) {
+    issues.push({
+      type: "agent-navigation-failure",
+      dimension: "domain-consistency",
+      severity: "major",
+      message: `${inconsistentDomainTerms} domain terms appear to be used inconsistently \u2014 agents get confused when one concept has multiple names.`,
+      location: { file: rootDir, line: 0 },
+      suggestion: "Establish a domain glossary and enforce one term per concept across the codebase."
+    });
+  }
+  return {
+    summary: {
+      filesAnalyzed: files.length,
+      directoriesAnalyzed: dirs.length,
+      score: groundingResult.score,
+      rating: groundingResult.rating,
+      dimensions: groundingResult.dimensions
+    },
+    issues,
+    rawData: {
+      deepDirectories,
+      totalDirectories: dirs.length,
+      vagueFileNames,
+      totalFiles: files.length,
+      hasRootReadme,
+      readmeIsFresh,
+      barrelExports,
+      untypedExports,
+      totalExports,
+      inconsistentDomainTerms,
+      domainVocabularySize
+    },
+    recommendations: groundingResult.recommendations
+  };
+}
+
+// src/scoring.ts
+function calculateGroundingScore(report) {
+  const { summary, rawData, recommendations } = report;
+  const factors = [
+    {
+      name: "Structure Clarity",
+      impact: Math.round(summary.dimensions.structureClarityScore - 50),
+      description: `${rawData.deepDirectories} of ${rawData.totalDirectories} dirs exceed recommended depth`
+    },
+    {
+      name: "Self-Documentation",
+      impact: Math.round(summary.dimensions.selfDocumentationScore - 50),
+      description: `${rawData.vagueFileNames} of ${rawData.totalFiles} files have vague names`
+    },
+    {
+      name: "Entry Points",
+      impact: Math.round(summary.dimensions.entryPointScore - 50),
+      description: rawData.hasRootReadme ? rawData.readmeIsFresh ? "README present and fresh" : "README present but stale" : "No root README"
+    },
+    {
+      name: "API Clarity",
+      impact: Math.round(summary.dimensions.apiClarityScore - 50),
+      description: `${rawData.untypedExports} of ${rawData.totalExports} exports lack type annotations`
+    },
+    {
+      name: "Domain Consistency",
+      impact: Math.round(summary.dimensions.domainConsistencyScore - 50),
+      description: `${rawData.inconsistentDomainTerms} inconsistent domain terms detected`
+    }
+  ];
+  const recs = recommendations.map(
+    (action) => ({
+      action,
+      estimatedImpact: 6,
+      priority: summary.score < 50 ? "high" : "medium"
+    })
+  );
+  return {
+    toolName: "agent-grounding",
+    score: summary.score,
+    rawMetrics: {
+      ...rawData,
+      rating: summary.rating
+    },
+    factors,
+    recommendations: recs
+  };
+}
+
+export {
+  analyzeAgentGrounding,
+  calculateGroundingScore
+};

package/dist/cli.js

@@ -27,70 +27,10 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
 var import_commander = require("commander");
 
 // src/analyzer.ts
+var import_core = require("@aiready/core");
 var import_fs = require("fs");
 var import_path = require("path");
 var import_typescript_estree = require("@typescript-eslint/typescript-estree");
-var import_core = require("@aiready/core");
-var VAGUE_FILE_NAMES = /* @__PURE__ */ new Set([
-  "utils",
-  "helpers",
-  "helper",
-  "misc",
-  "common",
-  "shared",
-  "tools",
-  "util",
-  "lib",
-  "libs",
-  "stuff",
-  "functions",
-  "methods",
-  "handlers",
-  "data",
-  "temp",
-  "tmp",
-  "test-utils",
-  "test-helpers",
-  "mocks"
-]);
-var SUPPORTED_EXTENSIONS = /* @__PURE__ */ new Set([".ts", ".tsx", ".js", ".jsx"]);
-var DEFAULT_EXCLUDES = [
-  "node_modules",
-  "dist",
-  ".git",
-  "coverage",
-  ".turbo",
-  "build"
-];
-function collectEntries(dir, options, depth = 0, dirs = [], files = []) {
-  if (depth > (options.maxDepth ?? 20)) return { dirs, files };
-  const excludes = [...DEFAULT_EXCLUDES, ...options.exclude ?? []];
-  let entries;
-  try {
-    entries = (0, import_fs.readdirSync)(dir);
-  } catch {
-    return { dirs, files };
-  }
-  for (const entry of entries) {
-    if (excludes.some((ex) => entry === ex || entry.includes(ex))) continue;
-    const full = (0, import_path.join)(dir, entry);
-    let stat;
-    try {
-      stat = (0, import_fs.statSync)(full);
-    } catch {
-      continue;
-    }
-    if (stat.isDirectory()) {
-      dirs.push({ path: full, depth });
-      collectEntries(full, options, depth + 1, dirs, files);
-    } else if (stat.isFile() && SUPPORTED_EXTENSIONS.has((0, import_path.extname)(full))) {
-      if (!options.include || options.include.some((p) => full.includes(p))) {
-        files.push(full);
-      }
-    }
-  }
-  return { dirs, files };
-}
 function analyzeFile(filePath) {
   let code;
   try {
@@ -170,7 +110,14 @@ async function analyzeAgentGrounding(options) {
   const rootDir = options.rootDir;
   const maxRecommendedDepth = options.maxRecommendedDepth ?? 4;
   const readmeStaleDays = options.readmeStaleDays ?? 90;
-  const { dirs, files } = collectEntries(rootDir, options);
+  const { files, dirs: rawDirs } = await (0, import_core.scanEntries)({
+    ...options,
+    include: options.include || ["**/*.{ts,tsx,js,jsx}"]
+  });
+  const dirs = rawDirs.map((d) => ({
+    path: d,
+    depth: (0, import_path.relative)(rootDir, d).split(/[/\\]/).filter(Boolean).length
+  }));
   const deepDirectories = dirs.filter(
     (d) => d.depth > maxRecommendedDepth
   ).length;
@@ -180,7 +127,7 @@ async function analyzeAgentGrounding(options) {
   let vagueFileNames = 0;
   for (const f of files) {
     const base = (0, import_path.basename)(f, (0, import_path.extname)(f)).toLowerCase();
-    if (VAGUE_FILE_NAMES.has(base) || additionalVague.has(base)) {
+    if (import_core.VAGUE_FILE_NAMES.has(base) || additionalVague.has(base)) {
       vagueFileNames++;
     }
   }
@@ -199,7 +146,14 @@ async function analyzeAgentGrounding(options) {
   let barrelExports = 0;
   let untypedExports = 0;
   let totalExports = 0;
+  let processed = 0;
   for (const f of files) {
+    processed++;
+    options.onProgress?.(
+      processed,
+      files.length,
+      `agent-grounding: analyzing files`
+    );
     const analysis = analyzeFile(f);
     if (analysis.isBarrel) barrelExports++;
     untypedExports += analysis.untypedExports;

package/dist/cli.mjs

@@ -2,7 +2,7 @@
 import {
   analyzeAgentGrounding,
   calculateGroundingScore
-} from "./chunk-NHDH733I.mjs";
+} from "./chunk-NXIMJNCK.mjs";
 
 // src/cli.ts
 import { Command } from "commander";

package/dist/index.js

@@ -26,70 +26,10 @@ __export(index_exports, {
 module.exports = __toCommonJS(index_exports);
 
 // src/analyzer.ts
+var import_core = require("@aiready/core");
 var import_fs = require("fs");
 var import_path = require("path");
 var import_typescript_estree = require("@typescript-eslint/typescript-estree");
-var import_core = require("@aiready/core");
-var VAGUE_FILE_NAMES = /* @__PURE__ */ new Set([
-  "utils",
-  "helpers",
-  "helper",
-  "misc",
-  "common",
-  "shared",
-  "tools",
-  "util",
-  "lib",
-  "libs",
-  "stuff",
-  "functions",
-  "methods",
-  "handlers",
-  "data",
-  "temp",
-  "tmp",
-  "test-utils",
-  "test-helpers",
-  "mocks"
-]);
-var SUPPORTED_EXTENSIONS = /* @__PURE__ */ new Set([".ts", ".tsx", ".js", ".jsx"]);
-var DEFAULT_EXCLUDES = [
-  "node_modules",
-  "dist",
-  ".git",
-  "coverage",
-  ".turbo",
-  "build"
-];
-function collectEntries(dir, options, depth = 0, dirs = [], files = []) {
-  if (depth > (options.maxDepth ?? 20)) return { dirs, files };
-  const excludes = [...DEFAULT_EXCLUDES, ...options.exclude ?? []];
-  let entries;
-  try {
-    entries = (0, import_fs.readdirSync)(dir);
-  } catch {
-    return { dirs, files };
-  }
-  for (const entry of entries) {
-    if (excludes.some((ex) => entry === ex || entry.includes(ex))) continue;
-    const full = (0, import_path.join)(dir, entry);
-    let stat;
-    try {
-      stat = (0, import_fs.statSync)(full);
-    } catch {
-      continue;
-    }
-    if (stat.isDirectory()) {
-      dirs.push({ path: full, depth });
-      collectEntries(full, options, depth + 1, dirs, files);
-    } else if (stat.isFile() && SUPPORTED_EXTENSIONS.has((0, import_path.extname)(full))) {
-      if (!options.include || options.include.some((p) => full.includes(p))) {
-        files.push(full);
-      }
-    }
-  }
-  return { dirs, files };
-}
 function analyzeFile(filePath) {
   let code;
   try {
@@ -169,7 +109,14 @@ async function analyzeAgentGrounding(options) {
   const rootDir = options.rootDir;
   const maxRecommendedDepth = options.maxRecommendedDepth ?? 4;
   const readmeStaleDays = options.readmeStaleDays ?? 90;
-  const { dirs, files } = collectEntries(rootDir, options);
+  const { files, dirs: rawDirs } = await (0, import_core.scanEntries)({
+    ...options,
+    include: options.include || ["**/*.{ts,tsx,js,jsx}"]
+  });
+  const dirs = rawDirs.map((d) => ({
+    path: d,
+    depth: (0, import_path.relative)(rootDir, d).split(/[/\\]/).filter(Boolean).length
+  }));
   const deepDirectories = dirs.filter(
     (d) => d.depth > maxRecommendedDepth
   ).length;
@@ -179,7 +126,7 @@ async function analyzeAgentGrounding(options) {
   let vagueFileNames = 0;
   for (const f of files) {
     const base = (0, import_path.basename)(f, (0, import_path.extname)(f)).toLowerCase();
-    if (VAGUE_FILE_NAMES.has(base) || additionalVague.has(base)) {
+    if (import_core.VAGUE_FILE_NAMES.has(base) || additionalVague.has(base)) {
       vagueFileNames++;
     }
   }
@@ -198,7 +145,14 @@ async function analyzeAgentGrounding(options) {
   let barrelExports = 0;
   let untypedExports = 0;
   let totalExports = 0;
+  let processed = 0;
   for (const f of files) {
+    processed++;
+    options.onProgress?.(
+      processed,
+      files.length,
+      `agent-grounding: analyzing files`
+    );
     const analysis = analyzeFile(f);
     if (analysis.isBarrel) barrelExports++;
     untypedExports += analysis.untypedExports;

package/dist/index.mjs

@@ -1,7 +1,7 @@
 import {
   analyzeAgentGrounding,
   calculateGroundingScore
-} from "./chunk-NHDH733I.mjs";
+} from "./chunk-NXIMJNCK.mjs";
 export {
   analyzeAgentGrounding,
   calculateGroundingScore

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aiready/agent-grounding",
-  "version": "0.1.6",
+  "version": "0.1.8",
   "description": "Measures how well an AI agent can navigate a codebase autonomously without human assistance",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
@@ -40,7 +40,7 @@
     "chalk": "^5.3.0",
     "commander": "^14.0.0",
     "glob": "^13.0.0",
-    "@aiready/core": "0.9.33"
+    "@aiready/core": "0.9.35"
   },
   "devDependencies": {
     "@types/node": "^24.0.0",

package/src/analyzer.ts

@@ -9,8 +9,13 @@
  * 5. Domain consistency — is the same concept named the same everywhere?
  */
 
-import { readdirSync, statSync, existsSync, readFileSync } from 'fs';
-import { join, extname, basename } from 'path';
+import {
+  scanEntries,
+  calculateAgentGrounding,
+  VAGUE_FILE_NAMES,
+} from '@aiready/core';
+import { readFileSync, existsSync, statSync } from 'fs';
+import { join, extname, basename, relative } from 'path';
 import { parse } from '@typescript-eslint/typescript-estree';
 import type { TSESTree } from '@typescript-eslint/types';
 import type {
@@ -18,89 +23,6 @@ import type {
   AgentGroundingIssue,
   AgentGroundingReport,
 } from './types';
-import { calculateAgentGrounding } from '@aiready/core';
-
-// File names that don't describe purpose — an agent can't determine what to find here
-const VAGUE_FILE_NAMES = new Set([
-  'utils',
-  'helpers',
-  'helper',
-  'misc',
-  'common',
-  'shared',
-  'tools',
-  'util',
-  'lib',
-  'libs',
-  'stuff',
-  'functions',
-  'methods',
-  'handlers',
-  'data',
-  'temp',
-  'tmp',
-  'test-utils',
-  'test-helpers',
-  'mocks',
-]);
-
-const SUPPORTED_EXTENSIONS = new Set(['.ts', '.tsx', '.js', '.jsx']);
-const DEFAULT_EXCLUDES = [
-  'node_modules',
-  'dist',
-  '.git',
-  'coverage',
-  '.turbo',
-  'build',
-];
-
-// ---------------------------------------------------------------------------
-// File/dir collection
-// ---------------------------------------------------------------------------
-
-interface DirEntry {
-  path: string;
-  depth: number;
-}
-
-function collectEntries(
-  dir: string,
-  options: AgentGroundingOptions,
-  depth = 0,
-  dirs: DirEntry[] = [],
-  files: string[] = []
-): { dirs: DirEntry[]; files: string[] } {
-  if (depth > (options.maxDepth ?? 20)) return { dirs, files };
-  const excludes = [...DEFAULT_EXCLUDES, ...(options.exclude ?? [])];
-
-  let entries: string[];
-  try {
-    entries = readdirSync(dir);
-  } catch {
-    return { dirs, 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()) {
-      dirs.push({ path: full, depth });
-      collectEntries(full, options, depth + 1, dirs, files);
-    } else if (stat.isFile() && SUPPORTED_EXTENSIONS.has(extname(full))) {
-      if (!options.include || options.include.some((p) => full.includes(p))) {
-        files.push(full);
-      }
-    }
-  }
-
-  return { dirs, files };
-}
 
 // ---------------------------------------------------------------------------
 // Per-file analysis
@@ -229,11 +151,20 @@ export async function analyzeAgentGrounding(
   const maxRecommendedDepth = options.maxRecommendedDepth ?? 4;
   const readmeStaleDays = options.readmeStaleDays ?? 90;
 
-  const { dirs, files } = collectEntries(rootDir, options);
+  // Use core scanEntries which respects .gitignore recursively
+  const { files, dirs: rawDirs } = await scanEntries({
+    ...options,
+    include: options.include || ['**/*.{ts,tsx,js,jsx}'],
+  });
+
+  const dirs = rawDirs.map((d: string) => ({
+    path: d,
+    depth: relative(rootDir, d).split(/[/\\]/).filter(Boolean).length,
+  }));
 
   // Structure clarity
   const deepDirectories = dirs.filter(
-    (d) => d.depth > maxRecommendedDepth
+    (d: { path: string; depth: number }) => d.depth > maxRecommendedDepth
   ).length;
 
   // Self-documentation — vague file names
@@ -268,7 +199,15 @@ export async function analyzeAgentGrounding(
   let untypedExports = 0;
   let totalExports = 0;
 
+  let processed = 0;
   for (const f of files) {
+    processed++;
+    options.onProgress?.(
+      processed,
+      files.length,
+      `agent-grounding: analyzing files`
+    );
+
     const analysis = analyzeFile(f);
     if (analysis.isBarrel) barrelExports++;
     untypedExports += analysis.untypedExports;