@vibe-agent-toolkit/utils 0.2.0-rc.7 → 0.2.0-rc.8
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/README.md +22 -3
- package/dist/asset-reference.js +3 -11
- package/dist/asset-reference.js.map +1 -1
- package/dist/crawl-timing.d.ts +3 -3
- package/dist/crawl-timing.js +3 -3
- package/dist/dirent-kind.d.ts +83 -0
- package/dist/dirent-kind.d.ts.map +1 -0
- package/dist/dirent-kind.js +129 -0
- package/dist/dirent-kind.js.map +1 -0
- package/dist/errors/errno.d.ts +51 -0
- package/dist/errors/errno.d.ts.map +1 -0
- package/dist/errors/errno.js +112 -0
- package/dist/errors/errno.js.map +1 -0
- package/dist/errors/vat-error.d.ts +60 -0
- package/dist/errors/vat-error.d.ts.map +1 -0
- package/dist/errors/vat-error.js +86 -0
- package/dist/errors/vat-error.js.map +1 -0
- package/dist/file-crawler.js +9 -9
- package/dist/file-crawler.js.map +1 -1
- package/dist/fs/file-hash.d.ts.map +1 -1
- package/dist/fs/file-hash.js +0 -1
- package/dist/fs/file-hash.js.map +1 -1
- package/dist/fs-utils.d.ts +16 -18
- package/dist/fs-utils.d.ts.map +1 -1
- package/dist/fs-utils.js +56 -80
- package/dist/fs-utils.js.map +1 -1
- package/dist/fs.d.ts +2 -1
- package/dist/fs.d.ts.map +1 -1
- package/dist/fs.js +2 -1
- package/dist/fs.js.map +1 -1
- package/dist/git-run.d.ts +1 -1
- package/dist/git-run.js +1 -1
- package/dist/git-tracker.d.ts +1 -1
- package/dist/git-tracker.d.ts.map +1 -1
- package/dist/git-tracker.js +1 -2
- package/dist/git-tracker.js.map +1 -1
- package/dist/git-utils.d.ts.map +1 -1
- package/dist/git-utils.js +0 -1
- package/dist/git-utils.js.map +1 -1
- package/dist/gitignore-checker.d.ts.map +1 -1
- package/dist/gitignore-checker.js +9 -3
- package/dist/gitignore-checker.js.map +1 -1
- package/dist/index.d.ts +7 -3
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +19 -4
- package/dist/index.js.map +1 -1
- package/dist/listing-refusal.d.ts +2 -1
- package/dist/listing-refusal.d.ts.map +1 -1
- package/dist/listing-refusal.js +3 -3
- package/dist/listing-refusal.js.map +1 -1
- package/dist/path-containment.d.ts +64 -0
- package/dist/path-containment.d.ts.map +1 -0
- package/dist/path-containment.js +111 -0
- package/dist/path-containment.js.map +1 -0
- package/dist/path-core.d.ts +77 -3
- package/dist/path-core.d.ts.map +1 -1
- package/dist/path-core.js +96 -6
- package/dist/path-core.js.map +1 -1
- package/dist/path-utils.d.ts.map +1 -1
- package/dist/path-utils.js +42 -47
- package/dist/path-utils.js.map +1 -1
- package/dist/path.d.ts +1 -1
- package/dist/path.d.ts.map +1 -1
- package/dist/path.js +1 -1
- package/dist/path.js.map +1 -1
- package/dist/project-utils.d.ts.map +1 -1
- package/dist/project-utils.js +9 -6
- package/dist/project-utils.js.map +1 -1
- package/dist/safe-exec.d.ts +2 -1
- package/dist/safe-exec.d.ts.map +1 -1
- package/dist/safe-exec.js +25 -7
- package/dist/safe-exec.js.map +1 -1
- package/dist/skill-targets.d.ts +2 -2
- package/dist/skill-targets.js +2 -2
- package/dist/skill-test/auth-resolver.d.ts +10 -2
- package/dist/skill-test/auth-resolver.d.ts.map +1 -1
- package/dist/skill-test/auth-resolver.js +26 -11
- package/dist/skill-test/auth-resolver.js.map +1 -1
- package/dist/skill-test/spawn-claude.d.ts +2 -1
- package/dist/skill-test/spawn-claude.d.ts.map +1 -1
- package/dist/skill-test/spawn-claude.js +20 -3
- package/dist/skill-test/spawn-claude.js.map +1 -1
- package/dist/skill-test/transcript.d.ts.map +1 -1
- package/dist/skill-test/transcript.js +18 -17
- package/dist/skill-test/transcript.js.map +1 -1
- package/dist/stdio-blocking.js +13 -14
- package/dist/stdio-blocking.js.map +1 -1
- package/dist/test-helpers.d.ts +47 -204
- package/dist/test-helpers.d.ts.map +1 -1
- package/dist/test-helpers.js +105 -310
- package/dist/test-helpers.js.map +1 -1
- package/dist/testing/executables.d.ts +32 -0
- package/dist/testing/executables.d.ts.map +1 -0
- package/dist/testing/executables.js +70 -0
- package/dist/testing/executables.js.map +1 -0
- package/dist/testing/hostile-tree.d.ts +79 -0
- package/dist/testing/hostile-tree.d.ts.map +1 -0
- package/dist/testing/hostile-tree.js +164 -0
- package/dist/testing/hostile-tree.js.map +1 -0
- package/dist/testing/platform-gates.d.ts +31 -0
- package/dist/testing/platform-gates.d.ts.map +1 -0
- package/dist/testing/platform-gates.js +31 -0
- package/dist/testing/platform-gates.js.map +1 -0
- package/dist/testing/temp-dir.d.ts +255 -0
- package/dist/testing/temp-dir.d.ts.map +1 -0
- package/dist/testing/temp-dir.js +363 -0
- package/dist/testing/temp-dir.js.map +1 -0
- package/dist/testing.d.ts +5 -0
- package/dist/testing.d.ts.map +1 -1
- package/dist/testing.js +10 -1
- package/dist/testing.js.map +1 -1
- package/dist/text-content.d.ts.map +1 -1
- package/dist/text-content.js +7 -1
- package/dist/text-content.js.map +1 -1
- package/dist/text-file.d.ts.map +1 -1
- package/dist/text-file.js +0 -2
- package/dist/text-file.js.map +1 -1
- package/dist/timing-dump.d.ts +1 -1
- package/dist/timing-dump.d.ts.map +1 -1
- package/dist/timing-dump.js +1 -2
- package/dist/timing-dump.js.map +1 -1
- package/dist/windows-shell.d.ts +0 -1
- package/dist/windows-shell.d.ts.map +1 -1
- package/dist/windows-shell.js +0 -1
- package/dist/windows-shell.js.map +1 -1
- package/dist/zod-introspection.js +2 -2
- package/dist/zod-introspection.js.map +1 -1
- package/eslint/README.md +125 -67
- package/eslint/index.cjs +111 -162
- package/eslint/index.d.cts +14 -17
- package/eslint/rules/callee-name.cjs +23 -0
- package/eslint/rules/commands-import-boundary.cjs +148 -0
- package/eslint/rules/dead-import.cjs +1 -1
- package/eslint/rules/dirent-type-needs-symlink-check.cjs +282 -0
- package/eslint/rules/eslint-rule-factory.cjs +5 -2
- package/eslint/rules/exempt-path-matcher.cjs +1 -1
- package/eslint/rules/explicit-zod-strictness.cjs +120 -0
- package/eslint/rules/no-bare-dynamic-import-path.cjs +5 -1
- package/eslint/rules/no-bare-executable-spawn.cjs +70 -0
- package/eslint/rules/no-bare-symlink-in-tests.cjs +16 -3
- package/eslint/rules/no-blind-catch.cjs +171 -0
- package/eslint/rules/no-child-process-execSync.cjs +8 -0
- package/eslint/rules/no-decaying-referent.cjs +216 -0
- package/eslint/rules/no-dotdot-containment.cjs +160 -0
- package/eslint/rules/no-file-url-string-concat.cjs +4 -1
- package/eslint/rules/no-fragile-entrypoint-guard.cjs +14 -1
- package/eslint/rules/no-fs-mkdirSync.cjs +8 -0
- package/eslint/rules/no-fs-promises-cp.cjs +7 -0
- package/eslint/rules/no-fs-realpathSync.cjs +8 -0
- package/eslint/rules/no-hardcoded-path-split.cjs +7 -2
- package/eslint/rules/no-io-in-unit-tier.cjs +128 -0
- package/eslint/rules/no-literal-process-exit.cjs +129 -0
- package/eslint/rules/no-manual-path-normalize.cjs +7 -2
- package/eslint/rules/no-os-tmpdir.cjs +8 -0
- package/eslint/rules/no-path-operations-in-comparisons.cjs +7 -2
- package/eslint/rules/no-path-sep-in-strings.cjs +7 -2
- package/eslint/rules/no-path-startswith.cjs +7 -2
- package/eslint/rules/no-process-exit-in-phase.cjs +12 -2
- package/eslint/rules/no-raw-node-path.cjs +563 -0
- package/eslint/rules/no-raw-text-decode.cjs +10 -1
- package/eslint/rules/no-registry-count-pin.cjs +255 -0
- package/eslint/rules/no-self-package-import.cjs +13 -2
- package/eslint/rules/no-test-scoped-functions.cjs +10 -3
- package/eslint/rules/no-unix-shell-commands.cjs +6 -2
- package/eslint/rules/no-unsafe-root-join.cjs +23 -2
- package/eslint/rules/no-url-pathname-for-fs.cjs +5 -1
- package/eslint/rules/no-version-literal.cjs +151 -0
- package/eslint/rules/prefer-startswith-over-regex.cjs +9 -0
- package/eslint/rules/require-justified-skip.cjs +8 -2
- package/eslint/rules/safe-import.cjs +1 -1
- package/package.json +4 -9
- package/eslint/rules/no-path-join.cjs +0 -14
- package/eslint/rules/no-path-relative.cjs +0 -14
- package/eslint/rules/no-path-resolve.cjs +0 -14
- package/eslint/rules/path-function-rule-factory.cjs +0 -496
package/eslint/index.cjs
CHANGED
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
* than in CI on a different OS.
|
|
10
10
|
*
|
|
11
11
|
* They ship as a SUBPATH rather than a separate package because an ESLint plugin
|
|
12
|
-
* is data, not code that runs: every module
|
|
12
|
+
* is data, not code that runs: every rule module exports a plain rule object and
|
|
13
13
|
* none of them `require('eslint')`. So this entry resolves — and the other twelve
|
|
14
14
|
* subpaths keep resolving — whether or not ESLint is installed, which is why
|
|
15
15
|
* `eslint` is declared as an OPTIONAL peer dependency. One install, one version,
|
|
@@ -20,6 +20,28 @@
|
|
|
20
20
|
* entry point can be both `require()`d from an `eslint.config.cjs` and `import`ed
|
|
21
21
|
* from an `eslint.config.js`/`.mjs`.
|
|
22
22
|
*
|
|
23
|
+
* ## The manifest is the directory
|
|
24
|
+
*
|
|
25
|
+
* There is no hand-maintained list of rules here. Every `rules/*.cjs` whose
|
|
26
|
+
* export carries a `meta` object IS a rule, keyed by its basename; the modules
|
|
27
|
+
* that export a factory or a helper object (`eslint-rule-factory`,
|
|
28
|
+
* `no-command-direct-factory`, `exempt-path-matcher`, `safe-import`,
|
|
29
|
+
* `dead-import`) have no `meta` and are skipped. Each rule then declares its own
|
|
30
|
+
* place in `configs.recommended` through `meta.docs.recommended` and
|
|
31
|
+
* `meta.docs.recommendedSeverity`, beside the rule it describes — so adding a
|
|
32
|
+
* rule is one file, and the README/docs table is generated from the same
|
|
33
|
+
* metadata (`bun run generate:eslint-rules-doc` in `packages/utils`).
|
|
34
|
+
*
|
|
35
|
+
* The last hand list here held 27 entries and was mirrored by three literal
|
|
36
|
+
* counts in two test files and two prose counts in two docs, every one of which
|
|
37
|
+
* had drifted at least once. A directory listing cannot drift.
|
|
38
|
+
*
|
|
39
|
+
* `node:fs` and `node:path` are the ONLY external modules this subpath reaches,
|
|
40
|
+
* and only from this file: the rule modules themselves still require nothing —
|
|
41
|
+
* `test/eslint/subpath-purity.test.ts` pins both halves. Two builtins that ship
|
|
42
|
+
* with every Node install do not change the optional-peer property, which was
|
|
43
|
+
* only ever about `eslint` and third-party packages.
|
|
44
|
+
*
|
|
23
45
|
* Rules whose exemptions name a file (the ONE implementation file allowed to call
|
|
24
46
|
* the primitive) take an `exemptFiles` option — see README.md. The shipped
|
|
25
47
|
* defaults are EMPTY: an exemption is a claim about a specific repo's layout, and
|
|
@@ -29,174 +51,75 @@
|
|
|
29
51
|
|
|
30
52
|
'use strict';
|
|
31
53
|
|
|
32
|
-
const
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
'no-unix-shell-commands': require('./rules/no-unix-shell-commands.cjs'),
|
|
37
|
-
'no-os-tmpdir': require('./rules/no-os-tmpdir.cjs'),
|
|
38
|
-
'no-fs-mkdirSync': require('./rules/no-fs-mkdirSync.cjs'),
|
|
39
|
-
'no-fs-realpathSync': require('./rules/no-fs-realpathSync.cjs'),
|
|
40
|
-
'no-manual-path-normalize': require('./rules/no-manual-path-normalize.cjs'),
|
|
41
|
-
'no-path-sep-in-strings': require('./rules/no-path-sep-in-strings.cjs'),
|
|
42
|
-
'no-path-operations-in-comparisons': require('./rules/no-path-operations-in-comparisons.cjs'),
|
|
43
|
-
'no-path-join': require('./rules/no-path-join.cjs'),
|
|
44
|
-
'no-path-resolve': require('./rules/no-path-resolve.cjs'),
|
|
45
|
-
'no-path-relative': require('./rules/no-path-relative.cjs'),
|
|
46
|
-
'no-test-scoped-functions': require('./rules/no-test-scoped-functions.cjs'),
|
|
47
|
-
'no-fs-promises-cp': require('./rules/no-fs-promises-cp.cjs'),
|
|
48
|
-
'no-url-pathname-for-fs': require('./rules/no-url-pathname-for-fs.cjs'),
|
|
49
|
-
'no-bare-dynamic-import-path': require('./rules/no-bare-dynamic-import-path.cjs'),
|
|
50
|
-
'no-file-url-string-concat': require('./rules/no-file-url-string-concat.cjs'),
|
|
51
|
-
'prefer-startswith-over-regex': require('./rules/prefer-startswith-over-regex.cjs'),
|
|
52
|
-
'no-unsafe-root-join': require('./rules/no-unsafe-root-join.cjs'),
|
|
53
|
-
'no-raw-text-decode': require('./rules/no-raw-text-decode.cjs'),
|
|
54
|
-
'no-self-package-import': require('./rules/no-self-package-import.cjs'),
|
|
55
|
-
'require-justified-skip': require('./rules/require-justified-skip.cjs'),
|
|
56
|
-
'no-bare-symlink-in-tests': require('./rules/no-bare-symlink-in-tests.cjs'),
|
|
57
|
-
'no-process-exit-in-phase': require('./rules/no-process-exit-in-phase.cjs'),
|
|
58
|
-
'no-fragile-entrypoint-guard': require('./rules/no-fragile-entrypoint-guard.cjs'),
|
|
59
|
-
};
|
|
54
|
+
const { readdirSync } = require('node:fs');
|
|
55
|
+
const path = require('node:path');
|
|
56
|
+
|
|
57
|
+
const RULES_DIR = path.join(__dirname, 'rules');
|
|
60
58
|
|
|
61
59
|
/**
|
|
62
|
-
*
|
|
63
|
-
*
|
|
64
|
-
*
|
|
65
|
-
* that
|
|
66
|
-
* write tests. The two below are neither — they encode a position on TEST STYLE:
|
|
67
|
-
*
|
|
68
|
-
* - `require-justified-skip` — a specific annotation grammar (`SKIP(#123): reason`)
|
|
69
|
-
* for a disabled test, plus a view on what counts as a tautological assertion.
|
|
70
|
-
* - `no-test-scoped-functions` — a view on WHERE a test helper may be declared
|
|
71
|
-
* (module scope, never inside `describe`/`it`).
|
|
72
|
-
*
|
|
73
|
-
* Someone installing this package for `safePath.join()` should not silently
|
|
74
|
-
* inherit either. Both ship in `rules` and stay enabled explicitly:
|
|
75
|
-
*
|
|
76
|
-
* '@vibe-agent-toolkit/require-justified-skip': 'error',
|
|
77
|
-
*
|
|
78
|
-
* That is exactly what VAT's own `eslint.config.js` does — it does not consume
|
|
79
|
-
* `configs.recommended` at all, so this exclusion changes nothing about how this
|
|
80
|
-
* repo lints itself.
|
|
60
|
+
* The two values `recommendedSeverity` may take. A rule that is not
|
|
61
|
+
* recommended may still declare one — it is the severity the rule WOULD ride
|
|
62
|
+
* at, and the generated docs table prints it — but `off` is not a spelling: a
|
|
63
|
+
* rule that wants to be off is a rule with `recommended: false`.
|
|
81
64
|
*/
|
|
82
|
-
const
|
|
83
|
-
'require-justified-skip',
|
|
84
|
-
'no-test-scoped-functions',
|
|
85
|
-
// Excluded for a DIFFERENT reason than the two above: not a style opinion, but
|
|
86
|
-
// an unsound heuristic. It keys on whether an identifier's name ends in `root`
|
|
87
|
-
// rather than on whether any segment is caller-controlled, which makes it
|
|
88
|
-
// simultaneously noisy and blind. Measured on a 4,670-file adopter tree: 108
|
|
89
|
-
// findings, 0 autofixable, and every one of these verified by execution here:
|
|
90
|
-
//
|
|
91
|
-
// FIRES safePath.join(repoRoot, 'docs', 'product') <- all literals, cannot escape
|
|
92
|
-
// FIRES safePath.resolve(packageRoot, '..', '..') <- escaping IS the intent; the fix breaks it
|
|
93
|
-
// FIRES safePath.join(repoRoot) <- one argument, no segment at all
|
|
94
|
-
// silent safePath.join(base, userInput) <- THE dangerous shape, missed
|
|
95
|
-
//
|
|
96
|
-
// A rule that misses the case it exists to catch must not ride in a config
|
|
97
|
-
// named `recommended` at any severity — a safety core that cries wolf teaches
|
|
98
|
-
// people to ignore it, which costs the true positives too. It still ships, and
|
|
99
|
-
// it still earns `error` where scoped to directories in which a path escape is
|
|
100
|
-
// a security boundary (this repo scopes it to the skill-test staging code).
|
|
101
|
-
// Re-include it when it keys on taint rather than on naming.
|
|
102
|
-
'no-unsafe-root-join',
|
|
103
|
-
// Excluded because it names a seam that does not exist until a consumer builds
|
|
104
|
-
// one. `decodeTextContent()` is VAT's module, in VAT's repo; an adopter who
|
|
105
|
-
// installed this package for `safePath.join()` has no content-decoding seam to
|
|
106
|
-
// be pointed at, so `recommended` would hand them a rule whose every message
|
|
107
|
-
// advises importing from `your content-decoding module`. It ships in `rules`
|
|
108
|
-
// and is enabled — with `safeModule` naming the real seam and `exemptFiles`
|
|
109
|
-
// naming the file that implements it — by whoever has one. VAT itself does
|
|
110
|
-
// exactly that, scoped to the directories that read corpus documents.
|
|
111
|
-
'no-raw-text-decode',
|
|
112
|
-
// Excluded for two reasons, either of which would be enough. It REQUIRES a
|
|
113
|
-
// `packageName` option — it will not read a `package.json` to find out, because
|
|
114
|
-
// that would mean `require('node:fs')` and break the empty-external-set property
|
|
115
|
-
// this whole subpath rests on — and a rule with a required option cannot ride in
|
|
116
|
-
// a config that supplies none. And the directories it must not fire in are a
|
|
117
|
-
// property of the adopter's `tsconfig`, not of this package: a self-import only
|
|
118
|
-
// breaks the build in files the package actually COMPILES, while test and
|
|
119
|
-
// example trees import their own package by name on purpose, to exercise the
|
|
120
|
-
// public entry point the way a consumer does. This repo has ~10 such imports
|
|
121
|
-
// across `utils`, `agent-skills`, `claude-marketplace` and
|
|
122
|
-
// `vat-example-cat-agents`, every one of them correct. It ships in `rules`, and
|
|
123
|
-
// `eslint.config.js` generates one scoped block per workspace package.
|
|
124
|
-
'no-self-package-import',
|
|
125
|
-
// Excluded for its TEST half only, which is the honest way to say it. That
|
|
126
|
-
// half names a vitest-specific idiom (`skip()` from the per-test context) and
|
|
127
|
-
// a replacement — `createSymlink()` / `createSymlinkAsync()` /
|
|
128
|
-
// `symlinkCapability()` — living on THIS package's own `./testing` subpath
|
|
129
|
-
// rather than on a seam every consumer already has. An adopter using a
|
|
130
|
-
// different test runner, or no symlink-heavy tests at all, should not
|
|
131
|
-
// silently inherit an opinion about vitest control flow.
|
|
132
|
-
//
|
|
133
|
-
// ⚠️ The rule now covers SHIPPED code too, and that half (`unguardedSymlink`)
|
|
134
|
-
// has neither dependency: it names the Windows privilege and a junction, both
|
|
135
|
-
// portable facts. So this exclusion is weaker than it reads — the two halves
|
|
136
|
-
// share one rule id and cannot be enabled separately, and the test half is
|
|
137
|
-
// what keeps the pair out. Splitting the rule would let the production half
|
|
138
|
-
// ride in `recommended`; that is a public-API change and has not been made.
|
|
139
|
-
// VAT enables the whole rule explicitly, scoped to its own conventions.
|
|
140
|
-
'no-bare-symlink-in-tests',
|
|
141
|
-
// Excluded because it keys on a NAMING CONVENTION that is VAT's, not a
|
|
142
|
-
// portable fact — the same reason `no-unsafe-root-join` is excluded above. The
|
|
143
|
-
// hazard it guards is real and general (an in-process orchestrator whose step
|
|
144
|
-
// calls `process.exit()` silently skips every later step), but the marker is
|
|
145
|
-
// the `…Phase` suffix, and an adopter with an unrelated `computeRenderPhase()`
|
|
146
|
-
// that legitimately exits would get a finding they cannot act on. It ships in
|
|
147
|
-
// `rules` and VAT enables it explicitly, scoped to its own orchestrators.
|
|
148
|
-
'no-process-exit-in-phase',
|
|
149
|
-
// Excluded because ONE of its two halves is a claim about the CONSUMER's Node
|
|
150
|
-
// floor rather than a portable fact. `import.meta.main` shipped in Node 24.2 /
|
|
151
|
-
// 22.18; an adopter whose floor is at or above that writes it correctly and
|
|
152
|
-
// would get a finding they cannot act on. This package's own floor is `>=22`,
|
|
153
|
-
// which spans 22.13–22.17 where the property is `undefined` — so the hazard is
|
|
154
|
-
// real for some adopters and absent for others, and only they know which.
|
|
155
|
-
//
|
|
156
|
-
// The rule's OTHER half (`rawEntrypointCompare`) has no such dependency: a raw
|
|
157
|
-
// string compare against `pathToFileURL(argv[1]).href` misses a symlinked
|
|
158
|
-
// entry on every Node there has ever been. The two share one rule id and
|
|
159
|
-
// cannot be enabled separately, and the floor-dependent half is what keeps the
|
|
160
|
-
// pair out — the same trade already recorded for `no-bare-symlink-in-tests`.
|
|
161
|
-
// VAT enables the whole rule explicitly, because VAT's floor is 22.13.0.
|
|
162
|
-
'no-fragile-entrypoint-guard',
|
|
163
|
-
]);
|
|
65
|
+
const RECOMMENDED_SEVERITIES = new Set(['error', 'warn']);
|
|
164
66
|
|
|
165
67
|
/**
|
|
166
|
-
*
|
|
167
|
-
*
|
|
168
|
-
* `
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
68
|
+
* Read a rule's `meta.docs` and refuse anything a rule in this pack must not ship
|
|
69
|
+
* without. Thrown at load time, so a malformed rule fails every consumer's
|
|
70
|
+
* `eslint` run at startup rather than silently landing outside `recommended`.
|
|
71
|
+
*/
|
|
72
|
+
function validateRuleDocs(name, rule) {
|
|
73
|
+
if (typeof rule.create !== 'function') {
|
|
74
|
+
throw new TypeError(`eslint rule '${name}' exports a meta but no create function`);
|
|
75
|
+
}
|
|
76
|
+
const docs = rule.meta.docs;
|
|
77
|
+
if (typeof docs?.description !== 'string' || docs.description.length === 0) {
|
|
78
|
+
throw new TypeError(`eslint rule '${name}' has no meta.docs.description`);
|
|
79
|
+
}
|
|
80
|
+
if (typeof docs.recommended !== 'boolean') {
|
|
81
|
+
throw new TypeError(`eslint rule '${name}' must declare meta.docs.recommended as a boolean`);
|
|
82
|
+
}
|
|
83
|
+
if (docs.recommendedSeverity !== undefined && !RECOMMENDED_SEVERITIES.has(docs.recommendedSeverity)) {
|
|
84
|
+
throw new TypeError(`eslint rule '${name}' declares meta.docs.recommendedSeverity outside 'error' | 'warn'`);
|
|
85
|
+
}
|
|
86
|
+
if (docs.recommended && docs.recommendedSeverity === undefined) {
|
|
87
|
+
throw new TypeError(`eslint rule '${name}' is recommended but declares no meta.docs.recommendedSeverity`);
|
|
88
|
+
}
|
|
89
|
+
}
|
|
90
|
+
|
|
91
|
+
/**
|
|
92
|
+
* Every rule module under `rules/`, keyed by basename, in directory order
|
|
93
|
+
* (which `readdirSync` returns sorted on every platform this package supports).
|
|
180
94
|
*
|
|
181
|
-
*
|
|
182
|
-
*
|
|
183
|
-
*
|
|
184
|
-
*
|
|
185
|
-
* briefly graded on a different axis ("style, not a defect") and demoted — that was
|
|
186
|
-
* wrong twice over: avoiding a SonarQube S6557 at lint time instead of at merge time
|
|
187
|
-
* is a real saving, and the rule's matcher rejects any regex containing a
|
|
188
|
-
* metacharacter, so it only fires on true literal prefixes and has near-zero churn.
|
|
189
|
-
* It is `error`.
|
|
95
|
+
* Distinguished from the factories and helpers by a `meta` export, not by
|
|
96
|
+
* filename: a naming convention is a claim nobody checks, and a factory that
|
|
97
|
+
* happened to be named `no-…` would otherwise be registered as a rule whose
|
|
98
|
+
* `create` is a function that builds rules.
|
|
190
99
|
*/
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
100
|
+
function discoverRules(rulesDir = RULES_DIR) {
|
|
101
|
+
const rules = {};
|
|
102
|
+
for (const file of readdirSync(rulesDir)) {
|
|
103
|
+
if (!file.endsWith('.cjs')) {
|
|
104
|
+
continue;
|
|
105
|
+
}
|
|
106
|
+
// eslint-disable-next-line security/detect-non-literal-require -- the directory listing IS the manifest; every entry is a file this package ships
|
|
107
|
+
const candidate = require(path.join(rulesDir, file));
|
|
108
|
+
if (typeof candidate !== 'object' || candidate === null || typeof candidate.meta !== 'object') {
|
|
109
|
+
continue;
|
|
110
|
+
}
|
|
111
|
+
const name = file.slice(0, -'.cjs'.length);
|
|
112
|
+
validateRuleDocs(name, candidate);
|
|
113
|
+
rules[name] = candidate;
|
|
114
|
+
}
|
|
115
|
+
return rules;
|
|
116
|
+
}
|
|
117
|
+
|
|
118
|
+
const rules = discoverRules();
|
|
196
119
|
|
|
197
120
|
/**
|
|
198
121
|
* Plugin namespace an adopter gets from `configs.recommended`, and therefore the
|
|
199
|
-
* prefix on every rule id (`@vibe-agent-toolkit/no-path
|
|
122
|
+
* prefix on every rule id (`@vibe-agent-toolkit/no-raw-node-path`).
|
|
200
123
|
*
|
|
201
124
|
* Deliberately the SCOPE, not the full subpath specifier: rule ids are the surface
|
|
202
125
|
* adopters type into `rules`, `eslint-disable` comments and CI baselines, and they
|
|
@@ -211,15 +134,41 @@ const plugin = {
|
|
|
211
134
|
},
|
|
212
135
|
rules,
|
|
213
136
|
configs: {},
|
|
137
|
+
/** Test seam: the discovery walk over an arbitrary directory, so the load-time refusals can be exercised on a fixture. */
|
|
138
|
+
__internal: { discoverRules },
|
|
214
139
|
};
|
|
215
140
|
|
|
141
|
+
/**
|
|
142
|
+
* `configs.recommended` is the cross-platform-safety core: every rule whose
|
|
143
|
+
* `meta.docs.recommended` is true, at the severity it declares.
|
|
144
|
+
*
|
|
145
|
+
* `error` is the norm: every such rule flags a call whose replacement is a
|
|
146
|
+
* one-line swap, and a wrong answer is a real bug on some platform. `warn` is
|
|
147
|
+
* reserved for the case where a fresh adopter's first run would otherwise be a
|
|
148
|
+
* wall of blocking errors they cannot triage in one sitting — the criterion is
|
|
149
|
+
* MIGRATION VOLUME, not how real the finding is. A rule whose findings were
|
|
150
|
+
* doubted would be out of `recommended` entirely, not demoted.
|
|
151
|
+
*
|
|
152
|
+
* Each rule that opts OUT states why beside its own `recommended: false`. The
|
|
153
|
+
* reasons fall into a few families — a position on TEST STYLE
|
|
154
|
+
* (`require-justified-skip`, `no-test-scoped-functions`), a heuristic that keys
|
|
155
|
+
* on a NAMING CONVENTION rather than the property it cares about
|
|
156
|
+
* (`no-unsafe-root-join`, `no-process-exit-in-phase`), a SEAM that only exists
|
|
157
|
+
* once the consumer writes it (`no-raw-text-decode`), a REQUIRED OPTION this
|
|
158
|
+
* config cannot supply (`no-self-package-import`), and a claim about the
|
|
159
|
+
* CONSUMER's environment that is right for some and wrong for others
|
|
160
|
+
* (`no-fragile-entrypoint-guard`, `no-bare-symlink-in-tests`). Someone installing
|
|
161
|
+
* this package for `safePath.join()` should not silently inherit any of them.
|
|
162
|
+
* All still ship in `rules` and are enabled by naming them — which is what
|
|
163
|
+
* VAT's own `eslint.config.js` does; it does not consume `configs.recommended`.
|
|
164
|
+
*/
|
|
216
165
|
plugin.configs.recommended = {
|
|
217
166
|
name: '@vibe-agent-toolkit/utils/eslint/recommended',
|
|
218
167
|
plugins: { [NAMESPACE]: plugin },
|
|
219
168
|
rules: Object.fromEntries(
|
|
220
|
-
Object.
|
|
221
|
-
.filter((
|
|
222
|
-
.map((name) => [`${NAMESPACE}/${name}`,
|
|
169
|
+
Object.entries(rules)
|
|
170
|
+
.filter(([, rule]) => rule.meta.docs.recommended)
|
|
171
|
+
.map(([name, rule]) => [`${NAMESPACE}/${name}`, rule.meta.docs.recommendedSeverity]),
|
|
223
172
|
),
|
|
224
173
|
};
|
|
225
174
|
|
package/eslint/index.d.cts
CHANGED
|
@@ -37,33 +37,30 @@ declare namespace plugin {
|
|
|
37
37
|
interface FlatConfig {
|
|
38
38
|
name: string;
|
|
39
39
|
plugins: Record<string, Plugin>;
|
|
40
|
-
/** Rule id → severity. Keys are namespaced: `@vibe-agent-toolkit/no-path
|
|
40
|
+
/** Rule id → severity. Keys are namespaced: `@vibe-agent-toolkit/no-raw-node-path`. */
|
|
41
41
|
rules: Record<string, 'error' | 'warn' | 'off'>;
|
|
42
42
|
}
|
|
43
43
|
|
|
44
44
|
interface Plugin {
|
|
45
45
|
meta: { name: string };
|
|
46
|
-
/** Rule name WITHOUT the namespace prefix, e.g. `no-path
|
|
46
|
+
/** Rule name WITHOUT the namespace prefix, e.g. `no-raw-node-path`. */
|
|
47
47
|
rules: Record<string, RuleModule>;
|
|
48
48
|
configs: {
|
|
49
49
|
/**
|
|
50
|
-
* The cross-platform safety core:
|
|
50
|
+
* The cross-platform safety core: every rule whose `meta.docs.recommended`
|
|
51
|
+
* is true, at the severity its `meta.docs.recommendedSeverity` declares.
|
|
51
52
|
*
|
|
52
|
-
*
|
|
53
|
-
*
|
|
54
|
-
*
|
|
55
|
-
*
|
|
56
|
-
*
|
|
57
|
-
*
|
|
58
|
-
* `no-self-package-import` REQUIRES an option this config cannot supply.
|
|
59
|
-
* And `no-fragile-entrypoint-guard` half-depends on the CONSUMER's Node
|
|
60
|
-
* floor — `import.meta.main` is correct at or above 24.2 / 22.18 and
|
|
61
|
-
* `undefined` below it.
|
|
53
|
+
* No count lives here on purpose. This comment once read "18 of the 22
|
|
54
|
+
* rules, four are excluded" while the registry held 24 and the exclude
|
|
55
|
+
* set six, and later "19 of the 27" — a number in prose is a claim the
|
|
56
|
+
* manifest cannot check. The generated table in `README.md` carries the
|
|
57
|
+
* live counts, and `test/eslint/rule-manifest.test.ts` asserts the
|
|
58
|
+
* config against the directory rather than against a literal.
|
|
62
59
|
*
|
|
63
|
-
*
|
|
64
|
-
*
|
|
65
|
-
* by
|
|
66
|
-
*
|
|
60
|
+
* Every rule that opts out states why beside its own `recommended: false`
|
|
61
|
+
* in `rules/<name>.cjs`; all of them still ship in `rules` and are
|
|
62
|
+
* enabled by naming them — which is what this repo's own
|
|
63
|
+
* `eslint.config.js` does.
|
|
67
64
|
*/
|
|
68
65
|
recommended: FlatConfig;
|
|
69
66
|
};
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Shared by the rules that match a call by name: the identifier a call is
|
|
3
|
+
* made through, bare (`spawn(…)`) or as the last member of a non-computed
|
|
4
|
+
* member expression (`cp.spawn(…)`), or `null` for any other callee.
|
|
5
|
+
*
|
|
6
|
+
* Not a rule — exports no `meta`, so `index.cjs` never registers it.
|
|
7
|
+
*/
|
|
8
|
+
|
|
9
|
+
'use strict';
|
|
10
|
+
|
|
11
|
+
/** @param {object} call - ESTree `CallExpression` node. */
|
|
12
|
+
function calleeName(call) {
|
|
13
|
+
const { callee } = call;
|
|
14
|
+
if (callee.type === 'Identifier') {
|
|
15
|
+
return callee.name;
|
|
16
|
+
}
|
|
17
|
+
if (callee.type === 'MemberExpression' && !callee.computed && callee.property.type === 'Identifier') {
|
|
18
|
+
return callee.property.name;
|
|
19
|
+
}
|
|
20
|
+
return null;
|
|
21
|
+
}
|
|
22
|
+
|
|
23
|
+
module.exports = { calleeName };
|
|
@@ -0,0 +1,148 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* ESLint rule: commands-import-boundary
|
|
3
|
+
*
|
|
4
|
+
* In a command module — a file under one of the configured command
|
|
5
|
+
* directories — flags any import of the filesystem (`node:fs`,
|
|
6
|
+
* `node:fs/promises`, `fs`, `fs/promises`) and any import whose specifier
|
|
7
|
+
* matches a configured forbidden-module pattern (a package's internals, a
|
|
8
|
+
* local parser or walker module).
|
|
9
|
+
*
|
|
10
|
+
* A command's job is to parse arguments, call a seam, and render a report. The
|
|
11
|
+
* moment it opens a directory itself it has become a fifth enumeration lane
|
|
12
|
+
* nobody documented: `docs/contributing/command-lane-table.md` names the
|
|
13
|
+
* walkers every population must come through, and one command carrying its
|
|
14
|
+
* own ~700-line walker beside them was the audit finding behind this rule.
|
|
15
|
+
* The boundary is syntactic — an import is an import — so it holds at the
|
|
16
|
+
* desk rather than in a review.
|
|
17
|
+
*
|
|
18
|
+
* Shapes covered: static `import`, `import type` is IGNORED (a type does no
|
|
19
|
+
* I/O), `export … from`, dynamic `import('…')` and `require('…')` with a
|
|
20
|
+
* literal specifier.
|
|
21
|
+
*
|
|
22
|
+
* Options:
|
|
23
|
+
* - `commandGlobs: string[]` — repo-relative directories that hold commands
|
|
24
|
+
* (default `['packages/cli/src/commands/']`). A trailing `/**` is accepted
|
|
25
|
+
* and ignored; matching is by anchored directory prefix, so nested command
|
|
26
|
+
* directories are covered.
|
|
27
|
+
* - `forbiddenModules: string[]` — regex sources tested against the import
|
|
28
|
+
* specifier (default `['^@vibe-agent-toolkit/resources/']`: the barrel is a
|
|
29
|
+
* seam, a subpath is an internal).
|
|
30
|
+
* - `allowFiles: string[]` — repo-relative paths of today's offenders, the
|
|
31
|
+
* ratchet. Name files, never directories.
|
|
32
|
+
*
|
|
33
|
+
* @example
|
|
34
|
+
* // BAD — the command is now a walker
|
|
35
|
+
* import { readdirSync } from 'node:fs';
|
|
36
|
+
*
|
|
37
|
+
* // GOOD — the population comes through a declared lane
|
|
38
|
+
* import { crawlDirectory } from '@vibe-agent-toolkit/utils/crawl';
|
|
39
|
+
*/
|
|
40
|
+
|
|
41
|
+
'use strict';
|
|
42
|
+
|
|
43
|
+
const {
|
|
44
|
+
createExemptDirectoryMatcher,
|
|
45
|
+
createExemptPathMatcher,
|
|
46
|
+
} = require('./exempt-path-matcher.cjs');
|
|
47
|
+
|
|
48
|
+
const FS_MODULES = new Set(['node:fs', 'node:fs/promises', 'fs', 'fs/promises']);
|
|
49
|
+
const DEFAULT_COMMAND_DIRS = ['packages/cli/src/commands/'];
|
|
50
|
+
const DEFAULT_FORBIDDEN = ['^@vibe-agent-toolkit/resources/'];
|
|
51
|
+
|
|
52
|
+
/** Strip a trailing glob so `packages/cli/src/commands/**` reads as its directory. */
|
|
53
|
+
function toDirectory(entry) {
|
|
54
|
+
return entry.endsWith('/**') ? entry.slice(0, -2) : entry;
|
|
55
|
+
}
|
|
56
|
+
|
|
57
|
+
/** The string value of a literal module specifier, or null. */
|
|
58
|
+
function literalSpecifier(node) {
|
|
59
|
+
return node?.type === 'Literal' && typeof node.value === 'string' ? node.value : null;
|
|
60
|
+
}
|
|
61
|
+
|
|
62
|
+
module.exports = {
|
|
63
|
+
meta: {
|
|
64
|
+
type: 'problem',
|
|
65
|
+
docs: {
|
|
66
|
+
description:
|
|
67
|
+
'Disallow filesystem and internal-module imports in command modules — a command calls a ' +
|
|
68
|
+
'declared enumeration lane, it does not become one',
|
|
69
|
+
recommended: false,
|
|
70
|
+
recommendedSeverity: 'warn',
|
|
71
|
+
},
|
|
72
|
+
schema: [
|
|
73
|
+
{
|
|
74
|
+
type: 'object',
|
|
75
|
+
properties: {
|
|
76
|
+
commandGlobs: { type: 'array', items: { type: 'string' }, uniqueItems: true },
|
|
77
|
+
forbiddenModules: { type: 'array', items: { type: 'string' }, uniqueItems: true },
|
|
78
|
+
allowFiles: { type: 'array', items: { type: 'string' }, uniqueItems: true },
|
|
79
|
+
},
|
|
80
|
+
additionalProperties: false,
|
|
81
|
+
},
|
|
82
|
+
],
|
|
83
|
+
messages: {
|
|
84
|
+
fsImport:
|
|
85
|
+
"Command modules do not import '{{source}}': reading the tree here makes this command an " +
|
|
86
|
+
'undeclared enumeration lane. Go through a seam in @vibe-agent-toolkit/utils or ' +
|
|
87
|
+
'@vibe-agent-toolkit/resources (see docs/contributing/command-lane-table.md).',
|
|
88
|
+
forbiddenModule:
|
|
89
|
+
"Command modules do not import '{{source}}' (matches forbidden pattern /{{pattern}}/): " +
|
|
90
|
+
'it is an internal, not a seam. Import the barrel or the declared lane instead.',
|
|
91
|
+
},
|
|
92
|
+
},
|
|
93
|
+
|
|
94
|
+
create(context) {
|
|
95
|
+
const options = context.options?.[0] ?? {};
|
|
96
|
+
const filename = context.filename ?? context.getFilename();
|
|
97
|
+
const commandDirs = (options.commandGlobs ?? DEFAULT_COMMAND_DIRS).map(toDirectory);
|
|
98
|
+
const isCommandFile = createExemptDirectoryMatcher(commandDirs);
|
|
99
|
+
const isAllowed = createExemptPathMatcher(options.allowFiles ?? []);
|
|
100
|
+
if (!isCommandFile(filename) || isAllowed(filename)) {
|
|
101
|
+
return {};
|
|
102
|
+
}
|
|
103
|
+
|
|
104
|
+
const forbidden = (options.forbiddenModules ?? DEFAULT_FORBIDDEN).map((pattern) => ({
|
|
105
|
+
pattern,
|
|
106
|
+
// eslint-disable-next-line security/detect-non-literal-regexp -- the option is a regex source by contract: a config-time string written by the repo, not user data
|
|
107
|
+
regex: new RegExp(pattern, 'u'),
|
|
108
|
+
}));
|
|
109
|
+
|
|
110
|
+
function check(node, source) {
|
|
111
|
+
if (source === null) {
|
|
112
|
+
return;
|
|
113
|
+
}
|
|
114
|
+
if (FS_MODULES.has(source)) {
|
|
115
|
+
context.report({ node, messageId: 'fsImport', data: { source } });
|
|
116
|
+
return;
|
|
117
|
+
}
|
|
118
|
+
const hit = forbidden.find(({ regex }) => regex.test(source));
|
|
119
|
+
if (hit) {
|
|
120
|
+
context.report({ node, messageId: 'forbiddenModule', data: { source, pattern: hit.pattern } });
|
|
121
|
+
}
|
|
122
|
+
}
|
|
123
|
+
|
|
124
|
+
return {
|
|
125
|
+
ImportDeclaration(node) {
|
|
126
|
+
if (node.importKind !== 'type') {
|
|
127
|
+
check(node, literalSpecifier(node.source));
|
|
128
|
+
}
|
|
129
|
+
},
|
|
130
|
+
ExportNamedDeclaration(node) {
|
|
131
|
+
if (node.source && node.exportKind !== 'type') {
|
|
132
|
+
check(node, literalSpecifier(node.source));
|
|
133
|
+
}
|
|
134
|
+
},
|
|
135
|
+
ExportAllDeclaration(node) {
|
|
136
|
+
check(node, literalSpecifier(node.source));
|
|
137
|
+
},
|
|
138
|
+
ImportExpression(node) {
|
|
139
|
+
check(node, literalSpecifier(node.source));
|
|
140
|
+
},
|
|
141
|
+
CallExpression(node) {
|
|
142
|
+
if (node.callee.type === 'Identifier' && node.callee.name === 'require') {
|
|
143
|
+
check(node, literalSpecifier(node.arguments[0]));
|
|
144
|
+
}
|
|
145
|
+
},
|
|
146
|
+
};
|
|
147
|
+
},
|
|
148
|
+
};
|
|
@@ -233,7 +233,7 @@ function reportDeadUnsafeImports(
|
|
|
233
233
|
},
|
|
234
234
|
// `fixer.remove(node)` takes the declaration and leaves its newline, so a
|
|
235
235
|
// blank line remains where the import was. That is exactly what the
|
|
236
|
-
// specifier-removal leg in `
|
|
236
|
+
// specifier-removal leg in `no-raw-node-path.cjs` has always
|
|
237
237
|
// done — its fixtures pin the leading `\n` — and matching it keeps one
|
|
238
238
|
// behaviour rather than two. Extending the range through a trailing
|
|
239
239
|
// whitespace-only remainder would tidy both, and should be done to both at
|