@kayahr/oxlint-config 1.0.1

package/.oxlintrc.json

@@ -0,0 +1,87 @@
+{
+    "$schema": "node_modules/oxlint/configuration_schema.json",
+    "categories": {
+        "correctness": "warn",
+        "nursery": "warn",
+        "pedantic": "off",
+        "perf": "warn",
+        "restriction": "warn",
+        "style": "warn",
+        "suspicious": "warn"
+    },
+    "plugins": [
+        "eslint",
+        "import",
+        "jsdoc",
+        "jsx-a11y",
+        "node",
+        "oxc",
+        "promise",
+        "regex",
+        "typescript",
+        "unicorn"
+    ],
+    "rules": {
+        "eslint/eqeqeq": [
+            "warn",
+            "always",
+            {
+                "null": "ignore"
+            }
+        ],
+        "eslint/func-style": [
+            "warn",
+            "declaration",
+            {
+                "overrides": {
+                    "allowArrowFunctions": true,
+                    "namedExports": "declaration"
+                }
+            }
+        ],
+        "eslint/id-length": "off",
+        "eslint/init-declarations": "off",
+        "eslint/max-lines": "off",
+        "eslint/max-lines-per-function": "off",
+        "eslint/no-await-in-loop": "off",
+        "eslint/no-eq-null": "off",
+        "eslint/no-magic-numbers": "off",
+        "eslint/no-ternary": "off",
+        "eslint/prefer-destructuring": "off",
+        "eslint/radix": "off",
+        "eslint/require-await": "warn",
+        "eslint/sort-imports": "off",
+        "eslint/sort-keys": "off",
+        "import/exports-last": "off",
+        "import/group-exports": "off",
+        "import/prefer-default-export": "off",
+        "jsdoc/require-param": "warn",
+        "jsdoc/require-param-type": "off",
+        "jsdoc/require-returns-type": "off",
+        "oxc/no-async-await": "off",
+        "oxc/no-optional-chaining": "off",
+        "promise/avoid-new": "off",
+        "promise/prefer-await-to-callbacks": "off",
+        "typescript/array-type": [
+            "warn",
+            {
+                "default": "array-simple",
+                "readonly": "array-simple"
+            }
+        ],
+        "typescript/no-unsafe-type-assertion": "off",
+        "typescript/promise-function-async": "off",
+        "unicorn/no-null": "off",
+        "unicorn/prefer-event-target": "off",
+        "unicorn/prefer-node-protocol": "warn",
+        "unicorn/prefer-number-properties": "off"
+    },
+    "overrides": [
+        {
+            "files": [ "**/*.test.ts" ],
+            "rules": {
+                "no-floating-promises": "off"
+            }
+        }
+    ]
+}

package/LICENSE.md

@@ -0,0 +1,21 @@
+# MIT LICENSE
+
+Copyright (c) 2025 Klaus Reimer
+
+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,52 @@
+# @kayahr/oxlint-config
+
+[GitHub] | [NPM]
+
+Shared [oxlint] configuration for my personal TypeScript projects.
+
+## Usage
+
+Install the dependencies:
+
+```bash
+$ npm install -DE @kayahr/oxlint-config
+```
+
+Create an `.oxlintrc.json` configuration file with the following content (modify environment if necessary):
+
+```json
+{
+    "$schema": "node_modules/oxlint/configuration_schema.json",
+    "extends": [
+        "node_modules/@kayahr/oxlint-config/.oxlintrc.json"
+    ],
+    "env": {
+        "node": true,
+        "browser": true
+    }
+}
+```
+
+Add the following script line to `package.json`:
+
+```json
+{
+    "scripts": {
+        "test:lint": "oxlint --type-aware",
+        "test": "npm run test:lint"
+    }
+}
+```
+
+When using the [OXC VSCode extension] extension then enable `typeAware` flag in `.vscode/settings.json`:
+
+```json
+{
+    "oxc.typeAware": true
+}
+```
+
+[GitHub]: https://github.com/kayahr/oxlint-config
+[NPM]: https://www.npmjs.com/package/@kayahr/oxlint-config
+[oxlint]: https://oxc.rs/docs/guide/usage/linter
+[OXC VSCode Extension]: https://marketplace.visualstudio.com/items?itemName=oxc.oxc-vscode

package/package.json

@@ -0,0 +1,32 @@
+{
+    "name": "@kayahr/oxlint-config",
+    "version": "1.0.1",
+    "description": "Shared oxlint config for @kayahr projects",
+    "type": "module",
+    "exports": "./.oxlintrc.json",
+    "license": "MIT",
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/kayahr/oxlint-config.git"
+    },
+    "funding": "https://github.com/kayahr/oxlint-config?sponsor=1",
+    "publishConfig": {
+        "access": "public"
+    },
+    "scripts": {
+        "test": "run test:*",
+        "test:lint": "oxlint --type-aware",
+        "test:spell": "cspell --no-progress"
+    },
+    "files": [
+        ".oxlintrc.json"
+    ],
+    "devDependencies": {
+        "@kayahr/cspell": "9.2.1-bundle.2",
+        "@kayahr/npm-utils": "0.0.2"
+    },
+    "dependencies": {
+        "oxlint": "^1.18.0",
+        "oxlint-tsgolint": "^0.2.0"
+    }
+}