@eimerreis/linting 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Moritz Frölich
+
+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,76 @@
+# @eimerreis/linting
+
+Personal linting and formatting defaults for new JavaScript/TypeScript projects.
+
+Built on:
+
+- `oxlint` for linting
+- `oxfmt` for formatting
+
+Default focus:
+
+- React + TypeScript
+- Next.js
+- Tailwind class sorting
+- Vitest rules
+
+## Install
+
+```bash
+npm add -D @eimerreis/linting oxlint oxfmt
+```
+
+## Quick Start
+
+From your project root:
+
+```bash
+npx @eimerreis/linting init
+```
+
+Or with explicit command name:
+
+```bash
+npx eimerreis-linting init
+```
+
+This creates:
+
+- `.oxlintrc.json`
+- `.oxfmtrc.json`
+
+And updates `package.json` scripts (if present):
+
+- `lint`
+- `lint:fix`
+- `format`
+- `format:check`
+
+### CLI options
+
+```bash
+eimerreis-linting [init] [targetDir] [--force]
+```
+
+- `targetDir`: scaffold config in another directory
+- `--force`: overwrite existing `.oxlintrc.json` / `.oxfmtrc.json` and script values
+
+## Manual Setup
+
+If you do not want to use the init script, create the config files manually.
+
+`.oxlintrc.json`
+
+```json
+{
+  "extends": ["./node_modules/@eimerreis/linting/oxlint.config.json"]
+}
+```
+
+`.oxfmtrc.json`
+
+```json
+{
+  "extends": ["./node_modules/@eimerreis/linting/oxfmt.config.json"]
+}
+```

package/bin/init.mjs

@@ -0,0 +1,102 @@
+#!/usr/bin/env node
+
+import { existsSync, mkdirSync, readFileSync, writeFileSync } from "node:fs";
+import { fileURLToPath } from "node:url";
+import { dirname, resolve } from "node:path";
+import process from "node:process";
+
+const packageName = "@eimerreis/linting";
+const packageRoot = resolve(dirname(fileURLToPath(import.meta.url)), "..");
+
+const rawArgs = process.argv.slice(2);
+
+if (rawArgs.includes("--help") || rawArgs.includes("-h")) {
+  console.log("Usage: eimerreis-linting [init] [targetDir] [--force]");
+  process.exit(0);
+}
+
+const args = rawArgs[0] === "init" ? rawArgs.slice(1) : rawArgs;
+const force = args.includes("--force");
+const targetArg = args.find((arg) => !arg.startsWith("-"));
+const targetDir = resolve(process.cwd(), targetArg ?? ".");
+
+const targetPackageJsonPath = resolve(targetDir, "package.json");
+const oxlintPath = resolve(targetDir, ".oxlintrc.json");
+const oxfmtPath = resolve(targetDir, ".oxfmtrc.json");
+
+function ensureDirectory(filePath) {
+  const dir = dirname(filePath);
+  if (!existsSync(dir)) {
+    mkdirSync(dir, { recursive: true });
+  }
+}
+
+function writeJson(filePath, data) {
+  ensureDirectory(filePath);
+  writeFileSync(filePath, `${JSON.stringify(data, null, 2)}\n`, "utf8");
+}
+
+function readJson(filePath) {
+  return JSON.parse(readFileSync(filePath, "utf8"));
+}
+
+function upsertScript(packageJson, name, command) {
+  if (!packageJson.scripts || typeof packageJson.scripts !== "object") {
+    packageJson.scripts = {};
+  }
+  if (!packageJson.scripts[name] || force) {
+    packageJson.scripts[name] = command;
+  }
+}
+
+function createExtendsConfig(targetPath, exportPath) {
+  if (existsSync(targetPath) && !force) {
+    console.log(`skip ${targetPath} (already exists)`);
+    return;
+  }
+
+  writeJson(targetPath, {
+    extends: [`./node_modules/${packageName}/${exportPath}`],
+  });
+  console.log(`write ${targetPath}`);
+}
+
+function maybeUpdatePackageJson() {
+  if (!existsSync(targetPackageJsonPath)) {
+    console.log("skip package.json (not found)");
+    return;
+  }
+
+  const packageJson = readJson(targetPackageJsonPath);
+
+  upsertScript(packageJson, "lint", "oxlint .");
+  upsertScript(packageJson, "lint:fix", "oxlint --fix .");
+  upsertScript(packageJson, "format", "oxfmt .");
+  upsertScript(packageJson, "format:check", "oxfmt --check .");
+
+  writeJson(targetPackageJsonPath, packageJson);
+  console.log(`update ${targetPackageJsonPath}`);
+}
+
+function printNextSteps() {
+  const relativePath = targetDir === process.cwd() ? "." : targetDir;
+  console.log("done");
+  console.log("next steps:");
+  console.log(`1) cd ${relativePath}`);
+  console.log("2) npm add -D @eimerreis/linting oxlint oxfmt");
+  console.log("3) npm run lint && npm run format:check");
+}
+
+function main() {
+  if (!existsSync(packageRoot)) {
+    console.error("init failed: package root not found");
+    process.exit(1);
+  }
+
+  createExtendsConfig(oxlintPath, "oxlint.config.json");
+  createExtendsConfig(oxfmtPath, "oxfmt.config.json");
+  maybeUpdatePackageJson();
+  printNextSteps();
+}
+
+main();

package/oxfmt.config.json

@@ -0,0 +1,19 @@
+{
+  "$schema": "./node_modules/oxfmt/configuration_schema.json",
+  "printWidth": 125,
+  "tabWidth": 4,
+  "semi": true,
+  "singleQuote": false,
+  "trailingComma": "es5",
+  "sortImports": {
+    "order": "asc",
+    "ignoreCase": true,
+    "newlinesBetween": true,
+    "groups": ["builtin", "external", "internal", ["parent", "sibling", "index"]],
+    "internalPattern": ["@/", "~/"]
+  },
+  "sortTailwindcss": {
+    "functions": ["cn", "clsx", "cva", "tw"]
+  },
+  "ignorePatterns": ["node_modules/**", ".next/**", "dist/**", "build/**", "coverage/**", "out/**"]
+}

package/oxlint.config.json

@@ -0,0 +1,38 @@
+{
+  "$schema": "./node_modules/oxlint/configuration_schema.json",
+  "plugins": ["eslint", "typescript", "unicorn", "oxc", "react", "nextjs", "import", "vitest"],
+  "categories": {
+    "correctness": "error",
+    "suspicious": "warn"
+  },
+  "env": {
+    "browser": true,
+    "node": true,
+    "es6": true
+  },
+  "rules": {
+    "eslint/no-unused-vars": [
+      "warn",
+      {
+        "varsIgnorePattern": "_"
+      }
+    ],
+    "typescript/no-explicit-any": "off",
+    "react/prop-types": "off",
+    "react/react-in-jsx-scope": "off",
+    "react-hooks/refs": "off",
+    "react-hooks/incompatible-library": "off",
+    "import/no-duplicates": "error",
+    "import/no-self-import": "error",
+    "import/no-cycle": "warn"
+  },
+  "ignorePatterns": ["node_modules/**", ".next/**", "dist/**", "build/**", "coverage/**", "out/**"],
+  "overrides": [
+    {
+      "files": ["**/*.{test,spec}.{js,jsx,ts,tsx}", "**/__tests__/**/*.{js,jsx,ts,tsx}"],
+      "rules": {
+        "typescript/no-explicit-any": "off"
+      }
+    }
+  ]
+}

package/package.json

@@ -0,0 +1,57 @@
+{
+  "name": "@eimerreis/linting",
+  "version": "0.1.0",
+  "description": "Personal OXC linting and formatting defaults",
+  "keywords": [
+    "format",
+    "lint",
+    "nextjs",
+    "oxc",
+    "oxfmt",
+    "oxlint",
+    "react",
+    "tailwind",
+    "typescript"
+  ],
+  "license": "MIT",
+  "bin": {
+    "eimerreis-linting": "bin/init.mjs"
+  },
+  "files": [
+    "bin",
+    "oxlint.config.json",
+    "oxfmt.config.json",
+    "README.md",
+    "LICENSE"
+  ],
+  "type": "module",
+  "exports": {
+    "./oxlint": "./oxlint.config.json",
+    "./oxfmt": "./oxfmt.config.json",
+    "./package.json": "./package.json"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "changeset": "changeset",
+    "lint": "oxlint .",
+    "lint:fix": "oxlint --fix .",
+    "format": "oxfmt .",
+    "format:check": "oxfmt --check .",
+    "version-packages": "changeset version",
+    "release": "changeset publish"
+  },
+  "devDependencies": {
+    "@changesets/cli": "^2.29.7",
+    "oxfmt": "^0.41.0",
+    "oxlint": "^1.56.0"
+  },
+  "peerDependencies": {
+    "oxfmt": "^0.41.0",
+    "oxlint": "^1.56.0"
+  },
+  "engines": {
+    "node": "^20.19.0 || >=22.12.0"
+  }
+}