@elnop/oxlint-config-react 0.0.0-stage → 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 elnop
+
+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

@@ -1,3 +1,22 @@
-# Temporary Holding Version
+# @elnop/oxlint-config-react
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Oxlint config for React with TypeScript. It extends [@elnop/oxlint-config-typescript](https://www.npmjs.com/package/@elnop/oxlint-config-typescript) and adds:
+
+- the `react` plugin and the `browser` env
+- `react/rules-of-hooks`, `react/exhaustive-deps` and `react/only-export-components`
+- a component types its props with a named type called after it: `function Card({ title }: CardProps)`. Untyped props, inline object types and other type names are reported.
+
+```sh
+npm install --save-dev oxlint @elnop/oxlint-config-react
+```
+
+```ts
+import { reactConfig } from '@elnop/oxlint-config-react';
+import { defineConfig } from 'oxlint';
+
+export default defineConfig({
+  extends: [reactConfig],
+});
+```
+
+For a Vite app, [@elnop/oxlint-config-react-vite](https://www.npmjs.com/package/@elnop/oxlint-config-react-vite) adds the Vite specific settings on top.

package/dist/ReactConfig.d.ts

@@ -0,0 +1,104 @@
+export declare const reactConfig: {
+    extends: {
+        plugins: ("import" | "oxc" | "typescript" | "unicorn")[];
+        jsPlugins: {
+            name: string;
+            specifier: string;
+        }[];
+        categories: {
+            correctness: "error";
+            suspicious: "error";
+        };
+        env: {
+            es2024: true;
+        };
+        rules: {
+            'import/no-cycle': "error";
+            'import/no-self-import': "error";
+            'import/no-duplicates': "error";
+            'typescript/no-floating-promises': "error";
+            'typescript/no-misused-promises': "error";
+            'typescript/await-thenable': "error";
+            'typescript/no-unnecessary-type-assertion': "error";
+            'typescript/consistent-type-imports': "error";
+            'typescript/no-explicit-any': "error";
+            'no-shadow': "off";
+            'unicorn/consistent-function-scoping': "off";
+            'typescript/consistent-return': "off";
+            'oxc/no-barrel-file': ["error", {
+                threshold: number;
+            }];
+            'unicorn/filename-case': ["error", {
+                cases: {
+                    camelCase: boolean;
+                    pascalCase: boolean;
+                };
+            }];
+            'no-comments/disallowComments': ["error", {
+                allow: ("/ <reference " | "/usr/bin/env " | "@ts-expect-error" | "@ts-ignore" | "@ts-nocheck" | "eslint-" | "oxlint-")[];
+            }];
+            'check-file/no-index': ["error", {
+                errorMessage: "Barrel files ({{ target }}) are not allowed: import each module by its own path";
+            }];
+            'check-file/filename-blocklist': ["error", {
+                '**/types.ts': "*Types.ts";
+            }];
+            'file-named-after-export/file-named-after-export': "error";
+        };
+        overrides: ({
+            files: string[];
+            rules: {
+                'export-placement/no-restricted-syntax': ["error", ...{
+                    selector: string;
+                    message: string;
+                }[]];
+                'typescript/no-floating-promises'?: undefined;
+                'file-named-after-export/file-named-after-export'?: undefined;
+            };
+        } | {
+            files: string[];
+            rules: {
+                'typescript/no-floating-promises': "off";
+                'export-placement/no-restricted-syntax'?: undefined;
+                'file-named-after-export/file-named-after-export'?: undefined;
+            };
+        } | {
+            files: string[];
+            rules: {
+                'typescript/no-floating-promises'?: undefined;
+                'export-placement/no-restricted-syntax': "off";
+                'file-named-after-export/file-named-after-export': "off";
+            };
+        })[];
+    }[];
+    plugins: ("import" | "oxc" | "react" | "typescript" | "unicorn")[];
+    jsPlugins: {
+        name: string;
+        specifier: string;
+    }[];
+    env: {
+        browser: true;
+        es2024: true;
+    };
+    rules: {
+        'react/rules-of-hooks': "error";
+        'react/hooks': "off";
+        'react/exhaustive-deps': "error";
+        'react/only-export-components': "error";
+        'react/react-in-jsx-scope': "off";
+    };
+    overrides: ({
+        files: string[];
+        rules: {
+            'component-props/no-restricted-syntax': ["error", ...{
+                selector: string;
+                message: string;
+            }[]];
+        };
+    } | {
+        files: string[];
+        rules: {
+            'component-props/no-restricted-syntax': "off";
+        };
+    })[];
+};

package/dist/ReactConfig.js

@@ -0,0 +1,34 @@
+import { typescriptConfig } from '@elnop/oxlint-config-typescript';
+import { fileURLToPath } from 'node:url';
+import { defineConfig } from 'oxlint';
+const COMPONENT_PROPS = [
+    {
+        selector: ':matches(FunctionDeclaration[id.name=/^[A-Z]/], VariableDeclarator[id.name=/^[A-Z]/] > :matches(ArrowFunctionExpression, FunctionExpression)) > :matches(ObjectPattern, Identifier).params[typeAnnotation=null]',
+        message: 'A component types its props with a named type called after it: ComponentProps.',
+    },
+    {
+        selector: ':matches(FunctionDeclaration[id.name=/^[A-Z]/], VariableDeclarator[id.name=/^[A-Z]/] > :matches(ArrowFunctionExpression, FunctionExpression)) > :matches(ObjectPattern, Identifier).params > TSTypeAnnotation > TSTypeLiteral',
+        message: 'A component types its props with a named type called after it: ComponentProps.',
+    },
+    {
+        selector: ':matches(FunctionDeclaration[id.name=/^[A-Z]/], VariableDeclarator[id.name=/^[A-Z]/] > :matches(ArrowFunctionExpression, FunctionExpression)) > :matches(ObjectPattern, Identifier).params > TSTypeAnnotation > TSTypeReference > Identifier.typeName[name!=/^[A-Z]\\w*Props$/]',
+        message: 'A component types its props with a named type called after it: ComponentProps.',
+    },
+];
+export const reactConfig = defineConfig({
+    extends: [typescriptConfig],
+    plugins: ['typescript', 'react', 'import', 'oxc', 'unicorn'],
+    jsPlugins: [{ name: 'component-props', specifier: fileURLToPath(new URL('./plugin.js', import.meta.url)) }],
+    env: { browser: true, es2024: true },
+    rules: {
+        'react/rules-of-hooks': 'error',
+        'react/hooks': 'off',
+        'react/exhaustive-deps': 'error',
+        'react/only-export-components': 'error',
+        'react/react-in-jsx-scope': 'off',
+    },
+    overrides: [
+        { files: ['**/*.tsx'], rules: { 'component-props/no-restricted-syntax': ['error', ...COMPONENT_PROPS] } },
+        { files: ['**/*.test.tsx', 'e2e/**'], rules: { 'component-props/no-restricted-syntax': 'off' } },
+    ],
+});

package/dist/plugin.d.ts

@@ -0,0 +1,9 @@
+declare const _default: {
+    meta: {
+        name: string;
+    };
+    rules: {
+        'no-restricted-syntax': unknown;
+    };
+};
+export default _default;

package/dist/plugin.js

@@ -0,0 +1,2 @@
+import eslintRules from 'oxlint-plugin-eslint';
+export default { meta: { name: 'component-props' }, rules: { 'no-restricted-syntax': eslintRules.rules['no-restricted-syntax'] } };

package/package.json

@@ -1,6 +1,41 @@
 {
   "name": "@elnop/oxlint-config-react",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.1.0",
+  "description": "Oxlint config for React with TypeScript: hooks rules and named XProps types for components.",
+  "keywords": [
+    "oxlint",
+    "oxlint-config",
+    "react",
+    "typescript",
+    "lint"
+  ],
+  "homepage": "https://github.com/Elnop/eslint-plugins/tree/main/packages/configs/oxlint-config-react#readme",
+  "bugs": "https://github.com/Elnop/eslint-plugins/issues",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Elnop/eslint-plugins.git",
+    "directory": "packages/configs/oxlint-config-react"
+  },
+  "license": "MIT",
+  "author": "elnop",
+  "type": "module",
+  "files": [
+    "dist",
+    "!dist/tsconfig.tsbuildinfo"
+  ],
+  "exports": "./dist/ReactConfig.js",
+  "scripts": {
+    "test": "node --test '**/*.test.ts'"
+  },
+  "dependencies": {
+    "@elnop/oxlint-config-typescript": "^0.1.0",
+    "oxlint-plugin-eslint": "^1.91.0"
+  },
+  "peerDependencies": {
+    "oxlint": "^1.91.0"
+  },
+  "devDependencies": {
+    "@elnop/lint-utils": "^0.1.0",
+    "oxlint": "^1.91.0"
+  }
+}