@aiready/agent-grounding 0.1.1 → 0.1.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,6 +1,6 @@
1
1
 
2
2
  
3
- > @aiready/agent-grounding@0.1.1 build /Users/pengcao/projects/aiready/packages/agent-grounding
3
+ > @aiready/agent-grounding@0.1.4 build /Users/pengcao/projects/aiready/packages/agent-grounding
4
4
  > tsup src/index.ts src/cli.ts --format cjs,esm --dts
5
5
 
6
6
  CLI Building entry: src/cli.ts, src/index.ts
@@ -9,15 +9,15 @@
9
9
  CLI Target: es2020
10
10
  CJS Build start
11
11
  ESM Build start
12
- ESM dist/index.mjs 154.00 B
12
+ CJS dist/index.js 11.62 KB
13
+ CJS dist/cli.js 16.99 KB
14
+ CJS ⚡️ Build success in 117ms
13
15
  ESM dist/cli.mjs 5.04 KB
16
+ ESM dist/index.mjs 154.00 B
14
17
  ESM dist/chunk-OOB3JMXQ.mjs 10.37 KB
15
- ESM ⚡️ Build success in 77ms
16
- CJS dist/cli.js 16.99 KB
17
- CJS dist/index.js 11.62 KB
18
- CJS ⚡️ Build success in 78ms
18
+ ESM ⚡️ Build success in 117ms
19
19
  DTS Build start
20
- DTS ⚡️ Build success in 4226ms
20
+ DTS ⚡️ Build success in 7547ms
21
21
  DTS dist/cli.d.ts 20.00 B
22
22
  DTS dist/index.d.ts 2.34 KB
23
23
  DTS dist/cli.d.mts 20.00 B
@@ -1,16 +1,16 @@
1
1
 
2
2
  
3
- > @aiready/agent-grounding@0.1.1 test /Users/pengcao/projects/aiready/packages/agent-grounding
3
+ > @aiready/agent-grounding@0.1.4 test /Users/pengcao/projects/aiready/packages/agent-grounding
4
4
  > vitest run
5
5
 
6
6
  [?25l
7
7
   RUN  v4.0.18 /Users/pengcao/projects/aiready/packages/agent-grounding
8
8
 
9
- ✓ src/__tests__/analyzer.test.ts (3 tests) 38ms
9
+ ✓ src/__tests__/analyzer.test.ts (3 tests) 64ms
10
10
 
11
11
   Test Files  1 passed (1)
12
12
   Tests  3 passed (3)
13
-  Start at  21:42:02
14
-  Duration  1.11s (transform 284ms, setup 0ms, import 868ms, tests 38ms, environment 0ms)
13
+  Start at  13:04:26
14
+  Duration  3.22s (transform 796ms, setup 0ms, import 2.63s, tests 64ms, environment 0ms)
15
15
 
16
16
  [?25h
package/README.md ADDED
@@ -0,0 +1,60 @@
1
+ # @aiready/agent-grounding
2
+
3
+ > AIReady Spoke: Evaluates how well the codebase provides structured context for AI agents to understand domain boundaries and project architecture.
4
+
5
+ [![npm version](https://img.shields.io/npm/v/@aiready/agent-grounding.svg)](https://npmjs.com/package/@aiready/agent-grounding)
6
+ [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
7
+
8
+ ## Overview
9
+
10
+ AI agents are only as good as the context they are given. The **Agent Grounding** analyzer evaluates how "groundable" your codebase is—checking if domain concepts are clearly defined and project structure carries semantic meaning that aids AI retrieval.
11
+
12
+ ## 🏛️ Architecture
13
+
14
+ ```
15
+ 🎯 USER
16
+
17
+
18
+ 🎛️ @aiready/cli (orchestrator)
19
+ │ │ │ │ │ │ │ │ │
20
+ ▼ ▼ ▼ ▼ ▼ ▼ ▼ ▼ ▼
21
+ [PAT] [CTX] [CON] [AMP] [DEP] [DOC] [SIG] [AGT] [TST]
22
+ │ │ │ │ │ │ │ │ │
23
+ └─────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┘
24
+
25
+
26
+ 🏢 @aiready/core
27
+
28
+ Legend:
29
+ PAT = pattern-detect CTX = context-analyzer
30
+ CON = consistency AMP = change-amplification
31
+ DEP = deps-health DOC = doc-drift
32
+ SIG = ai-signal-clarity AGT = agent-grounding ★
33
+ TST = testability ★ = YOU ARE HERE
34
+ ```
35
+
36
+ ## Features
37
+
38
+ - **README Quality**: Analyzes if high-level project documentation provides sufficient context for agent reasoning.
39
+ - **Directory Semantics**: Checks if file structure follows industry patterns that AI models recognize.
40
+ - **Domain Consistency**: Detects if core business concepts are named consistently across different modules.
41
+ - **Context Boundaries**: Flags ambiguous boundaries where code for multiple domains is mixed together.
42
+
43
+ ## Installation
44
+
45
+ ```bash
46
+ pnpm add @aiready/agent-grounding
47
+ ```
48
+
49
+ ## Usage
50
+
51
+ This tool is designed to be run through the unified AIReady CLI.
52
+
53
+ ```bash
54
+ # Scan for agent grounding quality
55
+ aiready scan . --tools agent-grounding
56
+ ```
57
+
58
+ ## License
59
+
60
+ MIT
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@aiready/agent-grounding",
3
- "version": "0.1.1",
3
+ "version": "0.1.4",
4
4
  "description": "Measures how well an AI agent can navigate a codebase autonomously without human assistance",
5
5
  "main": "./dist/index.js",
6
6
  "module": "./dist/index.mjs",
@@ -40,7 +40,7 @@
40
40
  "chalk": "^5.3.0",
41
41
  "commander": "^14.0.0",
42
42
  "glob": "^11.0.0",
43
- "@aiready/core": "0.9.28"
43
+ "@aiready/core": "0.9.31"
44
44
  },
45
45
  "devDependencies": {
46
46
  "@types/node": "^24.0.0",