@timmo001/oxlint-rules 0.4.0 → 0.6.0

package/README.md

@@ -69,6 +69,19 @@ the package configs to merge into the target Oxlint config. Effect settings
 remain opt-in. It excludes tests and repository metadata, and refuses to
 replace an existing destination unless `--force` is passed.
 
+## Skills
+
+[`install-timmo-oxlint-rules`](skills/install-timmo-oxlint-rules/SKILL.md)
+guides agents through installing or copying these rules:
+
+```sh
+npx skills add timmo001/oxlint-rules --skill install-timmo-oxlint-rules
+```
+
+[`add-oxlint-rule`](skills/add-oxlint-rule/SKILL.md) and
+[`release-oxlint-rules`](skills/release-oxlint-rules/SKILL.md) are for
+maintaining this package.
+
 ## Rules
 
 ### `anti-slop` and `anti-slop-effect`
@@ -79,23 +92,65 @@ The recommended configs disable
 `timmo/prefer-types-over-assertions`. The upstream rule remains available for
 explicit use.
 
+### Oxlint built-in rules
+
+The recommended configs also enable `typescript/no-non-null-assertion`,
+`typescript/no-unnecessary-type-arguments`,
+`typescript/no-unnecessary-type-assertion`, and
+`typescript/no-unnecessary-type-parameters`. The last three are type-aware, so
+they only run when the consumer enables `typeAware`.
+
 ### `timmo`
 
+- `no-explicit-inferable-type-predicate`: reports explicit `x is T` predicates on
+  non-exported functions whose whole body is a null or `undefined` exclusion, a
+  `typeof` comparison, or an `instanceof` check. TypeScript 5.5 and later infer
+  those predicates, and an explicit predicate is never checked against the
+  body. Methods, exported functions, and `asserts` predicates are left alone.
+- `no-unchecked-query-selector-type`: reports type arguments on
+  `querySelector`, `querySelectorAll`, and `closest`, which cast the result
+  without checking it. Check the element with `instanceof`, use a checked lookup
+  helper, or query a tag name so TypeScript infers the type. Static render-root
+  queries in Lit elements are left to `prefer-lit-query-decorators`.
+- `no-untyped-custom-event`: reports `CustomEvent` used as a type without a
+  detail type, which leaves `detail` as `any`. Reuse the project's typed event
+  helper or add one.
 - `prefer-event-parameter-type`: reports assertions on a handler parameter's
-  `target` or `currentTarget`. Express the target type in the function signature
-  instead so every use sees the same contract.
+  `target`, `currentTarget`, or `detail` (including nested `detail` members).
+  Express the type in the function signature instead so every use sees the same
+  contract.
+- `prefer-lit-query-decorators`: follows eslint-plugin-lit's
+  [`prefer-query-decorators`](https://github.com/43081j/eslint-plugin-lit/blob/master/docs/rules/prefer-query-decorators.md),
+  including its options and `settings.lit.elementBaseClasses`. It also catches
+  non-null, optional, and asserted render roots such as
+  `this.shadowRoot!.querySelector(...)`, and resolves `this` so nested classes
+  and plain functions are not reported. Only static selectors are reported,
+  because a query decorator cannot express a selector built at runtime. Turn
+  off `lit/prefer-query-decorators` when using this rule.
 - `prefer-types-over-assertions`: reports non-`const` TypeScript assertions,
   even when preceded by a `SAFETY:` comment. Type values where they enter the
   code, for example in function parameters or a checked DOM lookup helper that
-  returns `null` when the element is missing or has the wrong type.
+  returns `null` when the element is missing or has the wrong type. Assertions
+  that `prefer-event-parameter-type` reports are skipped here.
 
 ### `timmo-effect`
 
+- `no-raw-gh`: reports the raw `execute`, `json` and `stream` methods called on
+  a `yield* Gh` binding from `@timmo001/effect-gh`, `Api.raw` from that package,
+  and any call whose first argument is `"gh"` or an array starting with `"gh"`,
+  such as `executor.run("gh", ...)` or `Bun.spawn(["gh", ...])`. Use the
+  package's typed operations, and add one to effect-gh when a command has none.
+  effect-gh's own relative imports are not reported.
 - `no-try-catch-in-effect-generators`: diagnoses synchronous `try/catch` owned
   by generators passed directly to `Effect.gen` or the curried `Effect.fn`
   form. It leaves ordinary async polling, nested callback boundaries,
   non-Effect generators, and `try/finally` cleanup alone. The rule is
   diagnostic-only because catch bodies cannot be rewritten safely in general.
+- `prefer-platform-services`: in modules that import `effect`, `effect/*`, or
+  `@effect/*`, reports Node `child_process` and `fs` imports and Bun's `spawn`,
+  `spawnSync`, `$`, `file`, and `write`. Use `ChildProcessSpawner` from
+  `effect/process` and the `FileSystem` service so cleanup, interruption, typed
+  failures, and test layers apply. `fetch` is not reported.
 
 ## Development
 
@@ -103,8 +158,7 @@ Initialise the upstream source and run the package checks:
 
 ```sh
 git submodule update --init --recursive
-mise run check
-mise run build
+mise run check ::: build
 mise run test:package
 npm pack --dry-run
 bunx jsr@0.14.3 publish --dry-run --allow-dirty