oxlint-plugin-effector 0.0.1

package/LICENSE

@@ -0,0 +1,24 @@
+MIT License
+
+Copyright (c) 2026 Marsel Abazbekov
+
+Rules ported from eslint-plugin-effector (https://github.com/effector/eslint-plugin),
+Copyright (c) Igor Kamyshev, also MIT licensed.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,121 @@
+# oxlint-plugin-effector
+
+Enforce [Effector](https://effector.dev) best practices with [oxlint](https://oxc.rs).
+
+A **full, type-aware** port of [`eslint-plugin-effector`](https://github.com/effector/eslint-plugin) to oxlint's
+[custom JS plugin API](https://oxc.rs/docs/guide/usage/linter/js-plugins). All **22 rules** are the original rules,
+unchanged — this package runs the upstream plugin's entire test suite (349 cases) against the real TypeScript type
+checker and passes it.
+
+## How it stays type-aware on oxlint
+
+The Effector rules need TypeScript types (to tell a `Store` from an `Event`, follow units across files, etc.).
+oxlint does not hand type information to JS plugins. So instead of relying on it, **the plugin builds its own
+`ts.Program`** using the `typescript` package directly and calls `getTypeAtLocation` itself, mapping oxlint's AST
+nodes to TS nodes by source range. Under ESLint / the test runner it transparently uses the parser's existing
+services; under oxlint it constructs its own. Same rule code, real types, either way. There is **no
+`@typescript-eslint` in the runtime** — the only runtime dependencies are `typescript` (peer) and `esquery`.
+
+Program discovery (`src/shared/services.ts`) is on plain `typescript` and handles the awkward setups:
+
+- the nearest `tsconfig.json` is used; **project references are followed**, so a solution-style root tsconfig
+  (only `references`, no `files`) resolves the project that actually owns the file;
+- if no tsconfig is found, a node-resolution fallback is used so `effector`/`react` types still resolve;
+- set **`OXLINT_EFFECTOR_TSCONFIG`** to point at a specific tsconfig (custom names, monorepo roots).
+
+Trade-off: building a TypeScript program means these rules are not "native oxlint" fast — the first lint of a
+project pays for program creation. Functionally there are **no limitations** versus `eslint-plugin-effector`
+(the full upstream test suite — 349 cases — passes against the real type checker).
+
+## Installation
+
+```sh
+npm install -D oxlint oxlint-plugin-effector typescript
+```
+
+oxlint JS plugins require an oxlint version that supports `jsPlugins`. `typescript` is a peer dependency (the
+plugin uses it for type analysis).
+
+## Usage
+
+Register the plugin under `jsPlugins`; rules are namespaced `effector/<rule>`.
+
+```jsonc
+// .oxlintrc.json
+{
+  "jsPlugins": ["oxlint-plugin-effector"],
+  "rules": {
+    "effector/enforce-store-naming-convention": ["error", { "mode": "prefix" }],
+    "effector/no-watch": "warn",
+    "effector/no-getState": "error"
+  }
+}
+```
+
+Severity presets are exported on `effector.configs` (`recommended`, `react`, `scope`, `future`, `patronum`) for use
+from a JS/TS config:
+
+```js
+// oxlint.config.js
+import effector from "oxlint-plugin-effector"
+
+export default {
+  jsPlugins: ["oxlint-plugin-effector"],
+  rules: { ...effector.configs.recommended, ...effector.configs.react },
+}
+```
+
+## Rules
+
+### `recommended`
+
+| Rule | Description |
+| --- | --- |
+| `enforce-effect-naming-convention` | Enforce `Fx` suffix for Effects |
+| `enforce-store-naming-convention` | Enforce `$` prefix/postfix for Stores |
+| `keep-options-order` | Enforce options order for Effector methods |
+| `no-ambiguity-target` | Forbid ambiguous `target` in `sample`/`guard` |
+| `no-duplicate-on` | Forbid duplicate `.on` calls on Stores |
+| `no-forward` | Prefer `sample` over `forward` |
+| `no-getState` | Forbid `.getState` on Stores |
+| `no-guard` | Prefer `sample` over `guard` |
+| `no-unnecessary-combination` | Forbid unnecessary `combine`/`merge` in `clock`/`source` |
+| `no-unnecessary-duplication` | Forbid duplicate `source` and `clock` |
+| `no-useless-methods` | Forbid useless `sample`/`guard` calls |
+| `no-watch` | Restrict `.watch` on units |
+
+### `react`
+
+| Rule | Description |
+| --- | --- |
+| `enforce-gate-naming-convention` | Enforce capitalized Gate names |
+| `enforce-exhaustive-useUnit-destructuring` | Ensure units passed to `useUnit` are destructured |
+| `mandatory-scope-binding` | Forbid Event/Effect usage without `useUnit` |
+| `no-units-spawn-in-render` | Forbid creating units / calling operators in render |
+| `prefer-useUnit` | Prefer `useUnit` over `useStore`/`useEvent` |
+
+### `scope`
+
+| Rule | Description |
+| --- | --- |
+| `require-pickup-in-persist` | Require `pickup` in `effector-storage` `persist` |
+| `strict-effect-handlers` | Forbid mixing regular async fns and Effects |
+
+### `future`
+
+| Rule | Description |
+| --- | --- |
+| `no-domain-unit-creators` | Disallow Domain methods to create units |
+
+### `patronum`
+
+| Rule | Description |
+| --- | --- |
+| `no-patronum-debug` | Disallow `patronum`'s `debug` |
+
+See [`examples/vite-comparison`](./examples/vite-comparison) for a project linted by both this plugin and
+`eslint-plugin-effector`, producing identical results.
+
+## License
+
+MIT. Rules ported from [`eslint-plugin-effector`](https://github.com/effector/eslint-plugin) (MIT).