@clipboard-health/oxlint-config 1.0.0

package/README.md

@@ -0,0 +1,68 @@
+# @clipboard-health/oxlint-config <!-- omit from toc -->
+
+Shared [Oxlint](https://oxc.rs/docs/guide/usage/linter) configuration for Clipboard Health repositories.
+
+## Table of contents <!-- omit from toc -->
+
+- [Install](#install)
+- [Usage](#usage)
+- [What is shared](#what-is-shared)
+
+## Install
+
+```bash
+npm install @clipboard-health/oxlint-config
+```
+
+## Usage
+
+Oxlint's `extends` only inherits `rules`, `plugins`, and `overrides`. Properties like `categories`, `options`, `settings`, and `ignorePatterns` must be set in each repo's local config.
+
+Create an `.oxlintrc.json` in your repo root:
+
+```json
+{
+  "$schema": "./node_modules/oxlint/configuration_schema.json",
+  "extends": ["./node_modules/@clipboard-health/oxlint-config/src/base.json"],
+  "categories": {
+    "correctness": "error",
+    "nursery": "error",
+    "pedantic": "error",
+    "perf": "error",
+    "restriction": "error",
+    "style": "error",
+    "suspicious": "error"
+  },
+  "ignorePatterns": [".agents", "coverage/", "node_modules/"],
+  "options": {
+    "denyWarnings": true,
+    "reportUnusedDisableDirectives": "error",
+    "typeAware": true,
+    "typeCheck": true
+  },
+  "settings": {
+    "node": {
+      "version": ">=24.14.0"
+    }
+  }
+}
+```
+
+Override shared rules as needed:
+
+```json
+{
+  "extends": ["./node_modules/@clipboard-health/oxlint-config/src/base.json"],
+  "rules": {
+    "no-console": "off"
+  }
+}
+```
+
+## What is shared
+
+The `base.json` config includes:
+
+- **Plugins**: eslint, typescript, unicorn, oxc, import, jsdoc, node, promise
+- **Rules**: Opinionated defaults with select rules disabled
+- **Overrides**: Root-level files, vitest config, test files, and script files

package/package.json

@@ -0,0 +1,23 @@
+{
+  "name": "@clipboard-health/oxlint-config",
+  "version": "1.0.0",
+  "description": "Shared Oxlint configuration for Clipboard Health repositories.",
+  "keywords": [
+    "config",
+    "oxlint"
+  ],
+  "bugs": "https://github.com/ClipboardHealth/core-utils/issues",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ClipboardHealth/core-utils.git",
+    "directory": "packages/oxlint-config"
+  },
+  "type": "commonjs",
+  "main": "./src/index.js",
+  "typings": "./src/index.d.ts",
+  "publishConfig": {
+    "access": "public"
+  },
+  "types": "./src/index.d.ts"
+}

package/src/base.json

@@ -0,0 +1,92 @@
+{
+  "plugins": ["eslint", "typescript", "unicorn", "oxc", "import", "jsdoc", "node", "promise"],
+  "rules": {
+    "curly": ["error", "all"],
+    "func-style": ["error", "declaration"],
+    "id-length": "off",
+    "import/consistent-type-specifier-style": "off",
+    "import/exports-last": "off",
+    "import/group-exports": "off",
+    "import/no-cycle": ["error", { "ignoreExternal": true, "maxDepth": 16 }],
+    "import/no-nodejs-modules": "off",
+    "import/no-relative-parent-imports": "off",
+    "import/prefer-default-export": "off",
+    "init-declarations": "off",
+    "max-statements": "off",
+    "no-magic-numbers": "off",
+    "no-named-export": "off",
+    "no-ternary": "off",
+    "no-undef": "off",
+    "no-unused-vars": [
+      "warn",
+      {
+        "argsIgnorePattern": "^_",
+        "varsIgnorePattern": "^_",
+        "caughtErrorsIgnorePattern": "^_"
+      }
+    ],
+    "no-undefined": "off",
+    "no-use-before-define": "off",
+    "object-shorthand": ["error", "properties"],
+    "oxc/no-async-await": "off",
+    "oxc/no-optional-chaining": "off",
+    "oxc/no-rest-spread-properties": "off",
+    "promise/avoid-new": "off",
+    "promise/prefer-await-to-callbacks": "off",
+    "require-await": "off",
+    "typescript/prefer-readonly-parameter-types": "off",
+    "typescript/promise-function-async": "off",
+    "unicorn/filename-case": ["error", { "case": "camelCase" }],
+    "unicorn/no-null": "off",
+    "unicorn/prevent-abbreviations": ["error", { "ignore": ["config", "params", "props", "ref"] }]
+  },
+  "overrides": [
+    {
+      "files": ["./*.ts", "./*.js", "./*.cjs"],
+      "rules": {
+        "import/no-anonymous-default-export": "off",
+        "import/no-commonjs": "off",
+        "import/no-default-export": "off",
+        "import/unambiguous": "off",
+        "sort-imports": "off",
+        "typescript/no-unsafe-argument": "off",
+        "typescript/no-unsafe-assignment": "off",
+        "typescript/no-unsafe-call": "off",
+        "typescript/no-unsafe-return": "off",
+        "typescript/no-unsafe-member-access": "off",
+        "typescript/strict-boolean-expressions": "off",
+        "unicorn/prefer-module": "off"
+      }
+    },
+    {
+      "files": ["**/vitest.config.ts"],
+      "rules": {
+        "import/no-default-export": "off"
+      }
+    },
+    {
+      "files": ["**/*.test.ts", "**/*.spec.ts"],
+      "rules": {
+        "max-lines": "off",
+        "max-lines-per-function": "off"
+      }
+    },
+    {
+      "files": ["**/scripts/**/*.ts"],
+      "rules": {
+        "max-lines": "off",
+        "max-lines-per-function": "off",
+        "no-console": "off",
+        "no-plusplus": "off",
+        "node/no-process-env": "off",
+        "sort-imports": "off",
+        "sort-keys": "off",
+        "typescript/no-non-null-assertion": "off",
+        "typescript/no-unnecessary-condition": "off",
+        "typescript/no-unsafe-type-assertion": "off",
+        "typescript/strict-boolean-expressions": "off",
+        "unicorn/no-process-exit": "off"
+      }
+    }
+  ]
+}

package/src/index.d.ts

@@ -0,0 +1 @@
+export { default as base } from "./base.json";

package/src/index.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.base = void 0;
+const tslib_1 = require("tslib");
+var base_json_1 = require("./base.json");
+Object.defineProperty(exports, "base", { enumerable: true, get: function () { return tslib_1.__importDefault(base_json_1).default; } });
+//# sourceMappingURL=index.js.map

package/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../packages/oxlint-config/src/index.ts"],"names":[],"mappings":";;;;AAAA,yCAA8C;AAArC,0HAAA,OAAO,OAAQ"}