oxlint-config-react-hooks-js 0.0.1 → 1.0.1

package/LICENSE

@@ -0,0 +1,20 @@
+MIT License Copyright (c) 2026 y.takahashi
+
+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 (including the next paragraph) 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

@@ -1,45 +1,164 @@
 # oxlint-config-react-hooks-js
 
-## ⚠️ IMPORTANT NOTICE ⚠️
+Oxlint config presets for [eslint-plugin-react-hooks](https://www.npmjs.com/package/eslint-plugin-react-hooks) as a JS plugin. Provides React Compiler lint rules that are not available in oxlint's native React plugin.
 
-**This package is created solely for the purpose of setting up OIDC (OpenID Connect) trusted publishing with npm.**
+## Why
 
-This is **NOT** a functional package and contains **NO** code or functionality beyond the OIDC setup configuration.
+Oxlint's built-in `react` plugin covers `rules-of-hooks` and `exhaustive-deps` natively, but the React Compiler rules (introduced in eslint-plugin-react-hooks v7) have no native oxlint equivalent. This package bridges the gap by configuring `eslint-plugin-react-hooks` as an oxlint JS plugin with the correct alias and rule settings.
 
-## Purpose
+Rules that oxlint already implements natively are automatically excluded using [@oxlint/migrate](https://www.npmjs.com/package/@oxlint/migrate).
 
-This package exists to:
-1. Configure OIDC trusted publishing for the package name `oxlint-config-react-hooks-js`
-2. Enable secure, token-less publishing from CI/CD workflows
-3. Establish provenance for packages published under this name
+> [!WARNING]
+> This package runs `eslint-plugin-react-hooks` as an oxlint JS plugin, which is significantly slower than oxlint's native Rust-based rules. Expect a noticeable performance hit compared to a native-only setup.
 
-## What is OIDC Trusted Publishing?
+## Presets
 
-OIDC trusted publishing allows package maintainers to publish packages directly from their CI/CD workflows without needing to manage npm access tokens. Instead, it uses OpenID Connect to establish trust between the CI/CD provider (like GitHub Actions) and npm.
+<!-- PRESETS START -->
 
-## Setup Instructions
+| Preset                    | Rules | Source                                                |
+| ------------------------- | ----- | ----------------------------------------------------- |
+| `recommended.json`        | 15    | `recommended` from `eslint-plugin-react-hooks`        |
+| `recommended-latest.json` | 16    | `recommended-latest` from `eslint-plugin-react-hooks` |
 
-To properly configure OIDC trusted publishing for this package:
+<!-- PRESETS END -->
 
-1. Go to [npmjs.com](https://www.npmjs.com/) and navigate to your package settings
-2. Configure the trusted publisher (e.g., GitHub Actions)
-3. Specify the repository and workflow that should be allowed to publish
-4. Use the configured workflow to publish your actual package
+### Rules
 
-## DO NOT USE THIS PACKAGE
+<details>
+<summary>Rule breakdown per preset and opt-in rules</summary>
 
-This package is a placeholder for OIDC configuration only. It:
-- Contains no executable code
-- Provides no functionality
-- Should not be installed as a dependency
-- Exists only for administrative purposes
+<!-- RULES START -->
 
-## More Information
+#### `recommended`
 
-For more details about npm's trusted publishing feature, see:
-- [npm Trusted Publishing Documentation](https://docs.npmjs.com/generating-provenance-statements)
-- [GitHub Actions OIDC Documentation](https://docs.github.com/en/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect)
+Enabled via JS plugin (15 rules, prefixed with `react-hooks-js/`):
 
----
+- `component-hook-factories`
+- `config`
+- `error-boundaries`
+- `gating`
+- `globals`
+- `immutability`
+- `incompatible-library`
+- `preserve-manual-memoization`
+- `purity`
+- `refs`
+- `set-state-in-effect`
+- `set-state-in-render`
+- `static-components`
+- `unsupported-syntax`
+- `use-memo`
 
-**Maintained for OIDC setup purposes only**
+Excluded because oxlint covers them natively (2 rules):
+
+- `exhaustive-deps`
+- `rules-of-hooks`
+
+#### `recommended-latest`
+
+Enabled via JS plugin (16 rules, prefixed with `react-hooks-js/`):
+
+- `component-hook-factories`
+- `config`
+- `error-boundaries`
+- `gating`
+- `globals`
+- `immutability`
+- `incompatible-library`
+- `preserve-manual-memoization`
+- `purity`
+- `refs`
+- `set-state-in-effect`
+- `set-state-in-render`
+- `static-components`
+- `unsupported-syntax`
+- `use-memo`
+- `void-use-memo`
+
+Excluded because oxlint covers them natively (2 rules):
+
+- `exhaustive-deps`
+- `rules-of-hooks`
+
+#### Opt-in rules (not in any preset)
+
+Rules shipped by `eslint-plugin-react-hooks` that no preset enables (11 rules). Add them manually under `rules` with the `react-hooks-js/` prefix (see [Overriding rules](#overriding-rules)):
+
+- `automatic-effect-dependencies`
+- `capitalized-calls`
+- `fbt`
+- `fire`
+- `hooks`
+- `invariant`
+- `memoized-effect-dependencies`
+- `no-deriving-state-in-effects`
+- `rule-suppression`
+- `syntax`
+- `todo`
+
+<!-- RULES END -->
+
+</details>
+
+## Installation
+
+```sh
+pnpm add -D oxlint-config-react-hooks-js eslint-plugin-react-hooks
+```
+
+`eslint-plugin-react-hooks` is a peer dependency and must be installed in your project.
+
+## Usage
+
+### JSON config (`.oxlintrc.json`)
+
+```json
+{
+    "$schema": "./node_modules/oxlint/configuration_schema.json",
+    "extends": ["./node_modules/oxlint-config-react-hooks-js/configs/recommended-latest.json"]
+}
+```
+
+### TypeScript config (`oxlint.config.ts`)
+
+```ts
+import { defineConfig } from "oxlint";
+import reactCompiler from "oxlint-config-react-hooks-js/configs/recommended-latest.json" with { type: "json" };
+
+export default defineConfig({
+    extends: [reactCompiler],
+});
+```
+
+The JSON import is typed as `OxlintConfig` via the bundled type declaration file exposed through the `types` subpath condition.
+
+### Overriding rules
+
+```ts
+import { defineConfig } from "oxlint";
+import reactCompiler from "oxlint-config-react-hooks-js/configs/recommended-latest.json" with { type: "json" };
+
+export default defineConfig({
+    extends: [reactCompiler],
+    rules: {
+        "react-hooks-js/incompatible-library": "off",
+        // Add rules not in the preset
+        "react-hooks-js/todo": "error",
+    },
+});
+```
+
+## How it works
+
+The `scripts/generate.ts` script:
+
+1. Reads the `recommended` and `recommended-latest` configs from `eslint-plugin-react-hooks`
+2. Passes them through `@oxlint/migrate` to identify rules that oxlint implements natively
+3. Excludes native rules and prefixes the remaining rules with the `react-hooks-js` alias
+4. Outputs JSON preset files to `configs/`
+
+The `react-hooks-js` alias is required because `react-hooks` is a reserved plugin name in oxlint (covered by the native `react` plugin).
+
+## License
+
+MIT

package/configs/oxlint-config.d.ts

@@ -0,0 +1,3 @@
+import type { OxlintConfig } from "oxlint";
+declare const config: OxlintConfig;
+export default config;

package/configs/recommended-latest.json

@@ -0,0 +1,26 @@
+{
+    "jsPlugins": [
+        {
+            "name": "react-hooks-js",
+            "specifier": "eslint-plugin-react-hooks"
+        }
+    ],
+    "rules": {
+        "react-hooks-js/static-components": "error",
+        "react-hooks-js/use-memo": "error",
+        "react-hooks-js/void-use-memo": "error",
+        "react-hooks-js/component-hook-factories": "error",
+        "react-hooks-js/preserve-manual-memoization": "error",
+        "react-hooks-js/incompatible-library": "warn",
+        "react-hooks-js/immutability": "error",
+        "react-hooks-js/globals": "error",
+        "react-hooks-js/refs": "error",
+        "react-hooks-js/set-state-in-effect": "error",
+        "react-hooks-js/error-boundaries": "error",
+        "react-hooks-js/purity": "error",
+        "react-hooks-js/set-state-in-render": "error",
+        "react-hooks-js/unsupported-syntax": "warn",
+        "react-hooks-js/config": "error",
+        "react-hooks-js/gating": "error"
+    }
+}

package/configs/recommended.json

@@ -0,0 +1,25 @@
+{
+    "jsPlugins": [
+        {
+            "name": "react-hooks-js",
+            "specifier": "eslint-plugin-react-hooks"
+        }
+    ],
+    "rules": {
+        "react-hooks-js/static-components": "error",
+        "react-hooks-js/use-memo": "error",
+        "react-hooks-js/component-hook-factories": "error",
+        "react-hooks-js/preserve-manual-memoization": "error",
+        "react-hooks-js/incompatible-library": "warn",
+        "react-hooks-js/immutability": "error",
+        "react-hooks-js/globals": "error",
+        "react-hooks-js/refs": "error",
+        "react-hooks-js/set-state-in-effect": "error",
+        "react-hooks-js/error-boundaries": "error",
+        "react-hooks-js/purity": "error",
+        "react-hooks-js/set-state-in-render": "error",
+        "react-hooks-js/unsupported-syntax": "warn",
+        "react-hooks-js/config": "error",
+        "react-hooks-js/gating": "error"
+    }
+}

package/package.json

@@ -1,10 +1,66 @@
 {
-  "name": "oxlint-config-react-hooks-js",
-  "version": "0.0.1",
-  "description": "OIDC trusted publishing setup package for oxlint-config-react-hooks-js",
-  "keywords": [
-    "oidc",
-    "trusted-publishing",
-    "setup"
-  ]
+    "name": "oxlint-config-react-hooks-js",
+    "version": "1.0.1",
+    "description": "Oxlint config presets for eslint-plugin-react-hooks JS plugin (React Compiler rules)",
+    "keywords": [
+        "lint",
+        "oxlint",
+        "react",
+        "react-compiler",
+        "react-hooks"
+    ],
+    "homepage": "https://github.com/eai04191/oxlint-config-react-hooks-js#readme",
+    "bugs": {
+        "url": "https://github.com/eai04191/oxlint-config-react-hooks-js/issues"
+    },
+    "license": "MIT",
+    "author": "y.takahashi <eai@mizle.net> (https://github.com/eai04191)",
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/eai04191/oxlint-config-react-hooks-js.git"
+    },
+    "files": [
+        "configs"
+    ],
+    "type": "module",
+    "exports": {
+        "./configs/*.json": {
+            "types": "./configs/oxlint-config.d.ts",
+            "default": "./configs/*.json"
+        }
+    },
+    "publishConfig": {
+        "directory": "dist"
+    },
+    "scripts": {
+        "generate": "node scripts/generate.ts",
+        "typecheck": "tsc --noEmit",
+        "lint": "oxlint",
+        "format": "oxfmt",
+        "format:check": "oxfmt --check",
+        "test": "node --test",
+        "check": "run-s generate format check:parallel",
+        "check:parallel": "run-p typecheck lint format:check test",
+        "prepack": "run-s generate format && node scripts/prepack.ts"
+    },
+    "devDependencies": {
+        "@oxlint/migrate": "1.59.0",
+        "@tsconfig/strictest": "2.0.8",
+        "@types/node": "25.6.0",
+        "eslint-plugin-react-hooks": "7.0.1",
+        "npm-run-all2": "8.0.4",
+        "oxfmt": "0.44.0",
+        "oxlint": "1.59.0",
+        "oxlint-config-presets": "0.1.6",
+        "oxlint-tsgolint": "0.20.0",
+        "semantic-release": "25.0.3",
+        "typescript": "6.0.2"
+    },
+    "peerDependencies": {
+        "eslint-plugin-react-hooks": ">=7.0.0"
+    },
+    "engines": {
+        "node": ">=24"
+    },
+    "packageManager": "pnpm@10.33.0"
 }