@gusnips/oxlint 0.0.0-stage → 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Gustavo Salomé
+
+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,75 @@
-# Temporary Holding Version
+# @gusnips/oxlint
 
-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.
+Two oxlint configs: `base.json` for a TypeScript repo and `react.json` for a React one. They hold
+the lint core our repos each wrote for ESLint, so a repo keeps only its own rules.
+
+```bash
+bun add -d @gusnips/oxlint oxlint
+```
+
+`.oxlintrc.json`:
+
+```json
+{ "extends": ["./node_modules/@gusnips/oxlint/react.json"] }
+```
+
+`package.json`:
+
+```json
+{ "scripts": { "lint": "oxlint" } }
+```
+
+## What is in them
+
+`base.json` turns on oxlint's `typescript` plugin and its `correctness` rules, as errors. On top of
+that:
+
+- `no-explicit-any` is an error.
+- An unused variable or argument is an error, unless its name starts with `_`.
+- `no-undef` is off. TypeScript already reports names that do not exist.
+- The rules that ESLint's `recommended` and typescript-eslint's `recommended` switch on, and that
+  oxlint keeps outside `correctness`: `ban-ts-comment`, `no-array-constructor`,
+  `no-case-declarations`, `no-empty`, `no-empty-object-type`, `no-fallthrough`, `no-namespace`,
+  `no-prototype-builtins`, `no-regex-spaces`, `no-require-imports`, `no-unexpected-multiline`,
+  `no-unnecessary-type-constraint` and `no-unsafe-function-type`.
+
+`react.json` extends `base.json`, turns on the `react` plugin, and sets what
+`eslint-plugin-react-hooks` 7 sets in `recommended`, at the same level:
+
+- `rules-of-hooks` (error) and `exhaustive-deps` (warning).
+- The React Compiler rules: `static-components`, `use-memo`, `preserve-manual-memoization`,
+  `immutability`, `globals`, `refs`, `set-state-in-effect`, `error-boundaries` and
+  `set-state-in-render` (errors), and `incompatible-library` (warning).
+
+Not there:
+
+- `unsupported-syntax`, `config` and `gating`. oxlint does not have them yet.
+- `react/purity` is off. It reports `new Date()` in a component, and the ESLint plugin does not. The
+  plugin still reports `Date.now()` and `Math.random()`.
+- `react/jsx-key` is off. It reports the `components={[<b />, <i />]}` array that react-i18next's
+  `Trans` takes.
+- `react/react-in-jsx-scope` is off. The JSX transform does not need `React` in scope.
+- A refresh rule. Most of our repos turn `only-export-components` off.
+
+Turn any of them on in your own file.
+
+## Your own rules
+
+Write them in your `.oxlintrc.json`, next to `extends`. Yours win.
+
+```json
+{
+  "extends": ["./node_modules/@gusnips/oxlint/react.json"],
+  "rules": { "no-console": "error" },
+  "overrides": [{ "files": ["**/*.test.ts"], "rules": { "typescript/no-explicit-any": "off" } }]
+}
+```
+
+## Good to know
+
+- `ignorePatterns` does not come through `extends`. oxlint skips what `.gitignore` lists, which
+  covers `dist` and `.turbo`. Anything else goes in your own file.
+- `plugins` add up. A repo that sets none also gets oxlint's `unicorn` and `oxc` plugins, which the
+  ESLint core did not have. Write `"plugins": []` to keep only the ones the preset names.
+- Rules that need types, like `no-floating-promises`, stay off until you run `oxlint --type-aware`.
+- It needs oxlint 1.93 or newer.

package/base.json

@@ -0,0 +1,23 @@
+{
+  "plugins": ["typescript"],
+  "categories": { "correctness": "error" },
+  "rules": {
+    "no-undef": "off",
+    "no-unused-vars": ["error", { "argsIgnorePattern": "^_", "varsIgnorePattern": "^_" }],
+    "typescript/no-explicit-any": "error",
+
+    "no-array-constructor": "error",
+    "no-case-declarations": "error",
+    "no-empty": "error",
+    "no-fallthrough": "error",
+    "no-prototype-builtins": "error",
+    "no-regex-spaces": "error",
+    "no-unexpected-multiline": "error",
+    "typescript/ban-ts-comment": "error",
+    "typescript/no-empty-object-type": "error",
+    "typescript/no-namespace": "error",
+    "typescript/no-require-imports": "error",
+    "typescript/no-unnecessary-type-constraint": "error",
+    "typescript/no-unsafe-function-type": "error"
+  }
+}

package/package.json

@@ -1,6 +1,57 @@
 {
   "name": "@gusnips/oxlint",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.1.0",
+  "description": "One oxlint config for a TypeScript repo, and one for a React repo. Rules go on top of it in the repo's own .oxlintrc.json.",
+  "type": "module",
+  "license": "MIT",
+  "author": "Gustavo Salomé",
+  "homepage": "https://github.com/gusnips/kit/tree/main/oxlint#readme",
+  "bugs": {
+    "url": "https://github.com/gusnips/kit/issues"
+  },
+  "exports": {
+    "./base.json": "./base.json",
+    "./react.json": "./react.json"
+  },
+  "files": [
+    "base.json",
+    "react.json",
+    "README.md",
+    "LICENSE"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "keywords": [
+    "oxlint",
+    "lint",
+    "typescript",
+    "react",
+    "react-hooks",
+    "config"
+  ],
+  "peerDependencies": {
+    "oxlint": "^1.93.0"
+  },
+  "scripts": {
+    "build": "bun run scripts/check-preset.ts",
+    "typecheck": "tsc --noEmit -p tsconfig.json",
+    "test": "bun run scripts/check-preset.ts",
+    "lint": "eslint scripts",
+    "sync:docs": "cp ../LICENSE .",
+    "prepublishOnly": "bun run lint && bun run typecheck && bun run test && bun run sync:docs",
+    "release:patch": "bun pm version patch && bun publish --access public",
+    "release:minor": "bun pm version minor && bun publish --access public",
+    "release:major": "bun pm version major && bun publish --access public"
+  },
+  "devDependencies": {
+    "@types/node": "^24.12.0",
+    "oxlint": "1.93.0",
+    "typescript": "^5.9.3"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/gusnips/kit.git",
+    "directory": "oxlint"
+  }
+}

package/react.json

@@ -0,0 +1,22 @@
+{
+  "extends": ["./base.json"],
+  "plugins": ["react"],
+  "rules": {
+    "react/react-in-jsx-scope": "off",
+    "react/jsx-key": "off",
+    "react/purity": "off",
+
+    "react/rules-of-hooks": "error",
+    "react/exhaustive-deps": "warn",
+    "react/static-components": "error",
+    "react/use-memo": "error",
+    "react/preserve-manual-memoization": "error",
+    "react/incompatible-library": "warn",
+    "react/immutability": "error",
+    "react/globals": "error",
+    "react/refs": "error",
+    "react/set-state-in-effect": "error",
+    "react/error-boundaries": "error",
+    "react/set-state-in-render": "error"
+  }
+}