@aiready/agent-grounding 0.1.1

package/dist/cli.js

@@ -0,0 +1,425 @@
+#!/usr/bin/env node
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+
+// src/cli.ts
+var import_commander = require("commander");
+
+// src/analyzer.ts
+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 {
+    code = (0, import_fs.readFileSync)(filePath, "utf-8");
+  } catch {
+    return { isBarrel: false, exportedNames: [], untypedExports: 0, totalExports: 0, domainTerms: [] };
+  }
+  let ast;
+  try {
+    ast = (0, import_typescript_estree.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;
+  let 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 = (0, import_path.basename)(f, (0, import_path.extname)(f)).toLowerCase();
+    if (VAGUE_FILE_NAMES.has(base) || additionalVague.has(base)) {
+      vagueFileNames++;
+    }
+  }
+  const readmePath = (0, import_path.join)(rootDir, "README.md");
+  const hasRootReadme = (0, import_fs.existsSync)(readmePath);
+  let readmeIsFresh = false;
+  if (hasRootReadme) {
+    try {
+      const stat = (0, import_fs.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;
+  for (const f of 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 = (0, import_core.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: (0, import_path.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, issues, 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
+  };
+}
+
+// src/cli.ts
+var import_chalk = __toESM(require("chalk"));
+var import_fs2 = require("fs");
+var import_path2 = require("path");
+var import_core2 = require("@aiready/core");
+var program = new import_commander.Command();
+program.name("aiready-agent-grounding").description("Measure how well an AI agent can navigate your codebase autonomously").version("0.1.0").addHelpText("after", `
+GROUNDING DIMENSIONS:
+  Structure Clarity     Deep directory trees slow and confuse agents
+  Self-Documentation    Vague file names (utils, helpers) hide intent
+  Entry Points          README presence, freshness, and barrel exports
+  API Clarity           Untyped exports prevent API contract inference
+  Domain Consistency    Inconsistent naming forces agents to guess
+
+EXAMPLES:
+  aiready-agent-grounding .                        # Full analysis
+  aiready-agent-grounding src/ --output json       # JSON report
+  aiready-agent-grounding . --max-depth 3          # Stricter depth limit
+`).argument("<directory>", "Directory to analyze").option("--max-depth <n>", "Max recommended directory depth (default: 4)", "4").option("--readme-stale-days <n>", "Days after which README is considered stale (default: 90)", "90").option("--include <patterns>", "File patterns to include (comma-separated)").option("--exclude <patterns>", "File patterns to exclude (comma-separated)").option("-o, --output <format>", "Output format: console|json", "console").option("--output-file <path>", "Output file path (for json)").action(async (directory, options) => {
+  console.log(import_chalk.default.blue("\u{1F9ED} Analyzing agent grounding...\n"));
+  const startTime = Date.now();
+  const config = await (0, import_core2.loadConfig)(directory);
+  const mergedConfig = (0, import_core2.mergeConfigWithDefaults)(config, {
+    maxRecommendedDepth: 4,
+    readmeStaleDays: 90
+  });
+  const finalOptions = {
+    rootDir: directory,
+    maxRecommendedDepth: parseInt(options.maxDepth ?? "4", 10) || mergedConfig.maxRecommendedDepth,
+    readmeStaleDays: parseInt(options.readmeStaleDays ?? "90", 10) || mergedConfig.readmeStaleDays,
+    include: options.include?.split(","),
+    exclude: options.exclude?.split(",")
+  };
+  const report = await analyzeAgentGrounding(finalOptions);
+  const scoring = calculateGroundingScore(report);
+  const elapsed = ((Date.now() - startTime) / 1e3).toFixed(2);
+  if (options.output === "json") {
+    const payload = { report, score: scoring };
+    const outputPath = (0, import_core2.resolveOutputPath)(
+      options.outputFile,
+      `agent-grounding-report-${(/* @__PURE__ */ new Date()).toISOString().split("T")[0]}.json`,
+      directory
+    );
+    const dir = (0, import_path2.dirname)(outputPath);
+    if (!(0, import_fs2.existsSync)(dir)) (0, import_fs2.mkdirSync)(dir, { recursive: true });
+    (0, import_fs2.writeFileSync)(outputPath, JSON.stringify(payload, null, 2));
+    console.log(import_chalk.default.green(`\u2713 Report saved to ${outputPath}`));
+  } else {
+    displayConsoleReport(report, scoring, elapsed);
+  }
+});
+program.parse();
+function scoreColor(score) {
+  if (score >= 85) return import_chalk.default.green;
+  if (score >= 70) return import_chalk.default.cyan;
+  if (score >= 50) return import_chalk.default.yellow;
+  if (score >= 30) return import_chalk.default.red;
+  return import_chalk.default.bgRed.white;
+}
+function displayConsoleReport(report, scoring, elapsed) {
+  const { summary, rawData, issues, recommendations } = report;
+  console.log(import_chalk.default.bold("\n\u{1F9ED} Agent Grounding Analysis\n"));
+  console.log(`Score:       ${scoreColor(summary.score)(summary.score + "/100")} (${summary.rating.toUpperCase()})`);
+  console.log(`Files:       ${import_chalk.default.cyan(summary.filesAnalyzed)}   Directories: ${import_chalk.default.cyan(summary.directoriesAnalyzed)}`);
+  console.log(`Analysis:    ${import_chalk.default.gray(elapsed + "s")}
+`);
+  console.log(import_chalk.default.bold("\u{1F4D0} Dimension Scores\n"));
+  const dims = [
+    ["Structure Clarity", summary.dimensions.structureClarityScore],
+    ["Self-Documentation", summary.dimensions.selfDocumentationScore],
+    ["Entry Points", summary.dimensions.entryPointScore],
+    ["API Clarity", summary.dimensions.apiClarityScore],
+    ["Domain Consistency", summary.dimensions.domainConsistencyScore]
+  ];
+  for (const [name, val] of dims) {
+    const bar = "\u2588".repeat(Math.round(val / 10)).padEnd(10, "\u2591");
+    console.log(`  ${String(name).padEnd(22)} ${scoreColor(val)(bar)} ${val}/100`);
+  }
+  if (issues.length > 0) {
+    console.log(import_chalk.default.bold("\n\u26A0\uFE0F  Issues Found\n"));
+    for (const issue of issues) {
+      const sev = issue.severity === "critical" ? import_chalk.default.red : issue.severity === "major" ? import_chalk.default.yellow : import_chalk.default.blue;
+      console.log(`${sev(issue.severity.toUpperCase())}  ${issue.message}`);
+      if (issue.suggestion) console.log(`         ${import_chalk.default.dim("\u2192")} ${import_chalk.default.italic(issue.suggestion)}`);
+      console.log();
+    }
+  } else {
+    console.log(import_chalk.default.green("\n\u2728 No grounding issues found \u2014 agents can navigate freely!\n"));
+  }
+  if (recommendations.length > 0) {
+    console.log(import_chalk.default.bold("\u{1F4A1} Recommendations\n"));
+    recommendations.forEach((rec, i) => console.log(`${i + 1}. ${rec}`));
+  }
+  console.log();
+}

package/dist/cli.mjs

@@ -0,0 +1,102 @@
+#!/usr/bin/env node
+import {
+  analyzeAgentGrounding,
+  calculateGroundingScore
+} from "./chunk-OOB3JMXQ.mjs";
+
+// src/cli.ts
+import { Command } from "commander";
+import chalk from "chalk";
+import { writeFileSync, mkdirSync, existsSync } from "fs";
+import { dirname } from "path";
+import { loadConfig, mergeConfigWithDefaults, resolveOutputPath } from "@aiready/core";
+var program = new Command();
+program.name("aiready-agent-grounding").description("Measure how well an AI agent can navigate your codebase autonomously").version("0.1.0").addHelpText("after", `
+GROUNDING DIMENSIONS:
+  Structure Clarity     Deep directory trees slow and confuse agents
+  Self-Documentation    Vague file names (utils, helpers) hide intent
+  Entry Points          README presence, freshness, and barrel exports
+  API Clarity           Untyped exports prevent API contract inference
+  Domain Consistency    Inconsistent naming forces agents to guess
+
+EXAMPLES:
+  aiready-agent-grounding .                        # Full analysis
+  aiready-agent-grounding src/ --output json       # JSON report
+  aiready-agent-grounding . --max-depth 3          # Stricter depth limit
+`).argument("<directory>", "Directory to analyze").option("--max-depth <n>", "Max recommended directory depth (default: 4)", "4").option("--readme-stale-days <n>", "Days after which README is considered stale (default: 90)", "90").option("--include <patterns>", "File patterns to include (comma-separated)").option("--exclude <patterns>", "File patterns to exclude (comma-separated)").option("-o, --output <format>", "Output format: console|json", "console").option("--output-file <path>", "Output file path (for json)").action(async (directory, options) => {
+  console.log(chalk.blue("\u{1F9ED} Analyzing agent grounding...\n"));
+  const startTime = Date.now();
+  const config = await loadConfig(directory);
+  const mergedConfig = mergeConfigWithDefaults(config, {
+    maxRecommendedDepth: 4,
+    readmeStaleDays: 90
+  });
+  const finalOptions = {
+    rootDir: directory,
+    maxRecommendedDepth: parseInt(options.maxDepth ?? "4", 10) || mergedConfig.maxRecommendedDepth,
+    readmeStaleDays: parseInt(options.readmeStaleDays ?? "90", 10) || mergedConfig.readmeStaleDays,
+    include: options.include?.split(","),
+    exclude: options.exclude?.split(",")
+  };
+  const report = await analyzeAgentGrounding(finalOptions);
+  const scoring = calculateGroundingScore(report);
+  const elapsed = ((Date.now() - startTime) / 1e3).toFixed(2);
+  if (options.output === "json") {
+    const payload = { report, score: scoring };
+    const outputPath = resolveOutputPath(
+      options.outputFile,
+      `agent-grounding-report-${(/* @__PURE__ */ new Date()).toISOString().split("T")[0]}.json`,
+      directory
+    );
+    const dir = dirname(outputPath);
+    if (!existsSync(dir)) mkdirSync(dir, { recursive: true });
+    writeFileSync(outputPath, JSON.stringify(payload, null, 2));
+    console.log(chalk.green(`\u2713 Report saved to ${outputPath}`));
+  } else {
+    displayConsoleReport(report, scoring, elapsed);
+  }
+});
+program.parse();
+function scoreColor(score) {
+  if (score >= 85) return chalk.green;
+  if (score >= 70) return chalk.cyan;
+  if (score >= 50) return chalk.yellow;
+  if (score >= 30) return chalk.red;
+  return chalk.bgRed.white;
+}
+function displayConsoleReport(report, scoring, elapsed) {
+  const { summary, rawData, issues, recommendations } = report;
+  console.log(chalk.bold("\n\u{1F9ED} Agent Grounding Analysis\n"));
+  console.log(`Score:       ${scoreColor(summary.score)(summary.score + "/100")} (${summary.rating.toUpperCase()})`);
+  console.log(`Files:       ${chalk.cyan(summary.filesAnalyzed)}   Directories: ${chalk.cyan(summary.directoriesAnalyzed)}`);
+  console.log(`Analysis:    ${chalk.gray(elapsed + "s")}
+`);
+  console.log(chalk.bold("\u{1F4D0} Dimension Scores\n"));
+  const dims = [
+    ["Structure Clarity", summary.dimensions.structureClarityScore],
+    ["Self-Documentation", summary.dimensions.selfDocumentationScore],
+    ["Entry Points", summary.dimensions.entryPointScore],
+    ["API Clarity", summary.dimensions.apiClarityScore],
+    ["Domain Consistency", summary.dimensions.domainConsistencyScore]
+  ];
+  for (const [name, val] of dims) {
+    const bar = "\u2588".repeat(Math.round(val / 10)).padEnd(10, "\u2591");
+    console.log(`  ${String(name).padEnd(22)} ${scoreColor(val)(bar)} ${val}/100`);
+  }
+  if (issues.length > 0) {
+    console.log(chalk.bold("\n\u26A0\uFE0F  Issues Found\n"));
+    for (const issue of issues) {
+      const sev = issue.severity === "critical" ? chalk.red : issue.severity === "major" ? chalk.yellow : chalk.blue;
+      console.log(`${sev(issue.severity.toUpperCase())}  ${issue.message}`);
+      if (issue.suggestion) console.log(`         ${chalk.dim("\u2192")} ${chalk.italic(issue.suggestion)}`);
+      console.log();
+    }
+  } else {
+    console.log(chalk.green("\n\u2728 No grounding issues found \u2014 agents can navigate freely!\n"));
+  }
+  if (recommendations.length > 0) {
+    console.log(chalk.bold("\u{1F4A1} Recommendations\n"));
+    recommendations.forEach((rec, i) => console.log(`${i + 1}. ${rec}`));
+  }
+  console.log();
+}

package/dist/index.d.mts

@@ -0,0 +1,66 @@
+import { Issue, ScanOptions, ToolScoringOutput } from '@aiready/core';
+
+interface AgentGroundingOptions extends ScanOptions {
+    /** Max directory depth before flagging as "too deep" */
+    maxRecommendedDepth?: number;
+    /** README staleness threshold in days */
+    readmeStaleDays?: number;
+    /** File names considered "vague" (in addition to built-in list) */
+    additionalVagueNames?: string[];
+}
+interface AgentGroundingIssue extends Issue {
+    type: 'agent-navigation-failure';
+    /** Which grounding dimension is affected */
+    dimension: 'structure-clarity' | 'self-documentation' | 'entry-point' | 'api-clarity' | 'domain-consistency';
+}
+interface AgentGroundingReport {
+    summary: {
+        filesAnalyzed: number;
+        directoriesAnalyzed: number;
+        score: number;
+        rating: 'excellent' | 'good' | 'moderate' | 'poor' | 'disorienting';
+        dimensions: {
+            structureClarityScore: number;
+            selfDocumentationScore: number;
+            entryPointScore: number;
+            apiClarityScore: number;
+            domainConsistencyScore: number;
+        };
+    };
+    issues: AgentGroundingIssue[];
+    rawData: {
+        deepDirectories: number;
+        totalDirectories: number;
+        vagueFileNames: number;
+        totalFiles: number;
+        hasRootReadme: boolean;
+        readmeIsFresh: boolean;
+        barrelExports: number;
+        untypedExports: number;
+        totalExports: number;
+        inconsistentDomainTerms: number;
+        domainVocabularySize: number;
+    };
+    recommendations: string[];
+}
+
+/**
+ * Scanner for agent-grounding dimensions.
+ *
+ * Measures 5 dimensions:
+ * 1. Structure clarity — how deep are directory trees?
+ * 2. Self-documentation — do file names reveal purpose?
+ * 3. Entry points — does a fresh README + barrel exports exist?
+ * 4. API clarity — are public exports typed?
+ * 5. Domain consistency — is the same concept named the same everywhere?
+ */
+
+declare function analyzeAgentGrounding(options: AgentGroundingOptions): Promise<AgentGroundingReport>;
+
+/**
+ * Convert agent grounding report into a ToolScoringOutput
+ * for inclusion in the unified AIReady score.
+ */
+declare function calculateGroundingScore(report: AgentGroundingReport): ToolScoringOutput;
+
+export { type AgentGroundingIssue, type AgentGroundingOptions, type AgentGroundingReport, analyzeAgentGrounding, calculateGroundingScore };

package/dist/index.d.ts

@@ -0,0 +1,66 @@
+import { Issue, ScanOptions, ToolScoringOutput } from '@aiready/core';
+
+interface AgentGroundingOptions extends ScanOptions {
+    /** Max directory depth before flagging as "too deep" */
+    maxRecommendedDepth?: number;
+    /** README staleness threshold in days */
+    readmeStaleDays?: number;
+    /** File names considered "vague" (in addition to built-in list) */
+    additionalVagueNames?: string[];
+}
+interface AgentGroundingIssue extends Issue {
+    type: 'agent-navigation-failure';
+    /** Which grounding dimension is affected */
+    dimension: 'structure-clarity' | 'self-documentation' | 'entry-point' | 'api-clarity' | 'domain-consistency';
+}
+interface AgentGroundingReport {
+    summary: {
+        filesAnalyzed: number;
+        directoriesAnalyzed: number;
+        score: number;
+        rating: 'excellent' | 'good' | 'moderate' | 'poor' | 'disorienting';
+        dimensions: {
+            structureClarityScore: number;
+            selfDocumentationScore: number;
+            entryPointScore: number;
+            apiClarityScore: number;
+            domainConsistencyScore: number;
+        };
+    };
+    issues: AgentGroundingIssue[];
+    rawData: {
+        deepDirectories: number;
+        totalDirectories: number;
+        vagueFileNames: number;
+        totalFiles: number;
+        hasRootReadme: boolean;
+        readmeIsFresh: boolean;
+        barrelExports: number;
+        untypedExports: number;
+        totalExports: number;
+        inconsistentDomainTerms: number;
+        domainVocabularySize: number;
+    };
+    recommendations: string[];
+}
+
+/**
+ * Scanner for agent-grounding dimensions.
+ *
+ * Measures 5 dimensions:
+ * 1. Structure clarity — how deep are directory trees?
+ * 2. Self-documentation — do file names reveal purpose?
+ * 3. Entry points — does a fresh README + barrel exports exist?
+ * 4. API clarity — are public exports typed?
+ * 5. Domain consistency — is the same concept named the same everywhere?
+ */
+
+declare function analyzeAgentGrounding(options: AgentGroundingOptions): Promise<AgentGroundingReport>;
+
+/**
+ * Convert agent grounding report into a ToolScoringOutput
+ * for inclusion in the unified AIReady score.
+ */
+declare function calculateGroundingScore(report: AgentGroundingReport): ToolScoringOutput;
+
+export { type AgentGroundingIssue, type AgentGroundingOptions, type AgentGroundingReport, analyzeAgentGrounding, calculateGroundingScore };