@aiready/agent-grounding 0.1.3 → 0.1.5
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.
- package/.turbo/turbo-build.log +6 -6
- package/.turbo/turbo-test.log +5 -4
- package/README.md +60 -0
- package/package.json +2 -2
package/.turbo/turbo-build.log
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
|
|
2
2
|
|
|
3
|
-
> @aiready/agent-grounding@0.1.
|
|
3
|
+
> @aiready/agent-grounding@0.1.5 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
|
[34mCLI[39m Building entry: src/cli.ts, src/index.ts
|
|
@@ -10,14 +10,14 @@
|
|
|
10
10
|
[34mCJS[39m Build start
|
|
11
11
|
[34mESM[39m Build start
|
|
12
12
|
[32mESM[39m [1mdist/index.mjs [22m[32m154.00 B[39m
|
|
13
|
-
[32mESM[39m [1mdist/cli.mjs [22m[32m5.04 KB[39m
|
|
14
13
|
[32mESM[39m [1mdist/chunk-OOB3JMXQ.mjs [22m[32m10.37 KB[39m
|
|
15
|
-
[32mESM[39m
|
|
16
|
-
[
|
|
14
|
+
[32mESM[39m [1mdist/cli.mjs [22m[32m5.04 KB[39m
|
|
15
|
+
[32mESM[39m ⚡️ Build success in 1612ms
|
|
17
16
|
[32mCJS[39m [1mdist/index.js [22m[32m11.62 KB[39m
|
|
18
|
-
[32mCJS[39m
|
|
17
|
+
[32mCJS[39m [1mdist/cli.js [22m[32m16.99 KB[39m
|
|
18
|
+
[32mCJS[39m ⚡️ Build success in 1620ms
|
|
19
19
|
DTS Build start
|
|
20
|
-
DTS ⚡️ Build success in
|
|
20
|
+
DTS ⚡️ Build success in 69473ms
|
|
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
|
package/.turbo/turbo-test.log
CHANGED
|
@@ -1,16 +1,17 @@
|
|
|
1
1
|
|
|
2
2
|
|
|
3
|
-
> @aiready/agent-grounding@0.1.
|
|
3
|
+
> @aiready/agent-grounding@0.1.5 test /Users/pengcao/projects/aiready/packages/agent-grounding
|
|
4
4
|
> vitest run
|
|
5
5
|
|
|
6
6
|
[?25l
|
|
7
7
|
[1m[46m RUN [49m[22m [36mv4.0.18 [39m[90m/Users/pengcao/projects/aiready/packages/agent-grounding[39m
|
|
8
8
|
|
|
9
|
-
[32m✓[39m src/__tests__/analyzer.test.ts [2m([22m[2m3 tests[22m[2m)[22m[
|
|
9
|
+
[32m✓[39m src/__tests__/analyzer.test.ts [2m([22m[2m3 tests[22m[2m)[22m[33m 1215[2mms[22m[39m
|
|
10
|
+
[33m[2m✓[22m[39m should detect deep directories and vague file names [33m 954[2mms[22m[39m
|
|
10
11
|
|
|
11
12
|
[2m Test Files [22m [1m[32m1 passed[39m[22m[90m (1)[39m
|
|
12
13
|
[2m Tests [22m [1m[32m3 passed[39m[22m[90m (3)[39m
|
|
13
|
-
[2m Start at [22m
|
|
14
|
-
[2m Duration [22m
|
|
14
|
+
[2m Start at [22m 14:38:43
|
|
15
|
+
[2m Duration [22m 21.71s[2m (transform 4.66s, setup 0ms, import 16.23s, tests 1.21s, environment 0ms)[22m
|
|
15
16
|
|
|
16
17
|
[?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
|
+
[](https://npmjs.com/package/@aiready/agent-grounding)
|
|
6
|
+
[](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.
|
|
3
|
+
"version": "0.1.5",
|
|
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.
|
|
43
|
+
"@aiready/core": "0.9.32"
|
|
44
44
|
},
|
|
45
45
|
"devDependencies": {
|
|
46
46
|
"@types/node": "^24.0.0",
|