@aiready/cli 0.14.14 → 0.14.15
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/CONTRIBUTING.md +86 -1
- package/LICENSE +21 -0
- package/package.json +33 -12
- package/.aiready/aiready-report-20260227-133806.json +0 -7805
- package/.aiready/aiready-report-20260227-133938.json +0 -7951
- package/.aiready/aiready-report-20260228-003433.json +0 -7939
- package/.aiready/aiready-report-20260228-003613.json +0 -771
- package/.aiready/aiready-report-20260314-164626.json +0 -59
- package/.aiready/aiready-report-20260314-164741.json +0 -59
- package/.aiready/aiready-report-20260319-201106.json +0 -5566
- package/.aiready/aiready-report-20260319-201511.json +0 -5566
- package/.aiready/aiready-report-20260319-202017.json +0 -5708
- package/.github/FUNDING.yml +0 -5
- package/.turbo/turbo-build.log +0 -29
- package/.turbo/turbo-lint.log +0 -0
- package/.turbo/turbo-test.log +0 -76
- package/aiready-report.json +0 -30703
- package/coverage/base.css +0 -224
- package/coverage/block-navigation.js +0 -87
- package/coverage/clover.xml +0 -865
- package/coverage/coverage-final.json +0 -15
- package/coverage/favicon.png +0 -0
- package/coverage/index.html +0 -146
- package/coverage/prettify.css +0 -1
- package/coverage/prettify.js +0 -2
- package/coverage/sort-arrow-sprite.png +0 -0
- package/coverage/sorter.js +0 -210
- package/coverage/src/commands/agent-grounding.ts.html +0 -271
- package/coverage/src/commands/ai-signal-clarity.ts.html +0 -253
- package/coverage/src/commands/change-amplification.ts.html +0 -94
- package/coverage/src/commands/consistency.ts.html +0 -781
- package/coverage/src/commands/context.ts.html +0 -871
- package/coverage/src/commands/deps-health.ts.html +0 -280
- package/coverage/src/commands/doc-drift.ts.html +0 -271
- package/coverage/src/commands/index.html +0 -281
- package/coverage/src/commands/patterns.ts.html +0 -745
- package/coverage/src/commands/scan.ts.html +0 -1393
- package/coverage/src/commands/testability.ts.html +0 -304
- package/coverage/src/commands/upload.ts.html +0 -466
- package/coverage/src/commands/visualize.ts.html +0 -1027
- package/coverage/src/index.html +0 -116
- package/coverage/src/index.ts.html +0 -1372
- package/coverage/src/utils/helpers.ts.html +0 -559
- package/coverage/src/utils/index.html +0 -116
- package/docs/SPOKE_GUIDE.md +0 -184
- package/packages/core/src/.aiready/aiready-report-20260314-161145.json +0 -224
- package/packages/core/src/.aiready/aiready-report-20260314-161152.json +0 -235
- package/packages/pattern-detect/src/.aiready/aiready-report-20260314-161139.json +0 -224
- package/src/.aiready/aiready-report-20260312-103623.json +0 -32574
- package/src/.aiready/aiready-report-20260312-110843.json +0 -28740
- package/src/.aiready/aiready-report-20260312-110955.json +0 -28740
- package/src/.aiready/aiready-report-20260314-203209.json +0 -30713
- package/src/.aiready/aiready-report-20260314-203736.json +0 -30713
- package/src/.aiready/aiready-report-20260314-203857.json +0 -30713
- package/src/.aiready/aiready-report-20260314-204047.json +0 -30713
- package/src/.aiready/aiready-report-20260318-002110.json +0 -28782
- package/src/__tests__/cli.test.ts +0 -85
- package/src/__tests__/config-shape.test.ts +0 -105
- package/src/__tests__/unified.test.ts +0 -95
- package/src/cli.ts +0 -333
- package/src/commands/__tests__/agent-grounding.test.ts +0 -24
- package/src/commands/__tests__/ai-signal-clarity.test.ts +0 -32
- package/src/commands/__tests__/consistency.test.ts +0 -100
- package/src/commands/__tests__/deps-health.test.ts +0 -26
- package/src/commands/__tests__/doc-drift.test.ts +0 -26
- package/src/commands/__tests__/extra-commands.test.ts +0 -168
- package/src/commands/__tests__/init.test.ts +0 -51
- package/src/commands/__tests__/scan.test.ts +0 -153
- package/src/commands/__tests__/testability.test.ts +0 -36
- package/src/commands/__tests__/upload.test.ts +0 -50
- package/src/commands/__tests__/visualize.test.ts +0 -78
- package/src/commands/agent-grounding.ts +0 -62
- package/src/commands/ai-signal-clarity.ts +0 -1
- package/src/commands/bug.ts +0 -99
- package/src/commands/change-amplification.ts +0 -3
- package/src/commands/consistency.ts +0 -232
- package/src/commands/context.ts +0 -262
- package/src/commands/deps-health.ts +0 -1
- package/src/commands/doc-drift.ts +0 -1
- package/src/commands/index.ts +0 -20
- package/src/commands/init.ts +0 -199
- package/src/commands/patterns.ts +0 -222
- package/src/commands/report-formatter.ts +0 -267
- package/src/commands/scan.ts +0 -432
- package/src/commands/shared/configured-tool-action.ts +0 -35
- package/src/commands/shared/standard-tool-actions.ts +0 -126
- package/src/commands/testability.ts +0 -73
- package/src/commands/upload.ts +0 -129
- package/src/commands/visualize.ts +0 -321
- package/src/index.ts +0 -465
- package/src/utils/__tests__/helpers.test.ts +0 -35
- package/src/utils/helpers.ts +0 -234
- package/tsconfig.json +0 -11
- package/tsconfig.tsbuildinfo +0 -1
- package/vitest.config.ts +0 -13
package/CONTRIBUTING.md
CHANGED
|
@@ -39,15 +39,100 @@ The CLI follows a **hub-and-spoke** pattern:
|
|
|
39
39
|
- **Spoke integration**: Each analysis tool is independent and imported as needed
|
|
40
40
|
- **Unified interface**: Consistent CLI options across all tools
|
|
41
41
|
|
|
42
|
+
## � Development Setup
|
|
43
|
+
|
|
44
|
+
1. Clone the [monorepo](https://github.com/caopengau/aiready):
|
|
45
|
+
|
|
46
|
+
```bash
|
|
47
|
+
git clone https://github.com/caopengau/aiready.git
|
|
48
|
+
cd aiready
|
|
49
|
+
pnpm install
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
2. The CLI is located in `packages/cli/`
|
|
53
|
+
|
|
54
|
+
3. Build and develop:
|
|
55
|
+
|
|
56
|
+
```bash
|
|
57
|
+
# Build the CLI
|
|
58
|
+
pnpm build
|
|
59
|
+
|
|
60
|
+
# Watch mode for development
|
|
61
|
+
pnpm dev
|
|
62
|
+
|
|
63
|
+
# Run tests
|
|
64
|
+
pnpm test
|
|
65
|
+
|
|
66
|
+
# Run linter
|
|
67
|
+
pnpm lint
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
## 🔧 Making Changes
|
|
71
|
+
|
|
72
|
+
1. Create a feature branch from `main`:
|
|
73
|
+
|
|
74
|
+
```bash
|
|
75
|
+
git checkout -b feat/your-feature-name
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
2. Make your changes and write tests if applicable
|
|
79
|
+
|
|
80
|
+
3. Run tests and linter:
|
|
81
|
+
|
|
82
|
+
```bash
|
|
83
|
+
pnpm test
|
|
84
|
+
pnpm lint
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
4. Commit with [Conventional Commits](https://www.conventionalcommits.org/):
|
|
88
|
+
|
|
89
|
+
```bash
|
|
90
|
+
git commit -m "feat: add new feature"
|
|
91
|
+
git commit -m "fix: resolve issue"
|
|
92
|
+
git commit -m "docs: update guide"
|
|
93
|
+
```
|
|
94
|
+
|
|
95
|
+
5. Push to your fork and open a Pull Request
|
|
96
|
+
|
|
97
|
+
## 📋 Pull Request Guidelines
|
|
98
|
+
|
|
99
|
+
- Ensure all tests pass
|
|
100
|
+
- Update documentation if needed
|
|
101
|
+
- Link related issues
|
|
102
|
+
- Keep PRs focused on a single feature or fix
|
|
103
|
+
- Use clear, descriptive commit messages
|
|
104
|
+
|
|
105
|
+
## 📦 Publishing
|
|
106
|
+
|
|
107
|
+
Publishing is handled automatically via the monorepo's release process:
|
|
108
|
+
|
|
109
|
+
```bash
|
|
110
|
+
# From monorepo root
|
|
111
|
+
make sync # Syncs all spokes and publishes
|
|
112
|
+
make npm-publish SPOKE=cli # Publish CLI individually
|
|
113
|
+
```
|
|
114
|
+
|
|
115
|
+
For more details, see [Release Management](../../.github/sub-instructions/release-management.md)
|
|
116
|
+
|
|
42
117
|
## 🐛 Reporting Issues
|
|
43
118
|
|
|
44
|
-
Found a bug or have a feature request? [Open an issue](https://github.com/caopengau/aiready
|
|
119
|
+
Found a bug or have a feature request? [Open an issue on GitHub](https://github.com/caopengau/aiready/issues) with:
|
|
45
120
|
|
|
46
121
|
- Clear description of the problem or feature
|
|
47
122
|
- Steps to reproduce (for bugs)
|
|
48
123
|
- Expected vs actual behavior
|
|
49
124
|
- Your environment (Node version, OS)
|
|
50
125
|
|
|
126
|
+
## ❓ Questions?
|
|
127
|
+
|
|
128
|
+
- Review the [README.md](./README.md)
|
|
129
|
+
- Check [AIReady documentation](https://getaiready.dev/)
|
|
130
|
+
- Browse existing [discussions and issues](https://github.com/caopengau/aiready/discussions)
|
|
131
|
+
|
|
132
|
+
## 📄 License
|
|
133
|
+
|
|
134
|
+
All contributions are licensed under the MIT License.
|
|
135
|
+
|
|
51
136
|
## 🔧 Development Setup
|
|
52
137
|
|
|
53
138
|
```bash
|
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2024 AIReady Team
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aiready/cli",
|
|
3
|
-
"version": "0.14.
|
|
3
|
+
"version": "0.14.15",
|
|
4
4
|
"description": "Unified CLI for AIReady analysis tools",
|
|
5
5
|
"main": "./dist/index.js",
|
|
6
6
|
"module": "./dist/index.mjs",
|
|
@@ -8,20 +8,33 @@
|
|
|
8
8
|
"bin": {
|
|
9
9
|
"aiready": "./dist/cli.js"
|
|
10
10
|
},
|
|
11
|
+
"exports": {
|
|
12
|
+
".": {
|
|
13
|
+
"types": "./dist/index.d.ts",
|
|
14
|
+
"require": "./dist/index.js",
|
|
15
|
+
"import": "./dist/index.mjs"
|
|
16
|
+
}
|
|
17
|
+
},
|
|
18
|
+
"files": [
|
|
19
|
+
"dist",
|
|
20
|
+
"README.md",
|
|
21
|
+
"LICENSE",
|
|
22
|
+
"CONTRIBUTING.md"
|
|
23
|
+
],
|
|
11
24
|
"dependencies": {
|
|
12
25
|
"chalk": "^5.3.0",
|
|
13
26
|
"commander": "^14.0.0",
|
|
14
|
-
"@aiready/
|
|
15
|
-
"@aiready/
|
|
16
|
-
"@aiready/
|
|
17
|
-
"@aiready/
|
|
18
|
-
"@aiready/
|
|
19
|
-
"@aiready/
|
|
20
|
-
"@aiready/
|
|
21
|
-
"@aiready/
|
|
22
|
-
"@aiready/
|
|
23
|
-
"@aiready/
|
|
24
|
-
"@aiready/
|
|
27
|
+
"@aiready/agent-grounding": "0.13.12",
|
|
28
|
+
"@aiready/context-analyzer": "0.21.16",
|
|
29
|
+
"@aiready/consistency": "0.20.12",
|
|
30
|
+
"@aiready/core": "0.23.13",
|
|
31
|
+
"@aiready/deps": "0.13.13",
|
|
32
|
+
"@aiready/ai-signal-clarity": "0.13.13",
|
|
33
|
+
"@aiready/pattern-detect": "0.16.12",
|
|
34
|
+
"@aiready/doc-drift": "0.13.12",
|
|
35
|
+
"@aiready/visualizer": "0.6.12",
|
|
36
|
+
"@aiready/testability": "0.6.12",
|
|
37
|
+
"@aiready/change-amplification": "0.13.12"
|
|
25
38
|
},
|
|
26
39
|
"devDependencies": {
|
|
27
40
|
"@types/node": "^24.0.0",
|
|
@@ -33,7 +46,12 @@
|
|
|
33
46
|
"ai-readiness",
|
|
34
47
|
"code-analysis"
|
|
35
48
|
],
|
|
49
|
+
"author": "AIReady Team",
|
|
36
50
|
"license": "MIT",
|
|
51
|
+
"funding": {
|
|
52
|
+
"type": "github",
|
|
53
|
+
"url": "https://github.com/sponsors/caopengau"
|
|
54
|
+
},
|
|
37
55
|
"repository": {
|
|
38
56
|
"type": "git",
|
|
39
57
|
"url": "https://github.com/caopengau/aiready-cli.git"
|
|
@@ -42,6 +60,9 @@
|
|
|
42
60
|
"bugs": {
|
|
43
61
|
"url": "https://github.com/caopengau/aiready-cli/issues"
|
|
44
62
|
},
|
|
63
|
+
"engines": {
|
|
64
|
+
"node": ">=18.0.0"
|
|
65
|
+
},
|
|
45
66
|
"scripts": {
|
|
46
67
|
"build": "tsup src/index.ts src/cli.ts --format cjs,esm",
|
|
47
68
|
"dev": "tsup src/index.ts src/cli.ts --format cjs,esm --dts --watch",
|