@next-vibe/checker 3.0.6 → 3.0.7
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/AGENTS.md +11 -21
- package/README.md +22 -28
- package/bin/package-runtime.js.map +4 -4
- package/bin/vibe-check.js +5 -39
- package/package.json +3 -1
package/AGENTS.md
CHANGED
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
```sh
|
|
8
8
|
# ✅ CORRECT
|
|
9
|
-
bunx vibe-check
|
|
9
|
+
bunx vibe-check src/
|
|
10
10
|
|
|
11
11
|
# ❌ WRONG — never do these
|
|
12
12
|
npx tsc --noEmit
|
|
@@ -43,15 +43,13 @@ Then call MCP tool `check` directly — no shell needed.
|
|
|
43
43
|
## Run Checks
|
|
44
44
|
|
|
45
45
|
```sh
|
|
46
|
-
vibe-check
|
|
47
|
-
vibe-check
|
|
48
|
-
vibe-check
|
|
49
|
-
vibe-check
|
|
50
|
-
vibe-check c src/components src/utils # multiple paths
|
|
51
|
-
vibe-check c # check entire project (slow)
|
|
46
|
+
vibe-check src/ # check src/ directory (default: check tool)
|
|
47
|
+
vibe-check src/ --extensive # include test + generated files
|
|
48
|
+
vibe-check src/components src/utils # multiple paths
|
|
49
|
+
vibe-check # check entire project (slow)
|
|
52
50
|
```
|
|
53
51
|
|
|
54
|
-
**MCP**: `{ "paths": ["src/feature"]
|
|
52
|
+
**MCP**: `{ "paths": ["src/feature"] }`
|
|
55
53
|
|
|
56
54
|
## Performance (real measurements)
|
|
57
55
|
|
|
@@ -65,29 +63,23 @@ TypeScript uses incremental builds (`tsbuildinfo`). First run is slow; subsequen
|
|
|
65
63
|
|
|
66
64
|
## Workflow
|
|
67
65
|
|
|
68
|
-
**
|
|
66
|
+
**Check during development:**
|
|
69
67
|
|
|
70
68
|
```sh
|
|
71
|
-
vibe-check
|
|
69
|
+
vibe-check src/feature
|
|
72
70
|
```
|
|
73
71
|
|
|
74
72
|
**Full check before committing:**
|
|
75
73
|
|
|
76
74
|
```sh
|
|
77
|
-
vibe-check
|
|
78
|
-
```
|
|
79
|
-
|
|
80
|
-
**Fix everything then verify:**
|
|
81
|
-
|
|
82
|
-
```sh
|
|
83
|
-
vibe-check c src/ --fix && vibe-check c src/
|
|
75
|
+
vibe-check src/
|
|
84
76
|
```
|
|
85
77
|
|
|
86
78
|
**First run in a new project (no check.config.ts):**
|
|
87
79
|
|
|
88
80
|
```sh
|
|
89
|
-
vibe-check config
|
|
90
|
-
vibe-check
|
|
81
|
+
vibe-check config # interactive setup wizard
|
|
82
|
+
vibe-check src/ # run full check
|
|
91
83
|
```
|
|
92
84
|
|
|
93
85
|
## Create Configuration
|
|
@@ -140,13 +132,11 @@ import type { CheckConfig } from "@next-vibe/checker/system/check/config/types";
|
|
|
140
132
|
|
|
141
133
|
const config = (): CheckConfig => ({
|
|
142
134
|
vibeCheck: {
|
|
143
|
-
fix: true,
|
|
144
135
|
extensive: false,
|
|
145
136
|
limit: 20000,
|
|
146
137
|
mcpLimit: 20, // compact output for MCP/AI consumption
|
|
147
138
|
skipEslint: false, // skip ESLint (faster, less thorough)
|
|
148
139
|
skipOxlint: false,
|
|
149
|
-
skipTypecheck: false,
|
|
150
140
|
},
|
|
151
141
|
oxlint: {
|
|
152
142
|
enabled: true,
|
package/README.md
CHANGED
|
@@ -62,7 +62,7 @@ Help me set up @next-vibe/checker for this project.
|
|
|
62
62
|
- Count .ts/.tsx files in src/
|
|
63
63
|
|
|
64
64
|
2. Install:
|
|
65
|
-
bun add -D @next-vibe/checker oxlint eslint typescript \
|
|
65
|
+
bun add -D @next-vibe/checker oxlint oxfmt @typescript/native-preview eslint typescript \
|
|
66
66
|
eslint-plugin-react-compiler eslint-plugin-react-hooks \
|
|
67
67
|
eslint-plugin-simple-import-sort typescript-eslint
|
|
68
68
|
|
|
@@ -70,18 +70,15 @@ Help me set up @next-vibe/checker for this project.
|
|
|
70
70
|
bunx vibe-check config
|
|
71
71
|
(Answer based on my stack: React? Next.js? i18n? strict types?)
|
|
72
72
|
|
|
73
|
-
4. Run a full check
|
|
74
|
-
bunx vibe-check
|
|
73
|
+
4. Run a full check and show me ALL issues:
|
|
74
|
+
bunx vibe-check src/
|
|
75
75
|
|
|
76
76
|
5. Ask me:
|
|
77
77
|
- How many issues? Are they real problems or noise?
|
|
78
78
|
- Should we enable --extensive to also check test/generated files?
|
|
79
79
|
- Enable strict mode (no throw, no any, no unknown)?
|
|
80
80
|
|
|
81
|
-
6.
|
|
82
|
-
bunx vibe-check c src/ --fix
|
|
83
|
-
|
|
84
|
-
7. Add MCP server to .mcp.json so you can run checks from this chat:
|
|
81
|
+
6. Add MCP server to .mcp.json so you can run checks from this chat:
|
|
85
82
|
{
|
|
86
83
|
"mcpServers": {
|
|
87
84
|
"vibe-check": {
|
|
@@ -92,7 +89,7 @@ Help me set up @next-vibe/checker for this project.
|
|
|
92
89
|
}
|
|
93
90
|
}
|
|
94
91
|
|
|
95
|
-
|
|
92
|
+
7. If I had biome/standalone eslint configs, remove them.
|
|
96
93
|
|
|
97
94
|
My project: [INSERT ABSOLUTE PATH]
|
|
98
95
|
Package manager: [bun / npm / pnpm]
|
|
@@ -102,7 +99,7 @@ Package manager: [bun / npm / pnpm]
|
|
|
102
99
|
|
|
103
100
|
```sh
|
|
104
101
|
# 1. Install
|
|
105
|
-
bun add -D @next-vibe/checker oxlint eslint typescript \
|
|
102
|
+
bun add -D @next-vibe/checker oxlint oxfmt @typescript/native-preview eslint typescript \
|
|
106
103
|
eslint-plugin-react-compiler eslint-plugin-react-hooks \
|
|
107
104
|
eslint-plugin-simple-import-sort typescript-eslint
|
|
108
105
|
|
|
@@ -124,31 +121,29 @@ npm install -D @next-vibe/checker
|
|
|
124
121
|
### Peer Dependencies
|
|
125
122
|
|
|
126
123
|
```sh
|
|
127
|
-
bun add -D oxlint eslint typescript \
|
|
124
|
+
bun add -D oxlint oxfmt @typescript/native-preview eslint typescript \
|
|
128
125
|
eslint-plugin-react-compiler \
|
|
129
126
|
eslint-plugin-react-hooks \
|
|
130
127
|
eslint-plugin-simple-import-sort \
|
|
131
128
|
typescript-eslint
|
|
132
129
|
```
|
|
133
130
|
|
|
134
|
-
| Package | Version | Purpose
|
|
135
|
-
|
|
136
|
-
| `oxlint` | `>=1.0.0` | Fast Rust-based linter
|
|
137
|
-
| `
|
|
138
|
-
| `
|
|
139
|
-
| `
|
|
140
|
-
| `eslint-plugin-react-
|
|
141
|
-
| `eslint-plugin-
|
|
142
|
-
| `
|
|
131
|
+
| Package | Version | Purpose |
|
|
132
|
+
|------------------------------------|------------|----------------------------------------|
|
|
133
|
+
| `oxlint` | `>=1.0.0` | Fast Rust-based linter |
|
|
134
|
+
| `oxfmt` | `>=0.40.0` | Formatter (runs automatically on save) |
|
|
135
|
+
| `eslint` | `>=9.0.0` | Import sorting, React hooks |
|
|
136
|
+
| `typescript` | `>=5.0.0` | Type checking |
|
|
137
|
+
| `eslint-plugin-react-compiler` | `>=19.0.0` | React compiler rules |
|
|
138
|
+
| `eslint-plugin-react-hooks` | `>=5.0.0` | React hooks rules |
|
|
139
|
+
| `eslint-plugin-simple-import-sort` | `>=12.0.0` | Import sorting |
|
|
140
|
+
| `typescript-eslint` | `>=8.0.0` | TypeScript ESLint parser |
|
|
141
|
+
| `@typescript/native-preview` | `>=7.0.0` | Native TypeScript checker (`tsgo`, 10× faster than tsc) |
|
|
143
142
|
|
|
144
143
|
## CLI Reference
|
|
145
144
|
|
|
146
145
|
```sh
|
|
147
146
|
vibe-check [paths...] # Run all checks (oxlint + ESLint + TypeScript)
|
|
148
|
-
vibe-check --fix # Auto-fix linting issues
|
|
149
|
-
vibe-check --skip-eslint # Skip ESLint (faster)
|
|
150
|
-
vibe-check --skip-oxlint # Skip oxlint
|
|
151
|
-
vibe-check --skip-typecheck # Skip TypeScript type checking
|
|
152
147
|
vibe-check --extensive # Include test/generated files
|
|
153
148
|
vibe-check --timeout=60 # Timeout in seconds (default: 3600)
|
|
154
149
|
vibe-check --limit=100 # Max issues to display (default: 20000)
|
|
@@ -166,13 +161,12 @@ import type { CheckConfig } from "@next-vibe/checker/system/check/config/types";
|
|
|
166
161
|
|
|
167
162
|
const config = (): CheckConfig => ({
|
|
168
163
|
vibeCheck: {
|
|
169
|
-
fix: true,
|
|
170
164
|
timeout: 3600,
|
|
171
165
|
limit: 20000,
|
|
172
166
|
mcpLimit: 20, // compact output for AI/MCP consumption
|
|
173
167
|
extensive: false, // true to include test/generated files
|
|
174
168
|
skipEslint: false, // skip ESLint for maximum speed
|
|
175
|
-
|
|
169
|
+
skipOxlint: false,
|
|
176
170
|
},
|
|
177
171
|
oxlint: {
|
|
178
172
|
enabled: true,
|
|
@@ -213,7 +207,7 @@ export default config;
|
|
|
213
207
|
| `jsxCapitalization` | `false` | Enforce uppercase JSX component names |
|
|
214
208
|
| `pedantic` | `false` | Stricter style rules |
|
|
215
209
|
| `restrictedSyntax` | `true` | Ban `throw`, `unknown`, bare `object` types |
|
|
216
|
-
| `tsgo` | `false` | Use tsgo (faster
|
|
210
|
+
| `tsgo` | `false` | Use `tsgo` native TS checker (10× faster, requires `@typescript/native-preview`) |
|
|
217
211
|
|
|
218
212
|
### Custom Oxlint Plugins
|
|
219
213
|
|
|
@@ -234,12 +228,12 @@ Set `vscode.enabled: true` and `vscode.autoGenerateSettings: true`. On each run,
|
|
|
234
228
|
```sh
|
|
235
229
|
bun remove @biomejs/biome
|
|
236
230
|
|
|
237
|
-
bun add -D @next-vibe/checker oxlint eslint typescript \
|
|
231
|
+
bun add -D @next-vibe/checker oxlint oxfmt eslint typescript \
|
|
238
232
|
eslint-plugin-react-compiler eslint-plugin-react-hooks \
|
|
239
233
|
eslint-plugin-simple-import-sort typescript-eslint
|
|
240
234
|
|
|
241
235
|
bunx vibe-check config # say 'no' to i18n/jsx-cap unless needed
|
|
242
|
-
bunx vibe-check
|
|
236
|
+
bunx vibe-check src/
|
|
243
237
|
```
|
|
244
238
|
|
|
245
239
|
## Source
|