eslint-plugin-kerfjs 5.0.0-beta.5 → 5.0.0-beta.51
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 +61 -21
- package/docs/rules/ai-assistant-configs.md +5 -5
- package/docs/rules/no-inline-jsx-event-handlers.md +2 -2
- package/docs/rules/no-nested-mount.md +6 -1
- package/docs/rules/no-raw-with-dynamic-arg.md +7 -7
- package/docs/rules/prefer-attr-selector.md +7 -7
- package/docs/rules/prefer-module-jsx-augmentation.md +8 -4
- package/docs/rules/require-data-key-in-each.md +6 -6
- package/docs/rules/require-delegate-disposer.md +10 -5
- package/docs/rules/ui-composition.md +5 -0
- package/docs/rules/ui-css-values.md +24 -0
- package/docs/rules/ui-preferences.md +5 -0
- package/docs/rules/ui-public-boundaries.md +7 -0
- package/docs/rules/ui-wiring.md +5 -0
- package/index.js +31 -1
- package/lib/rules/ai-assistant-configs.js +19 -9
- package/lib/rules/no-inline-jsx-event-handlers.js +1 -1
- package/lib/rules/no-nested-mount.js +2 -1
- package/lib/rules/no-raw-with-dynamic-arg.js +7 -6
- package/lib/rules/prefer-module-jsx-augmentation.js +3 -2
- package/lib/rules/require-data-key-in-each.js +7 -2
- package/lib/rules/require-delegate-disposer.js +2 -1
- package/lib/rules/ui-composition.js +213 -0
- package/lib/rules/ui-css-values.js +243 -0
- package/lib/rules/ui-preferences.js +63 -0
- package/lib/rules/ui-public-boundaries.js +79 -0
- package/lib/rules/ui-wiring.js +102 -0
- package/lib/ui-contract.js +266 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -7,18 +7,19 @@ ESLint rules that enforce kerf's hard rules. Catches AI-shaped bugs at edit time
|
|
|
7
7
|
|
|
8
8
|
This plugin sits alongside two other defense layers shipped by [`kerfjs`](https://brianwestphal.github.io/kerf/):
|
|
9
9
|
|
|
10
|
-
| Layer
|
|
11
|
-
|
|
12
|
-
| `tsc --noEmit` with strict typings
|
|
13
|
-
| Opt-in dev-warns (`KERF_DEV_WARN_*`) | Hard Rules 4 (rebuilt listeners), 7 (untracked signals), 8 (narrow set)
|
|
14
|
-
| **This plugin**
|
|
10
|
+
| Layer | Catches | When |
|
|
11
|
+
| ------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |
|
|
12
|
+
| `tsc --noEmit` with strict typings | Hard Rules 8 (partial-set), most type errors | Build time |
|
|
13
|
+
| Opt-in dev-warns (`KERF_DEV_WARN_*`) | Hard Rules 4 (rebuilt listeners), 7 (untracked signals), 8 (narrow set) | Runtime |
|
|
14
|
+
| **This plugin** | Hard Rules 2, 5, 6, 10, 12 — AST-shaped antipatterns; plus rename-safety / `raw()`-audit nudges and a project-hygiene check for the bundled AI-assistant configs | **Edit time** |
|
|
15
15
|
|
|
16
|
-
All but one rule are AST-only — no `@typescript-eslint/parser`
|
|
16
|
+
All but one rule are AST-only — no `@typescript-eslint/parser` _service_ dependency is required by the plugin (consumers configure their own parser). The exception, `ai-assistant-configs`, reads the filesystem instead of the AST and runs once per lint pass.
|
|
17
17
|
|
|
18
18
|
## Install
|
|
19
19
|
|
|
20
20
|
```bash
|
|
21
21
|
npm install --save-dev eslint-plugin-kerfjs
|
|
22
|
+
npm install @kerfjs/ui
|
|
22
23
|
```
|
|
23
24
|
|
|
24
25
|
### Supported ESLint versions
|
|
@@ -33,12 +34,12 @@ A version outside the range is not "probably fine" — it is one nobody has run.
|
|
|
33
34
|
|
|
34
35
|
```js
|
|
35
36
|
// eslint.config.js
|
|
36
|
-
import kerfjs from
|
|
37
|
-
import tsParser from
|
|
37
|
+
import kerfjs from "eslint-plugin-kerfjs";
|
|
38
|
+
import tsParser from "@typescript-eslint/parser";
|
|
38
39
|
|
|
39
40
|
export default [
|
|
40
41
|
{
|
|
41
|
-
files: [
|
|
42
|
+
files: ["**/*.ts", "**/*.tsx"],
|
|
42
43
|
languageOptions: {
|
|
43
44
|
parser: tsParser,
|
|
44
45
|
parserOptions: { ecmaFeatures: { jsx: true } },
|
|
@@ -48,25 +49,64 @@ export default [
|
|
|
48
49
|
];
|
|
49
50
|
```
|
|
50
51
|
|
|
52
|
+
Applications using the UI catalog can select one of two additive flat configs:
|
|
53
|
+
|
|
54
|
+
```js
|
|
55
|
+
export default [
|
|
56
|
+
// parser/files configuration as above
|
|
57
|
+
kerfjs.configs['recommended-ui'], // preferences and wiring are warnings
|
|
58
|
+
// or kerfjs.configs['strict-ui'] // all UI contracts are errors
|
|
59
|
+
];
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
The UI rules resolve the installed `@kerfjs/ui` v1 selection catalog, v2 composition catalog, and application profile defaults. They then merge `.kerf-ui-profile.json` files from the workspace root toward the linted file. Package authors and monorepos can provide explicit artifacts without duplicating their facts:
|
|
63
|
+
|
|
64
|
+
```js
|
|
65
|
+
settings: {
|
|
66
|
+
kerfjs: {
|
|
67
|
+
ui: {
|
|
68
|
+
workspaceRoot: import.meta.dirname,
|
|
69
|
+
catalogPath: './vendor/component-catalog-v2.json',
|
|
70
|
+
selectionCatalogPath: './vendor/component-catalog.json',
|
|
71
|
+
profileDefaultsPath: './vendor/application-ui-profile.defaults.json',
|
|
72
|
+
profileContractPath: './vendor/application-ui-profile-sync.cjs',
|
|
73
|
+
},
|
|
74
|
+
},
|
|
75
|
+
}
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
For deterministic generated configs, the same settings accept parsed `catalog`, `selectionCatalog`, and `profile` objects. File-based precedence is package defaults, then workspace profile, then root-to-leaf directory profiles. The rules load `application-ui-profile-sync.cjs` from the installed `@kerfjs/ui` package by default because ESLint rule creation is synchronous; `profileContractPath` is only needed when artifacts are vendored. Every raw layer is schema- and catalog-reference-validated before merge, so a child cannot hide malformed or stale parent policy. Exceptions use exact `KUI-L*` diagnostic ids and repository-relative file or directory targets.
|
|
79
|
+
|
|
80
|
+
`ui-css-values` consumes each catalog entry's property-specific grammar and
|
|
81
|
+
emits `KUI-L013`–`KUI-L017` with a preferred shorthand or helper. It covers JSX,
|
|
82
|
+
direct component calls, nested catalog paths, and explicitly configured
|
|
83
|
+
third-party catalogs; dynamic values remain governed by TypeScript.
|
|
84
|
+
|
|
85
|
+
`KUI-L090` is reserved for catalog/profile loading and configuration failures. The supported-ESLint matrix installs real packed `eslint-plugin-kerfjs` and `@kerfjs/ui` tarballs in a downstream flat-config fixture, ensuring these defaults resolve from the consumer rather than this repository's source tree.
|
|
86
|
+
|
|
51
87
|
## Legacy `.eslintrc` configs are not supported
|
|
52
88
|
|
|
53
|
-
The package is ESM-only. ESLint's `.eslintrc` system loads plugins with `require()`, which cannot load an ESM package, so `extends: ["plugin:kerfjs/legacy-recommended"]` fails with
|
|
89
|
+
The package is ESM-only. ESLint's `.eslintrc` system loads plugins with `require()`, which cannot load an ESM package, so `extends: ["plugin:kerfjs/legacy-recommended"]` fails with _"couldn't find the config to extend from"_ on ESLint 8 **and** on ESLint 9's legacy mode.
|
|
54
90
|
|
|
55
91
|
Use flat config (`eslint.config.js`), shown above. The `legacy-recommended` export still exists in the package but is unreachable through any config system — treat it as deprecated.
|
|
56
92
|
|
|
57
|
-
|
|
58
93
|
## Rules
|
|
59
94
|
|
|
60
|
-
| Rule
|
|
61
|
-
|
|
62
|
-
| [`no-inline-jsx-event-handlers`](docs/rules/no-inline-jsx-event-handlers.md)
|
|
63
|
-
| [`require-data-key-in-each`](docs/rules/require-data-key-in-each.md)
|
|
64
|
-
| [`require-delegate-disposer`](docs/rules/require-delegate-disposer.md)
|
|
65
|
-
| [`no-nested-mount`](docs/rules/no-nested-mount.md)
|
|
66
|
-
| [`prefer-module-jsx-augmentation`](docs/rules/prefer-module-jsx-augmentation.md) | 12 — augment `kerfjs/jsx-runtime`, not global
|
|
67
|
-
| [`prefer-attr-selector`](docs/rules/prefer-attr-selector.md)
|
|
68
|
-
| [`no-raw-with-dynamic-arg`](docs/rules/no-raw-with-dynamic-arg.md)
|
|
69
|
-
| [`ai-assistant-configs`](docs/rules/ai-assistant-configs.md)
|
|
95
|
+
| Rule | Hard Rule | Severity (recommended) |
|
|
96
|
+
| -------------------------------------------------------------------------------- | ---------------------------------------------------- | ---------------------- |
|
|
97
|
+
| [`no-inline-jsx-event-handlers`](docs/rules/no-inline-jsx-event-handlers.md) | 10 — use `data-action` + `delegate()` | `error` |
|
|
98
|
+
| [`require-data-key-in-each`](docs/rules/require-data-key-in-each.md) | 2 — `data-key` per item | `error` |
|
|
99
|
+
| [`require-delegate-disposer`](docs/rules/require-delegate-disposer.md) | 5 — capture `delegate()` disposers when scope < page | `warn` |
|
|
100
|
+
| [`no-nested-mount`](docs/rules/no-nested-mount.md) | 6 — one `mount()` per root | `error` |
|
|
101
|
+
| [`prefer-module-jsx-augmentation`](docs/rules/prefer-module-jsx-augmentation.md) | 12 — augment `kerfjs/jsx-runtime`, not global | `error` |
|
|
102
|
+
| [`prefer-attr-selector`](docs/rules/prefer-attr-selector.md) | — (rename-safety nudge for `delegate()` selectors) | `warn` |
|
|
103
|
+
| [`no-raw-with-dynamic-arg`](docs/rules/no-raw-with-dynamic-arg.md) | — (XSS audit trail) | `warn` |
|
|
104
|
+
| [`ai-assistant-configs`](docs/rules/ai-assistant-configs.md) | — (project hygiene) | `warn` |
|
|
105
|
+
| [`ui-public-boundaries`](docs/rules/ui-public-boundaries.md) | — (cataloged CSS boundaries) | `error` |
|
|
106
|
+
| [`ui-composition`](docs/rules/ui-composition.md) | — (cataloged parents and zones) | `error` |
|
|
107
|
+
| [`ui-css-values`](docs/rules/ui-css-values.md) | — (cataloged property-specific value grammar) | `error` |
|
|
108
|
+
| [`ui-preferences`](docs/rules/ui-preferences.md) | — (application component choices) | `warn` |
|
|
109
|
+
| [`ui-wiring`](docs/rules/ui-wiring.md) | — (required setup and cleanup) | `warn` |
|
|
70
110
|
|
|
71
111
|
The "Hard Rule" column refers to the numbered rules in [`docs/ai/usage-guide.md`](../docs/ai/usage-guide.md) on the main kerf repo. `no-raw-with-dynamic-arg` and `ai-assistant-configs` don't map to numbered Hard Rules — the former creates an audit trail for every dynamic `raw()` call site (potential XSS); the latter checks that the bundled AI-assistant configs are installed and current. See [`docs/12-ai-assistant-configs.md`](../docs/12-ai-assistant-configs.md) on the main kerf repo for the AI-configs design.
|
|
72
112
|
|
|
@@ -10,10 +10,10 @@ Maps to design doc [`docs/12-ai-assistant-configs.md`](https://github.com/brianw
|
|
|
10
10
|
|
|
11
11
|
The rule resolves `kerfjs/ai/manifest.json` from the consumer's installed `kerfjs` (silently no-ops if `kerfjs` isn't a dep). For each bundled file, it picks a trigger heuristic — "is this project using the tool this file is for?" — and only nudges the consumer when the trigger says yes:
|
|
12
12
|
|
|
13
|
-
| Bundled file
|
|
14
|
-
|
|
15
|
-
| `ai/skill.md` (Claude Code) | `.claude/` directory exists at the project root
|
|
16
|
-
| `ai/cursorrules` (Cursor)
|
|
13
|
+
| Bundled file | Triggers when | Installed to |
|
|
14
|
+
| --------------------------- | -------------------------------------------------- | ---------------------------------- |
|
|
15
|
+
| `ai/skill.md` (Claude Code) | `.claude/` directory exists at the project root | `.claude/skills/kerf-app/SKILL.md` |
|
|
16
|
+
| `ai/cursorrules` (Cursor) | `.cursorrules` file or `.cursor/` directory exists | `.cursorrules` |
|
|
17
17
|
|
|
18
18
|
A triggered file is then classified into one of three reported states (a fourth, "up-to-date," is silent):
|
|
19
19
|
|
|
@@ -78,4 +78,4 @@ Both `claude` and `cursor` default to `true`. Setting either to `false` makes th
|
|
|
78
78
|
- It does not install the configs at `npm install` time — there are no postinstall scripts. The first lint pass after `npm install kerfjs` surfaces the recommendation.
|
|
79
79
|
- It does not write to disk under plain `eslint` (no `--fix`). The warning is emitted; nothing changes on disk.
|
|
80
80
|
- It does not push Claude Code or Cursor on consumers who haven't signalled they use them — no `.claude/` or `.cursor*` ⇒ silent.
|
|
81
|
-
- It does not validate the
|
|
81
|
+
- It does not validate the _content_ of the canonical files in the bundle. That's the kerf maintainer's responsibility (and the `check:ai-bundle-in-sync` gate in the kerf repo).
|
|
@@ -40,8 +40,8 @@ delegate(rootEl, 'submit', ACTIONS.submit.selector, submit);
|
|
|
40
40
|
String literals still work for ad-hoc fixed selectors:
|
|
41
41
|
|
|
42
42
|
```tsx
|
|
43
|
-
<button data-action="save">Save</button
|
|
44
|
-
delegate(rootEl,
|
|
43
|
+
<button data-action="save">Save</button>;
|
|
44
|
+
delegate(rootEl, "click", '[data-action="save"]', save);
|
|
45
45
|
```
|
|
46
46
|
|
|
47
47
|
## Why this rule is AST-only
|
|
@@ -24,7 +24,12 @@ mount(bodyRoot, () => <Body />);
|
|
|
24
24
|
|
|
25
25
|
// Composition via plain functions:
|
|
26
26
|
const Header = () => <h1>{title.value}</h1>;
|
|
27
|
-
const Body = () =>
|
|
27
|
+
const Body = () => (
|
|
28
|
+
<main>
|
|
29
|
+
<Header />
|
|
30
|
+
<div>{count.value}</div>
|
|
31
|
+
</main>
|
|
32
|
+
);
|
|
28
33
|
mount(root, () => <Body />);
|
|
29
34
|
```
|
|
30
35
|
|
|
@@ -9,21 +9,21 @@ Warn when `raw()` is called with a dynamic argument (any expression that is not
|
|
|
9
9
|
## ❌ Incorrect
|
|
10
10
|
|
|
11
11
|
```ts
|
|
12
|
-
raw(userInput)
|
|
13
|
-
raw(fetchedHtml())
|
|
14
|
-
raw(`<b>${title}</b>`)
|
|
15
|
-
raw(isAdmin ? adminHtml : guestHtml)
|
|
12
|
+
raw(userInput); // variable reference
|
|
13
|
+
raw(fetchedHtml()); // function call
|
|
14
|
+
raw(`<b>${title}</b>`); // template literal with expressions
|
|
15
|
+
raw(isAdmin ? adminHtml : guestHtml); // conditional expression
|
|
16
16
|
```
|
|
17
17
|
|
|
18
18
|
## ✅ Correct
|
|
19
19
|
|
|
20
20
|
```ts
|
|
21
|
-
raw(
|
|
22
|
-
raw(`<p>Static template</p>`)
|
|
21
|
+
raw("<p>Static markup</p>"); // string literal — no warning
|
|
22
|
+
raw(`<p>Static template</p>`); // expression-free template literal — no warning
|
|
23
23
|
|
|
24
24
|
// Dynamic but audited — suppress with eslint-disable
|
|
25
25
|
// eslint-disable-next-line kerfjs/no-raw-with-dynamic-arg
|
|
26
|
-
raw(DOMPurify.sanitize(marked(userMarkdown)))
|
|
26
|
+
raw(DOMPurify.sanitize(marked(userMarkdown)));
|
|
27
27
|
```
|
|
28
28
|
|
|
29
29
|
## Why `warn` and not `error`
|
|
@@ -7,8 +7,8 @@ Prefer `attr('name', 'value').selector` over a literal `[name="value"]` selector
|
|
|
7
7
|
## ❌ Discouraged
|
|
8
8
|
|
|
9
9
|
```tsx
|
|
10
|
-
<button data-action="toggle">Toggle</button
|
|
11
|
-
delegate(root,
|
|
10
|
+
<button data-action="toggle">Toggle</button>;
|
|
11
|
+
delegate(root, "click", '[data-action="toggle"]', handler);
|
|
12
12
|
```
|
|
13
13
|
|
|
14
14
|
The JSX attribute and the selector string are two independent literals; renaming the action key in JSX leaves the delegate selector unchanged, and the handler silently stops firing.
|
|
@@ -16,14 +16,14 @@ The JSX attribute and the selector string are two independent literals; renaming
|
|
|
16
16
|
## ✅ Recommended
|
|
17
17
|
|
|
18
18
|
```tsx
|
|
19
|
-
import { attr, delegate, type AttrSpec } from
|
|
19
|
+
import { attr, delegate, type AttrSpec } from "kerfjs";
|
|
20
20
|
|
|
21
21
|
const ACTIONS = {
|
|
22
|
-
toggle: attr(
|
|
23
|
-
} as const satisfies Record<string, AttrSpec<
|
|
22
|
+
toggle: attr("data-action", "toggle"),
|
|
23
|
+
} as const satisfies Record<string, AttrSpec<"data-action">>;
|
|
24
24
|
|
|
25
|
-
<button {...ACTIONS.toggle.attrs}>Toggle</button
|
|
26
|
-
delegate(root,
|
|
25
|
+
<button {...ACTIONS.toggle.attrs}>Toggle</button>;
|
|
26
|
+
delegate(root, "click", ACTIONS.toggle.selector, handler);
|
|
27
27
|
```
|
|
28
28
|
|
|
29
29
|
Rename `'toggle'` to `'on'` in the `ACTIONS` map and both the rendered attribute and the delegate selector update — no string-grep migration required.
|
|
@@ -10,7 +10,7 @@ Maps to **kerf Hard Rule 11** — kerf's JSX runtime looks up custom-element typ
|
|
|
10
10
|
declare global {
|
|
11
11
|
namespace JSX {
|
|
12
12
|
interface IntrinsicElements {
|
|
13
|
-
|
|
13
|
+
"my-tag": { foo?: string };
|
|
14
14
|
}
|
|
15
15
|
}
|
|
16
16
|
}
|
|
@@ -19,10 +19,10 @@ declare global {
|
|
|
19
19
|
## ✅ Correct
|
|
20
20
|
|
|
21
21
|
```ts
|
|
22
|
-
declare module
|
|
22
|
+
declare module "kerfjs/jsx-runtime" {
|
|
23
23
|
namespace JSX {
|
|
24
24
|
interface IntrinsicElements {
|
|
25
|
-
|
|
25
|
+
"my-tag": KerfCustomElement & { foo?: string };
|
|
26
26
|
}
|
|
27
27
|
}
|
|
28
28
|
}
|
|
@@ -31,7 +31,11 @@ declare module 'kerfjs/jsx-runtime' {
|
|
|
31
31
|
Import the building-block types from `kerfjs/jsx-runtime`:
|
|
32
32
|
|
|
33
33
|
```ts
|
|
34
|
-
import type {
|
|
34
|
+
import type {
|
|
35
|
+
KerfCustomElement,
|
|
36
|
+
KerfBaseAttrs,
|
|
37
|
+
AttrLike,
|
|
38
|
+
} from "kerfjs/jsx-runtime";
|
|
35
39
|
```
|
|
36
40
|
|
|
37
41
|
## What this rule does NOT catch
|
|
@@ -7,24 +7,24 @@ Maps to **kerf Hard Rule 2** — the keyed reconciler matches items by `id` firs
|
|
|
7
7
|
## ❌ Incorrect
|
|
8
8
|
|
|
9
9
|
```tsx
|
|
10
|
-
each(items, (item) => <li>{item.name}</li>)
|
|
10
|
+
each(items, (item) => <li>{item.name}</li>);
|
|
11
11
|
|
|
12
12
|
each(items, (item) => {
|
|
13
13
|
return <li class="row">{item.name}</li>;
|
|
14
|
-
})
|
|
14
|
+
});
|
|
15
15
|
|
|
16
|
-
each(items, (item) => <>{item.name}</>)
|
|
16
|
+
each(items, (item) => <>{item.name}</>);
|
|
17
17
|
```
|
|
18
18
|
|
|
19
19
|
## ✅ Correct
|
|
20
20
|
|
|
21
21
|
```tsx
|
|
22
|
-
each(items, (item) => <li data-key={item.id}>{item.name}</li>)
|
|
22
|
+
each(items, (item) => <li data-key={item.id}>{item.name}</li>);
|
|
23
23
|
|
|
24
|
-
each(items, (item) => <li id={item.id}>{item.name}</li>)
|
|
24
|
+
each(items, (item) => <li id={item.id}>{item.name}</li>);
|
|
25
25
|
|
|
26
26
|
// Spread attributes are conservatively allowed — they may include the key.
|
|
27
|
-
each(items, (item) => <li {...item.attrs}>{item.name}</li>)
|
|
27
|
+
each(items, (item) => <li {...item.attrs}>{item.name}</li>);
|
|
28
28
|
```
|
|
29
29
|
|
|
30
30
|
## What this rule does NOT catch
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
Require capturing the disposer returned by `delegate()` and `delegateCapture()`.
|
|
4
4
|
|
|
5
|
-
Both helpers install a single listener on the root element and return a `() => void` disposer — the
|
|
5
|
+
Both helpers install a single listener on the root element and return a `() => void` disposer — the _only_ way to remove the listener once it's attached. Discarding the return value is safe in exactly one case: the registration is genuinely page-lifetime (root is `document.body` or another never-torn-down element, attached once at startup, never re-registered). In every other case the listener closure pins `rootEl`, `handler`, and everything the handler closes over (stores, signals, app state) — so an undisposed delegate on a transient root leaks both the listener and the app graph it references, and re-mount cycles stack listeners linearly. `mount()`'s own disposer does NOT remove delegates for you.
|
|
6
6
|
|
|
7
7
|
See [kerf docs §5.3 — Disposers](https://brianwestphal.github.io/kerf/docs/5-event-delegation/#53-disposers) for the full rationale.
|
|
8
8
|
|
|
@@ -49,8 +49,8 @@ Or collect into a disposer array:
|
|
|
49
49
|
```ts
|
|
50
50
|
const disposers: Array<() => void> = [];
|
|
51
51
|
disposers.push(mount(host, render));
|
|
52
|
-
disposers.push(delegate(host,
|
|
53
|
-
disposers.push(delegate(host,
|
|
52
|
+
disposers.push(delegate(host, "click", "[data-action]", onAction));
|
|
53
|
+
disposers.push(delegate(host, "keydown", "[data-edit]", onEdit));
|
|
54
54
|
|
|
55
55
|
function teardown() {
|
|
56
56
|
for (const off of disposers) off();
|
|
@@ -64,13 +64,18 @@ If the registration is attached once at module load and the root never tears dow
|
|
|
64
64
|
|
|
65
65
|
```ts
|
|
66
66
|
// 1. The `void` operator as an explicit-discard sigil.
|
|
67
|
-
void delegate(
|
|
67
|
+
void delegate(
|
|
68
|
+
document.body,
|
|
69
|
+
"click",
|
|
70
|
+
ACTIONS.inc.selector,
|
|
71
|
+
() => count.value++,
|
|
72
|
+
);
|
|
68
73
|
```
|
|
69
74
|
|
|
70
75
|
```ts
|
|
71
76
|
// 2. Standard eslint-disable for one-off cases.
|
|
72
77
|
// eslint-disable-next-line kerfjs/require-delegate-disposer
|
|
73
|
-
delegate(document.body,
|
|
78
|
+
delegate(document.body, "click", ACTIONS.inc.selector, () => count.value++);
|
|
74
79
|
```
|
|
75
80
|
|
|
76
81
|
`void` is the lower-friction option when the file has many page-lifetime registrations clustered together; eslint-disable carries the rule name with it, which makes it easier to grep for.
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
# `ui-composition`
|
|
2
|
+
|
|
3
|
+
Enforces composition facts published by the versioned UI catalog. `KUI-L201` reports a catalog component under a known, disallowed direct parent. `KUI-L202` reports a statically visible zone child—including an intrinsic or unknown JSX element—that is not one of the zone's cataloged `accepts` entries. `KUI-L203` reports a statically provable zone cardinality violation. A zone participates only when it declares an explicit `jsx.prop` binding, including `children`; the rule never guesses that a zone id is a JSX prop. Toolbar, Pane, TabBar, AppTab, feedback, search, and layout validation is therefore catalog-driven rather than duplicated in rule-local component cases.
|
|
4
|
+
|
|
5
|
+
The parent check is intentionally conservative: it reports only when both child and direct parent resolve to cataloged imports. Bound zone checks understand aliases, namespace imports, fragments, arrays, and conditional/logical branches, but expressions whose content cannot be resolved statically remain runtime and accessibility work. Accepted concepts that do not identify a catalog entry remain machine-readable guidance while the rule enforces their statically provable cardinality only. No autofix is offered because wrapping or moving UI changes structure and behavior.
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# `ui-css-values`
|
|
2
|
+
|
|
3
|
+
Checks literal JSX and direct component-function calls against each component's
|
|
4
|
+
cataloged `cssValueProps` contracts. The catalog keeps length, size, flex,
|
|
5
|
+
color, declaration-list, media-query, and numeric-pixel grammars distinct and
|
|
6
|
+
names their accepted helpers, finite shorthands, and raw-value policy.
|
|
7
|
+
|
|
8
|
+
Stable diagnostics are `KUI-L013` (raw or unknown shorthand), `KUI-L014`
|
|
9
|
+
(wrong property helper), `KUI-L015` (non-standalone expression), `KUI-L016`
|
|
10
|
+
(forbidden declaration list), and review-oriented `KUI-L017` (exceptional
|
|
11
|
+
spacing shorthand). Messages name the preferred shorthand or helper. Dynamic
|
|
12
|
+
values are left to TypeScript rather than guessed.
|
|
13
|
+
|
|
14
|
+
Only component exports carry an entry's contracts. A catalog entry's
|
|
15
|
+
`publicExports` also lists the helpers its props consume (`Select` ships
|
|
16
|
+
`uiColor`, `List` ships `px`, `rem`, and `flex`); a helper call such as
|
|
17
|
+
`flex({ gap: '12px' })` is not a `List` call and is never checked as one. A
|
|
18
|
+
component export is one whose name starts with an uppercase letter, the rule
|
|
19
|
+
JSX itself uses to tell a component tag from an intrinsic element; a default
|
|
20
|
+
import keeps its subpath's entry. `@kerfjs/ui`'s catalog check enforces the
|
|
21
|
+
convention for the package, and `kerf-ui-analyze` applies the same rule.
|
|
22
|
+
|
|
23
|
+
Third-party component suites can provide the same contracts in a composition
|
|
24
|
+
catalog through `settings.kerfjs.ui.catalog` and its matching selection catalog.
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
# `ui-preferences`
|
|
2
|
+
|
|
3
|
+
Reports cataloged components listed in an application UI profile preference's `avoid` set and points to the package-qualified `preferred` component. The stable diagnostic is `KUI-L301`.
|
|
4
|
+
|
|
5
|
+
`recommended-ui` treats the rule as a warning; `strict-ui` treats it as an error. Use a narrowly targeted `KUI-L301` profile exception when a documented application boundary cannot follow the preference. Component substitutions are not autofixed because their props and interaction contracts can differ.
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
# `ui-public-boundaries`
|
|
2
|
+
|
|
3
|
+
Rejects `kui-*` classes and `--kui-*` custom properties that are not listed in the versioned composition catalog. This keeps application code out of private component anatomy while allowing cataloged styling seams.
|
|
4
|
+
|
|
5
|
+
Diagnostics are stable: `KUI-L101` identifies a private/unknown class and `KUI-L102` an unknown token. Exact profile exceptions can name either id. The rule deliberately does not rewrite selectors or tokens because there is no generally safe replacement.
|
|
6
|
+
|
|
7
|
+
The rule reads `@kerfjs/ui/ai/component-catalog-v2.json` by default. See the plugin README for alternate catalog settings used by monorepos and package authors.
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
# `ui-wiring`
|
|
2
|
+
|
|
3
|
+
Checks wiring obligations published by the versioned composition catalog. `KUI-L401` reports a used component whose required helper or side-effect registration import is absent. `KUI-L402` reports a helper call whose disposer is discarded.
|
|
4
|
+
|
|
5
|
+
Assign, return, or otherwise retain a disposer when the binding has a shorter lifetime than the page. A `void` call is accepted as an explicit page-lifetime choice. The rule derives valid helper sources from each v1 entry's `publicExports` and `wiring[].import` facts, so aliases, root named imports, root namespaces, wiring-subpath named imports, and wiring-subpath namespaces resolve without a second hard-coded export table. It does not attempt flow-sensitive cleanup proof and offers no autofix.
|
package/index.js
CHANGED
|
@@ -6,9 +6,14 @@ import preferAttrSelector from './lib/rules/prefer-attr-selector.js';
|
|
|
6
6
|
import preferModuleJsxAugmentation from './lib/rules/prefer-module-jsx-augmentation.js';
|
|
7
7
|
import requireDataKeyInEach from './lib/rules/require-data-key-in-each.js';
|
|
8
8
|
import requireDelegateDisposer from './lib/rules/require-delegate-disposer.js';
|
|
9
|
+
import uiComposition from './lib/rules/ui-composition.js';
|
|
10
|
+
import uiCssValues from './lib/rules/ui-css-values.js';
|
|
11
|
+
import uiPreferences from './lib/rules/ui-preferences.js';
|
|
12
|
+
import uiPublicBoundaries from './lib/rules/ui-public-boundaries.js';
|
|
13
|
+
import uiWiring from './lib/rules/ui-wiring.js';
|
|
9
14
|
|
|
10
15
|
const plugin = {
|
|
11
|
-
meta: { name: 'eslint-plugin-kerfjs', version: '5.0.0-beta.
|
|
16
|
+
meta: { name: 'eslint-plugin-kerfjs', version: '5.0.0-beta.51' },
|
|
12
17
|
rules: {
|
|
13
18
|
'no-inline-jsx-event-handlers': noInlineJsxEventHandlers,
|
|
14
19
|
'no-raw-with-dynamic-arg': noRawWithDynamicArg,
|
|
@@ -18,6 +23,11 @@ const plugin = {
|
|
|
18
23
|
'prefer-module-jsx-augmentation': preferModuleJsxAugmentation,
|
|
19
24
|
'prefer-attr-selector': preferAttrSelector,
|
|
20
25
|
'ai-assistant-configs': aiAssistantConfigs,
|
|
26
|
+
'ui-composition': uiComposition,
|
|
27
|
+
'ui-css-values': uiCssValues,
|
|
28
|
+
'ui-preferences': uiPreferences,
|
|
29
|
+
'ui-public-boundaries': uiPublicBoundaries,
|
|
30
|
+
'ui-wiring': uiWiring,
|
|
21
31
|
},
|
|
22
32
|
configs: {},
|
|
23
33
|
};
|
|
@@ -50,6 +60,26 @@ plugin.configs.recommended = {
|
|
|
50
60
|
plugins: { kerfjs: plugin },
|
|
51
61
|
rules: recommendedRules,
|
|
52
62
|
};
|
|
63
|
+
const recommendedUiRules = {
|
|
64
|
+
...recommendedRules,
|
|
65
|
+
'kerfjs/ui-public-boundaries': 'error',
|
|
66
|
+
'kerfjs/ui-composition': 'error',
|
|
67
|
+
'kerfjs/ui-css-values': 'error',
|
|
68
|
+
'kerfjs/ui-preferences': 'warn',
|
|
69
|
+
'kerfjs/ui-wiring': 'warn',
|
|
70
|
+
};
|
|
71
|
+
plugin.configs['recommended-ui'] = {
|
|
72
|
+
plugins: { kerfjs: plugin },
|
|
73
|
+
rules: recommendedUiRules,
|
|
74
|
+
};
|
|
75
|
+
plugin.configs['strict-ui'] = {
|
|
76
|
+
plugins: { kerfjs: plugin },
|
|
77
|
+
rules: {
|
|
78
|
+
...recommendedUiRules,
|
|
79
|
+
'kerfjs/ui-preferences': 'error',
|
|
80
|
+
'kerfjs/ui-wiring': 'error',
|
|
81
|
+
},
|
|
82
|
+
};
|
|
53
83
|
plugin.configs.all = plugin.configs.recommended;
|
|
54
84
|
|
|
55
85
|
// Legacy `.eslintrc` config — consumers extend `'plugin:kerfjs/legacy-recommended'`.
|
|
@@ -106,8 +106,10 @@ export function classifyFile(file, bundleDir, cwd) {
|
|
|
106
106
|
}
|
|
107
107
|
|
|
108
108
|
const markerIdx = findMarkerIndex(consumer);
|
|
109
|
-
if (markerIdx === -1)
|
|
110
|
-
|
|
109
|
+
if (markerIdx === -1)
|
|
110
|
+
return { state: 'forked', reason: 'no canonical-end marker' };
|
|
111
|
+
if (markerIdx === -2)
|
|
112
|
+
return { state: 'forked', reason: 'multiple canonical-end markers' };
|
|
111
113
|
|
|
112
114
|
const canonicalEnd = canonicalEndOffset(consumer);
|
|
113
115
|
const consumerCanonical = consumer.slice(0, canonicalEnd);
|
|
@@ -134,7 +136,10 @@ export function classifyFile(file, bundleDir, cwd) {
|
|
|
134
136
|
};
|
|
135
137
|
}
|
|
136
138
|
if (consumerCanonicalHash !== historicalHash) {
|
|
137
|
-
return {
|
|
139
|
+
return {
|
|
140
|
+
state: 'forked',
|
|
141
|
+
reason: 'content above marker has been edited',
|
|
142
|
+
};
|
|
138
143
|
}
|
|
139
144
|
return {
|
|
140
145
|
state: 'stale',
|
|
@@ -164,7 +169,9 @@ function loadBundle(cwd) {
|
|
|
164
169
|
function isTriggered(name, cwd) {
|
|
165
170
|
if (name === 'skill') return existsSync(join(cwd, '.claude'));
|
|
166
171
|
if (name === 'cursorrules') {
|
|
167
|
-
return
|
|
172
|
+
return (
|
|
173
|
+
existsSync(join(cwd, '.cursorrules')) || existsSync(join(cwd, '.cursor'))
|
|
174
|
+
);
|
|
168
175
|
}
|
|
169
176
|
return false;
|
|
170
177
|
}
|
|
@@ -220,7 +227,7 @@ const meta = {
|
|
|
220
227
|
stale:
|
|
221
228
|
'{{tool}} drop-in at `{{dest}}` is stale (have {{consumerVersion}}, latest is {{bundledVersion}}). Run `eslint --fix` to update the canonical section above the `KERF-APP-CANONICAL-END` marker; your customizations below the marker are preserved.',
|
|
222
229
|
forked:
|
|
223
|
-
|
|
230
|
+
"{{tool}} drop-in at `{{dest}}` is forked: {{reason}}. Restore the canonical layout (one `KERF-APP-CANONICAL-END` marker, no edits above it) or disable this rule with `'kerfjs/ai-assistant-configs': 'off'`.",
|
|
224
231
|
},
|
|
225
232
|
// Mark as fixable so the CLI exposes this rule under `--fix`. The callback
|
|
226
233
|
// writes to a separate file and returns null, so ESLint applies no edit to
|
|
@@ -247,7 +254,10 @@ function create(context) {
|
|
|
247
254
|
if (file.name === 'cursorrules' && !cursorEnabled) continue;
|
|
248
255
|
if (result.state === 'ok') continue;
|
|
249
256
|
|
|
250
|
-
const tool =
|
|
257
|
+
const tool =
|
|
258
|
+
file.name === 'skill'
|
|
259
|
+
? 'Claude Code kerf-app skill'
|
|
260
|
+
: 'Cursor kerf rules';
|
|
251
261
|
const bundle = file.bundle; // e.g. 'ai/skill.md'
|
|
252
262
|
const data = { tool, dest: file.dest, bundle };
|
|
253
263
|
|
|
@@ -291,9 +301,9 @@ function create(context) {
|
|
|
291
301
|
|
|
292
302
|
function contextCwd(context) {
|
|
293
303
|
return (
|
|
294
|
-
(typeof context.cwd === 'string' && context.cwd)
|
|
295
|
-
|
|
296
|
-
|
|
304
|
+
(typeof context.cwd === 'string' && context.cwd) ||
|
|
305
|
+
(typeof context.getCwd === 'function' && context.getCwd()) ||
|
|
306
|
+
process.cwd()
|
|
297
307
|
);
|
|
298
308
|
}
|
|
299
309
|
|
|
@@ -7,7 +7,7 @@ const meta = {
|
|
|
7
7
|
type: 'problem',
|
|
8
8
|
docs: {
|
|
9
9
|
description:
|
|
10
|
-
|
|
10
|
+
'Disallow inline `onClick`-style JSX event handler attributes; use `data-action` + `delegate()` instead.',
|
|
11
11
|
url: 'https://github.com/brianwestphal/kerf/blob/main/eslint-plugin/docs/rules/no-inline-jsx-event-handlers.md',
|
|
12
12
|
},
|
|
13
13
|
schema: [],
|
|
@@ -34,7 +34,8 @@ function create(context) {
|
|
|
34
34
|
let p = node.parent;
|
|
35
35
|
while (p) {
|
|
36
36
|
if (
|
|
37
|
-
(p.type === 'ArrowFunctionExpression' ||
|
|
37
|
+
(p.type === 'ArrowFunctionExpression' ||
|
|
38
|
+
p.type === 'FunctionExpression') &&
|
|
38
39
|
isMountCall(p.parent) &&
|
|
39
40
|
p.parent.arguments.includes(p)
|
|
40
41
|
) {
|
|
@@ -22,13 +22,13 @@ const meta = {
|
|
|
22
22
|
type: 'problem',
|
|
23
23
|
docs: {
|
|
24
24
|
description:
|
|
25
|
-
|
|
25
|
+
'Disallow `raw()` with dynamic arguments; `raw()` bypasses HTML escaping and passing dynamic values is an XSS vector.',
|
|
26
26
|
url: 'https://github.com/brianwestphal/kerf/blob/main/eslint-plugin/docs/rules/no-raw-with-dynamic-arg.md',
|
|
27
27
|
},
|
|
28
28
|
schema: [],
|
|
29
29
|
messages: {
|
|
30
30
|
dynamic:
|
|
31
|
-
|
|
31
|
+
'`raw()` bypasses HTML auto-escaping. Passing a dynamic value is an XSS risk unless the input has been sanitized. Sanitize first (`DOMPurify.sanitize(...)`) then pass to `raw()`, or add `// eslint-disable-next-line kerfjs/no-raw-with-dynamic-arg` to mark a call as intentionally safe.',
|
|
32
32
|
},
|
|
33
33
|
};
|
|
34
34
|
|
|
@@ -47,10 +47,11 @@ function create(context) {
|
|
|
47
47
|
const callee = node.callee;
|
|
48
48
|
if (!callee) return;
|
|
49
49
|
// Match bare `raw(...)` and `kerfjs.raw(...)` / `kerf.raw(...)` shapes.
|
|
50
|
-
const isRaw =
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
50
|
+
const isRaw =
|
|
51
|
+
(callee.type === 'Identifier' && callee.name === 'raw') ||
|
|
52
|
+
(callee.type === 'MemberExpression' &&
|
|
53
|
+
callee.property.type === 'Identifier' &&
|
|
54
|
+
callee.property.name === 'raw');
|
|
54
55
|
if (!isRaw) return;
|
|
55
56
|
if (node.arguments.length === 0) return;
|
|
56
57
|
const arg = node.arguments[0];
|
|
@@ -10,7 +10,8 @@ function findGlobalJSXIntrinsics(moduleBlock) {
|
|
|
10
10
|
for (const m of moduleBlock.body) {
|
|
11
11
|
if (m.type !== 'TSModuleDeclaration') continue;
|
|
12
12
|
const idNode = m.id;
|
|
13
|
-
if (!idNode || idNode.type !== 'Identifier' || idNode.name !== 'JSX')
|
|
13
|
+
if (!idNode || idNode.type !== 'Identifier' || idNode.name !== 'JSX')
|
|
14
|
+
continue;
|
|
14
15
|
const inner = m.body;
|
|
15
16
|
if (!inner || inner.type !== 'TSModuleBlock') continue;
|
|
16
17
|
for (const member of inner.body) {
|
|
@@ -31,7 +32,7 @@ const meta = {
|
|
|
31
32
|
type: 'problem',
|
|
32
33
|
docs: {
|
|
33
34
|
description:
|
|
34
|
-
|
|
35
|
+
'Declaration-merge `JSX.IntrinsicElements` into `kerfjs/jsx-runtime`, not the global namespace.',
|
|
35
36
|
url: 'https://github.com/brianwestphal/kerf/blob/main/eslint-plugin/docs/rules/prefer-module-jsx-augmentation.md',
|
|
36
37
|
},
|
|
37
38
|
schema: [],
|
|
@@ -38,10 +38,15 @@ const meta = {
|
|
|
38
38
|
function create(context) {
|
|
39
39
|
return {
|
|
40
40
|
CallExpression(node) {
|
|
41
|
-
if (node.callee.type !== 'Identifier' || node.callee.name !== 'each')
|
|
41
|
+
if (node.callee.type !== 'Identifier' || node.callee.name !== 'each')
|
|
42
|
+
return;
|
|
42
43
|
const cb = node.arguments[1];
|
|
43
44
|
if (!cb) return;
|
|
44
|
-
if (
|
|
45
|
+
if (
|
|
46
|
+
cb.type !== 'ArrowFunctionExpression' &&
|
|
47
|
+
cb.type !== 'FunctionExpression'
|
|
48
|
+
)
|
|
49
|
+
return;
|
|
45
50
|
const root = findRootJSXFromBody(cb.body);
|
|
46
51
|
if (!root) return;
|
|
47
52
|
if (root.type === 'JSXFragment') {
|
|
@@ -52,7 +52,8 @@ function create(context) {
|
|
|
52
52
|
// the disposer is being routed somewhere reachable — accept.
|
|
53
53
|
const parent = node.parent;
|
|
54
54
|
if (!parent) return;
|
|
55
|
-
if (parent.type === 'UnaryExpression' && parent.operator === 'void')
|
|
55
|
+
if (parent.type === 'UnaryExpression' && parent.operator === 'void')
|
|
56
|
+
return;
|
|
56
57
|
if (parent.type !== 'ExpressionStatement') return;
|
|
57
58
|
|
|
58
59
|
context.report({
|