@lifeofqui/lint-config 0.0.0-stage → 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Quirin Koch
+
+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,85 @@
-# Temporary Holding Version
+# @lifeofqui/lint-config
 
-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.
+Gemeinsames Lint- und Format-Setup für Vue-/Nuxt-Projekte: **Oxlint** für JS/TS, **ESLint** nur für das, was Oxlint nicht kann (Vue-Templates/SFCs, AST-Selector-Regeln), **Oxfmt** zum Formatieren.
+
+Das Paket bringt Regeln **und** Tool-Versionen mit: `eslint`, `oxlint` und `oxfmt` sind exakt gepinnte Dependencies. Ein Update dieses Pakets aktualisiert also Regeln und Tools in einem Schritt.
+
+> Node `>= 22.18` · npm (die Binaries werden nach `node_modules/.bin` gehoistet)
+
+## Setup in einem Projekt
+
+```bash
+npm i -D @lifeofqui/lint-config
+```
+
+`eslint`, `oxlint`, `oxfmt`, `eslint-plugin-oxlint`, `eslint-plugin-vue`, `@vue/eslint-config-typescript` und `eslint-config-prettier` aus den devDependencies des Projekts entfernen.
+
+**`.oxlintrc.json`**
+
+```json
+{
+  "$schema": "./node_modules/oxlint/configuration_schema.json",
+  "extends": ["./node_modules/@lifeofqui/lint-config/oxlintrc.json"],
+  "ignorePatterns": ["public"]
+}
+```
+
+`ignorePatterns` wird von Oxlint **nicht** über `extends` vererbt und bleibt deshalb im Projekt. `categories`, `plugins`, `rules` und `overrides` kommen aus der Basis.
+
+**`oxfmt.config.ts`** (Oxfmt kennt kein `extends`, daher Spread)
+
+```ts
+import base from '@lifeofqui/lint-config/oxfmt'
+
+export default { ...base }
+```
+
+**`eslint.config.mjs`**
+
+```js
+import { defineLintConfig } from '@lifeofqui/lint-config/eslint'
+
+export default defineLintConfig()
+```
+
+Optionen von `defineLintConfig`:
+
+| Option             | Default              | Zweck                                                                 |
+| ------------------ | -------------------- | --------------------------------------------------------------------- |
+| `ignores`          | `[]`                 | Zusätzliche Ignore-Globs (Nuxt-Build-Ordner sind schon drin)          |
+| `oxlintConfigFile` | `'./.oxlintrc.json'` | Oxlint-Config des Projekts, deren Regeln ESLint abschaltet            |
+| `configs`          | `[]`                 | Projektspezifische Flat-Configs, werden nach den geteilten angewendet |
+
+**Scripts** (Standard, `npm-run-all` im Projekt)
+
+```json
+{
+  "fmt": "oxfmt",
+  "fmt:check": "oxfmt --check",
+  "lint": "run-s --continue-on-error fmt lint:oxlint lint:eslint",
+  "lint:check": "run-s --continue-on-error fmt:check lint:check:oxlint lint:check:eslint",
+  "lint:check:eslint": "eslint . --cache --max-warnings 0",
+  "lint:check:oxlint": "oxlint . --deny-warnings",
+  "lint:eslint": "eslint . --fix --cache --max-warnings 0",
+  "lint:oxlint": "oxlint . --fix --fix-suggestions --deny-warnings"
+}
+```
+
+## Projektspezifische Anpassungen
+
+- **Oxlint**: eigene `rules` / `overrides` in `.oxlintrc.json` nach dem `extends`. Spätere Einträge gewinnen.
+- **Oxfmt**: `export default { ...base, printWidth: 120 }`
+- **ESLint**: `defineLintConfig({ configs: [{ files: ['…'], rules: { … } }] })`
+
+## Updates verteilen
+
+1. Regel oder Tool-Version hier ändern (Tool-Versionen immer exakt pinnen).
+2. Lokal testen: `npm pack`, im Projekt `npm i -D ../lint-config/lifeofqui-lint-config-<version>.tgz`, dann `npm run lint:check`.
+3. `npm version patch|minor|major` und danach `npm publish`.
+4. In den Projekten öffnet Dependabot einen PR (`.github/dependabot.yml`), die CI prüft ihn mit `npm run lint:check`.
+
+Semver: neue oder verschärfte Regeln und Tool-Updates mit Formatierungsänderungen → `minor`, Lockerungen und Fixes → `patch`, geänderte Datei-Struktur oder Optionen → `major`.
+
+## Hinweis zu eslint-plugin-oxlint
+
+`eslint-plugin-oxlint` übernimmt bei `extends` keine `categories`. `defineLintConfig` liest deshalb zusätzlich die Basis-Datei direkt ein, damit ESLint alle Regeln abschaltet, die Oxlint über Kategorien abdeckt.

package/eslint.js

@@ -0,0 +1,100 @@
+import { defineConfigWithVueTs, vueTsConfigs } from '@vue/eslint-config-typescript'
+import skipFormatting from 'eslint-config-prettier'
+import pluginOxlint from 'eslint-plugin-oxlint'
+import pluginVue from 'eslint-plugin-vue'
+import { fileURLToPath } from 'node:url'
+
+const baseOxlintConfigFile = fileURLToPath(new URL('./oxlintrc.json', import.meta.url))
+
+const defaultIgnores = ['**/.output', '**/.data', '**/.nuxt', '**/.nitro', '**/.cache', '**/dist']
+
+/**
+ * ESLint only covers what Oxlint can't: Vue templates / SFCs and AST-selector rules.
+ * Everything else (incl. unicorn and import rules) lives in the Oxlint config.
+ *
+ * @param {object} [options]
+ * @param {string[]} [options.ignores] Extra ignore globs, added to the Nuxt build output dirs.
+ * @param {string} [options.oxlintConfigFile] Oxlint config whose rules ESLint turns off.
+ * @param {object[]} [options.configs] Project-specific flat configs, applied after the shared ones.
+ */
+export function defineLintConfig({
+  ignores = [],
+  oxlintConfigFile = './.oxlintrc.json',
+  configs = [],
+} = {}) {
+  return [
+    ...defineConfigWithVueTs(
+      { ignores: [...defaultIgnores, ...ignores] },
+
+      pluginVue.configs['flat/recommended'],
+      vueTsConfigs.recommended,
+
+      // Project defaults
+      {
+        rules: {
+          '@typescript-eslint/no-explicit-any': 'off',
+          'vue/multi-word-component-names': 'off',
+          // Optional type-based props are undefined when omitted; explicit `undefined` defaults add noise.
+          'vue/require-default-prop': 'off',
+          // Oxlint covers .ts files; in .vue files ESLint keeps this rule because it sees template usage.
+          '@typescript-eslint/no-unused-vars': [
+            'error',
+            { argsIgnorePattern: '^_', varsIgnorePattern: '^_', ignoreRestSiblings: true },
+          ],
+          'no-restricted-syntax': [
+            'error',
+            {
+              selector: 'TSEnumDeclaration',
+              message: 'Use literal unions instead of enums.',
+            },
+          ],
+        },
+      },
+
+      // Vue component rules (template / SFC — not yet covered by oxlint)
+      {
+        files: ['app/**/*.vue'],
+        rules: {
+          'vue/component-name-in-template-casing': ['error', 'PascalCase'],
+          'vue/block-order': [
+            'error',
+            {
+              order: ['script', 'template', 'style'],
+            },
+          ],
+          'vue/custom-event-name-casing': [
+            'warn',
+            'kebab-case',
+            // Idiomatic Vue v-model event names; renaming them would fight the ecosystem.
+            { ignores: ['update:modelValue', 'update:currentPage'] },
+          ],
+          'vue/no-unused-properties': [
+            'error',
+            { groups: ['props', 'data', 'computed', 'methods'] },
+          ],
+          'vue/no-unused-refs': 'error',
+          'vue/prefer-use-template-ref': 'error',
+        },
+      },
+
+      // Nuxt page and layout transitions need a single root element
+      {
+        files: ['app/pages/**/*.vue', 'app/layouts/**/*.vue'],
+        rules: {
+          'vue/no-multiple-template-root': ['error', { disallowComments: true }],
+        },
+      },
+
+      ...configs,
+    ),
+
+    // Disable rules handled by Oxlint. Kept outside defineConfigWithVueTs: it lists type-aware
+    // rules (as "off"), which would make it switch on the TS project service for every file.
+    // The shared base is read directly: eslint-plugin-oxlint drops `categories` from `extends`.
+    ...pluginOxlint.buildFromOxlintConfigFile(baseOxlintConfigFile),
+    ...pluginOxlint.buildFromOxlintConfigFile(oxlintConfigFile),
+
+    // Turn off formatting rules — oxfmt formats
+    skipFormatting,
+  ]
+}

package/oxfmt.js

@@ -0,0 +1,33 @@
+/** @type {import('oxfmt').OxfmtConfig} */
+export default {
+  sortTailwindcss: {},
+  sortPackageJson: {
+    sortScripts: true,
+  },
+  semi: false,
+  singleQuote: true,
+  ignorePatterns: [
+    '**/.output',
+    '**/.data',
+    '**/.nuxt',
+    '**/.nitro',
+    '**/.cache',
+    '**/dist',
+    '**/node_modules',
+    '**/logs',
+    '**/*.log',
+    '**/.DS_Store',
+    '**/.fleet',
+    '**/.env',
+    '**/.env.*',
+    '!**/.env.example',
+    'test-results/',
+    'playwright/',
+    'playwright-report/',
+    'blob-report/',
+    'playwright/.cache/',
+    '!.dockerignore',
+    '!.prettierrc',
+    '**/public',
+  ],
+}

package/oxlintrc.json

@@ -0,0 +1,45 @@
+{
+  "$schema": "./node_modules/oxlint/configuration_schema.json",
+  "categories": {
+    "correctness": "error",
+    "suspicious": "warn"
+  },
+  "plugins": ["eslint", "typescript", "unicorn", "oxc", "import", "vitest"],
+  "rules": {
+    "no-case-declarations": "error",
+    "no-empty": "error",
+    "no-fallthrough": "error",
+    "no-nested-ternary": "error",
+    "no-prototype-builtins": "error",
+    "no-regex-spaces": "error",
+    "no-shadow": ["error", { "hoist": "functions" }],
+    "no-useless-assignment": "error",
+    "typescript/ban-ts-comment": ["error", { "minimumDescriptionLength": 10 }],
+    "typescript/consistent-type-imports": "error",
+    "typescript/no-dynamic-delete": "error",
+    "typescript/no-import-type-side-effects": "error",
+    "typescript/no-invalid-void-type": "error",
+    "typescript/no-non-null-asserted-nullish-coalescing": "error",
+    "typescript/unified-signatures": "error",
+    "import/first": "error",
+    "import/no-duplicates": "error",
+    "import/no-mutable-exports": "error",
+    "import/no-named-default": "error",
+    "unicorn/error-message": "error",
+    "unicorn/escape-case": "error",
+    "unicorn/no-abusive-eslint-disable": "error",
+    "unicorn/no-await-in-promise-methods": "error",
+    "unicorn/no-invalid-remove-event-listener": "error",
+    "unicorn/no-new-array": "error",
+    "unicorn/no-useless-promise-resolve-reject": "error",
+    "unicorn/no-useless-spread": "error",
+    "unicorn/prefer-array-find": "error",
+    "unicorn/prefer-array-some": "error",
+    "unicorn/prefer-date-now": "error",
+    "unicorn/prefer-includes": "error",
+    "unicorn/prefer-number-properties": "error",
+    "unicorn/prefer-optional-catch-binding": "error",
+    "unicorn/prefer-string-starts-ends-with": "error",
+    "unicorn/throw-new-error": "error"
+  }
+}

package/package.json

@@ -1,6 +1,38 @@
 {
   "name": "@lifeofqui/lint-config",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "1.0.0",
+  "description": "Shared ESLint, Oxlint and Oxfmt setup for Vue/Nuxt projects",
+  "license": "MIT",
+  "author": "Quirin Koch",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/LifeOfQui/lint-config.git"
+  },
+  "files": [
+    "eslint.js",
+    "oxfmt.js",
+    "oxlintrc.json"
+  ],
+  "type": "module",
+  "exports": {
+    "./eslint": "./eslint.js",
+    "./oxfmt": "./oxfmt.js",
+    "./oxlintrc.json": "./oxlintrc.json",
+    "./package.json": "./package.json"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@vue/eslint-config-typescript": "14.9.0",
+    "eslint": "10.13.0",
+    "eslint-config-prettier": "10.1.8",
+    "eslint-plugin-oxlint": "1.90.0",
+    "eslint-plugin-vue": "10.12.0",
+    "oxfmt": "0.70.0",
+    "oxlint": "1.90.0"
+  },
+  "engines": {
+    "node": ">=22.18"
+  }
+}