@yoo-digital/oxlint-config-react 0.0.0-stage → 0.1.1-canary.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 YOO AG
+
+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,63 @@
-# Temporary Holding Version
+# YOO Oxlint Configuration for React Projects
 
-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.
+[![npm version](https://badge.fury.io/js/%40yoo-digital%2Foxlint-config-react.svg)](https://www.npmjs.com/package/@yoo-digital/oxlint-config-react)
+
+Contains the settings and rules used for React projects based on TypeScript within YOO.
+It is publicly available via the npm registry.
+
+## Purpose
+
+The exported `oxlint.config.mjs` file contains an [Oxlint](https://oxc.rs/docs/guide/usage/linter/) config based on the rules recommended by Oxlint.
+This configuration extends the [YOO Base Oxlint config](https://www.npmjs.com/package/@yoo-digital/oxlint-config-base) and is aligned
+with our [coding guidelines](https://yooapps.jira.com/wiki/spaces/FD/pages/1239187573/Coding+Guidelines).
+
+## Usage
+
+In order to use the Oxlint configuration file in your project, you will have to install
+its dependencies (including peer-dependencies). The following command should work
+for both _npm_ and _yarn_. It will detect the proper client.
+
+```text
+npx install-peerdeps --dev @yoo-digital/oxlint-config-react
+```
+
+After installing the packages, you can create an [Oxlint configuration file](https://oxc.rs/docs/guide/usage/linter/config.html)
+named `oxlint.config.mts` in the root of your project and add the following lines:
+
+```typescript
+import yooOxlintConfigReact from '@yoo-digital/oxlint-config-react';
+import { defineConfig } from 'oxlint';
+
+export default defineConfig({
+  extends: [yooOxlintConfigReact],
+  // your own rules
+});
+```
+
+Then run `oxlint` (or `oxlint ./src`) to lint your project.
+
+The configuration enables type-aware linting (`options.typeAware`), which uses `oxlint-tsgolint`.
+
+You can apply your own set of rules on top of that, but do not turn off any of the rules, except it is an obstacle and making your life harder.
+
+## Rules
+
+This configuration extends the base configuration with Oxlint's native `react` and `jsx-a11y` plugins,
+using their rules of the `correctness` category.
+
+On top of that, the following rules are adjusted:
+
+| Rule                            | Setting                                                                                      |
+| ------------------------------- | -------------------------------------------------------------------------------------------- |
+| `react/rules-of-hooks`          | error                                                                                        |
+| `react/jsx-key`                 | error, also checks that `key` is placed before spread props and that keys are not duplicated |
+| `react/jsx-no-useless-fragment` | warn                                                                                         |
+| `react/no-array-index-key`      | warn                                                                                         |
+
+## Development
+
+**Important**: This configuration should only contain rules concerning React.js.
+
+Before creating a pull request or publishing changes, make sure you tested your changes.
+Within this mono-repository you will find an example React application in the `examples/react-app` directory and a Next.js application in the `examples/nextjs-app` directory.
+Run `pnpm lint` in these directories to test your changes.

package/oxlint.config.d.mts

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

package/oxlint.config.mjs

@@ -0,0 +1,14 @@
+// @ts-check
+import baseConfig from '@yoo-digital/oxlint-config-base';
+import { defineConfig } from 'oxlint';
+
+export default defineConfig({
+  extends: [baseConfig],
+  plugins: ['react', 'jsx-a11y'],
+  rules: {
+    'react/jsx-key': ['error', { checkKeyMustBeforeSpread: true, warnOnDuplicates: true }],
+    'react/jsx-no-useless-fragment': 'warn',
+    'react/no-array-index-key': 'warn',
+    'react/rules-of-hooks': 'error',
+  },
+});

package/package.json

@@ -1,6 +1,93 @@
 {
   "name": "@yoo-digital/oxlint-config-react",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "description": "Oxlint configuration file containing rules for React projects using TypeScript",
+  "version": "0.1.1-canary.0",
+  "license": "MIT",
+  "publishConfig": {
+    "access": "public"
+  },
+  "keywords": [
+    "TypeScript",
+    "React",
+    "Oxlint"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git@github.com:yoo-digital/config.git",
+    "directory": "packages/oxlint-config-react"
+  },
+  "author": {
+    "name": "YOO AG",
+    "email": "info@yoo.digital",
+    "url": "https://www.yoo.digital/"
+  },
+  "contributors": [
+    {
+      "name": "Björn Bühler",
+      "email": "bjoern.buehler@yoo.digital"
+    },
+    {
+      "name": "Cédric Madörin",
+      "email": "cedric.madoerin@yoo.digital"
+    },
+    {
+      "name": "Emanuel Marsicovetere",
+      "email": "emanuel.marsicovetere@yoo.digital"
+    },
+    {
+      "name": "Hervé Brunner",
+      "email": "herve.brunner@yoo.digital"
+    },
+    {
+      "name": "Kelvin Louis",
+      "email": "kelvin.louis@yoo.digital"
+    },
+    {
+      "name": "Robin Hahne",
+      "email": "robin.hahne@yoo.digital"
+    },
+    {
+      "name": "Sacha Schmid",
+      "email": "sacha.schmid@yoo.digital"
+    },
+    {
+      "name": "Tobias Maier",
+      "email": "tobias.maier@yoo.digital"
+    },
+    {
+      "name": "Tobias Wahl",
+      "email": "tobias.wahl@yoo.digital"
+    },
+    {
+      "name": "Yanick Recher",
+      "email": "yanick.recher@yoo.digital"
+    }
+  ],
+  "exports": {
+    ".": {
+      "types": "./oxlint.config.d.mts",
+      "import": "./oxlint.config.mjs"
+    }
+  },
+  "types": "./oxlint.config.d.mts",
+  "files": [
+    "LICENSE",
+    "README.md",
+    "oxlint.config.d.mts",
+    "oxlint.config.mjs"
+  ],
+  "engines": {
+    "node": ">=24",
+    "pnpm": ">=11"
+  },
+  "dependencies": {
+    "@yoo-digital/oxlint-config-base": "~0.1.1-canary.0"
+  },
+  "devDependencies": {
+    "oxlint": "~1.91.0",
+    "typescript": "~6.0.3"
+  },
+  "peerDependencies": {
+    "oxlint": "^1.91.0"
+  }
 }