@aiready/agent-grounding 0.11.16 → 0.11.17

package/.turbo/turbo-build.log

@@ -1,6 +1,6 @@
 
 
-> @aiready/agent-grounding@0.11.15 build /Users/pengcao/projects/aiready/packages/agent-grounding
+> @aiready/agent-grounding@0.11.16 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
+CJS dist/cli.js   16.65 KB
+CJS dist/index.js 12.42 KB
+CJS ⚡️ Build success in 39ms
 ESM dist/cli.mjs            5.16 KB
-ESM dist/chunk-7DOMO6A5.mjs 9.73 KB
 ESM dist/index.mjs          1.30 KB
-ESM ⚡️ Build success in 166ms
-CJS dist/index.js 12.31 KB
-CJS dist/cli.js   16.54 KB
-CJS ⚡️ Build success in 166ms
+ESM dist/chunk-AWAS2KB5.mjs 9.83 KB
+ESM ⚡️ Build success in 40ms
 DTS Build start
-DTS ⚡️ Build success in 2597ms
+DTS ⚡️ Build success in 1249ms
 DTS dist/cli.d.ts    20.00 B
 DTS dist/index.d.ts  2.49 KB
 DTS dist/cli.d.mts   20.00 B

package/.turbo/turbo-test.log

@@ -1,16 +1,16 @@
 
 
-> @aiready/agent-grounding@0.11.15 test /Users/pengcao/projects/aiready/packages/agent-grounding
+> @aiready/agent-grounding@0.11.16 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) 282ms
+ ✓ src/__tests__/analyzer.test.ts (3 tests) 59ms
 
  Test Files  1 passed (1)
       Tests  3 passed (3)
-   Start at  02:11:32
-   Duration  1.48s (transform 207ms, setup 0ms, import 976ms, tests 282ms, environment 0ms)
+   Start at  12:45:56
+   Duration  439ms (transform 72ms, setup 0ms, import 263ms, tests 59ms, environment 0ms)
 
 [?25h

package/dist/chunk-AWAS2KB5.mjs

@@ -0,0 +1,304 @@
+// src/analyzer.ts
+import {
+  scanEntries,
+  calculateAgentGrounding,
+  VAGUE_FILE_NAMES,
+  Severity,
+  IssueType,
+  emitProgress
+} 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 { files: allFiles } = await scanEntries({
+    ...options,
+    include: ["**/*"]
+  });
+  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 allFiles) {
+    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++;
+    emitProgress(
+      processed,
+      files.length,
+      "agent-grounding",
+      "analyzing files",
+      options.onProgress
+    );
+    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: IssueType.AgentNavigationFailure,
+      dimension: "structure-clarity",
+      severity: 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: IssueType.AgentNavigationFailure,
+      dimension: "self-documentation",
+      severity: 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: IssueType.AgentNavigationFailure,
+      dimension: "entry-point",
+      severity: 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: IssueType.AgentNavigationFailure,
+      dimension: "entry-point",
+      severity: 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: IssueType.AgentNavigationFailure,
+      dimension: "api-clarity",
+      severity: 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: IssueType.AgentNavigationFailure,
+      dimension: "domain-consistency",
+      severity: 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
+import { ToolName } from "@aiready/core";
+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: ToolName.AgentGrounding,
+    score: summary.score,
+    rawMetrics: {
+      ...rawData,
+      rating: summary.rating
+    },
+    factors,
+    recommendations: recs
+  };
+}
+
+export {
+  analyzeAgentGrounding,
+  calculateGroundingScore
+};

package/dist/cli.js

@@ -114,6 +114,10 @@ async function analyzeAgentGrounding(options) {
     ...options,
     include: options.include || ["**/*.{ts,tsx,js,jsx}"]
   });
+  const { files: allFiles } = await (0, import_core.scanEntries)({
+    ...options,
+    include: ["**/*"]
+  });
   const dirs = rawDirs.map((d) => ({
     path: d,
     depth: (0, import_path.relative)(rootDir, d).split(/[/\\]/).filter(Boolean).length
@@ -125,7 +129,7 @@ async function analyzeAgentGrounding(options) {
     (options.additionalVagueNames ?? []).map((n) => n.toLowerCase())
   );
   let vagueFileNames = 0;
-  for (const f of files) {
+  for (const f of allFiles) {
     const base = (0, import_path.basename)(f, (0, import_path.extname)(f)).toLowerCase();
     if (import_core.VAGUE_FILE_NAMES.has(base) || additionalVague.has(base)) {
       vagueFileNames++;

package/dist/cli.mjs

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

package/dist/index.js

@@ -118,6 +118,10 @@ async function analyzeAgentGrounding(options) {
     ...options,
     include: options.include || ["**/*.{ts,tsx,js,jsx}"]
   });
+  const { files: allFiles } = await (0, import_core.scanEntries)({
+    ...options,
+    include: ["**/*"]
+  });
   const dirs = rawDirs.map((d) => ({
     path: d,
     depth: (0, import_path.relative)(rootDir, d).split(/[/\\]/).filter(Boolean).length
@@ -129,7 +133,7 @@ async function analyzeAgentGrounding(options) {
     (options.additionalVagueNames ?? []).map((n) => n.toLowerCase())
   );
   let vagueFileNames = 0;
-  for (const f of files) {
+  for (const f of allFiles) {
     const base = (0, import_path.basename)(f, (0, import_path.extname)(f)).toLowerCase();
     if (import_core.VAGUE_FILE_NAMES.has(base) || additionalVague.has(base)) {
       vagueFileNames++;

package/dist/index.mjs

@@ -1,7 +1,7 @@
 import {
   analyzeAgentGrounding,
   calculateGroundingScore
-} from "./chunk-7DOMO6A5.mjs";
+} from "./chunk-AWAS2KB5.mjs";
 
 // src/index.ts
 import { ToolRegistry } from "@aiready/core";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aiready/agent-grounding",
-  "version": "0.11.16",
+  "version": "0.11.17",
   "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.21.16"
+    "@aiready/core": "0.21.17"
   },
   "devDependencies": {
     "@types/node": "^24.0.0",

package/src/analyzer.ts

@@ -155,11 +155,18 @@ export async function analyzeAgentGrounding(
   const readmeStaleDays = options.readmeStaleDays ?? 90;
 
   // Use core scanEntries which respects .gitignore recursively
+  // First scan for metrics that need code analysis (limited to JS/TS)
   const { files, dirs: rawDirs } = await scanEntries({
     ...options,
     include: options.include || ['**/*.{ts,tsx,js,jsx}'],
   });
 
+  // Second scan for ALL files to catch vague names (e.g. data.txt, tmp.log)
+  const { files: allFiles } = await scanEntries({
+    ...options,
+    include: ['**/*'],
+  });
+
   const dirs = rawDirs.map((d: string) => ({
     path: d,
     depth: relative(rootDir, d).split(/[/\\]/).filter(Boolean).length,
@@ -175,7 +182,7 @@ export async function analyzeAgentGrounding(
     (options.additionalVagueNames ?? []).map((n) => n.toLowerCase())
   );
   let vagueFileNames = 0;
-  for (const f of files) {
+  for (const f of allFiles) {
     const base = basename(f, extname(f)).toLowerCase();
     if (VAGUE_FILE_NAMES.has(base) || additionalVague.has(base)) {
       vagueFileNames++;