@lifeofqui/lint-config 1.0.1 → 1.2.0

package/README.md

@@ -8,11 +8,19 @@ Das Paket bringt Regeln **und** Tool-Versionen mit: `eslint`, `oxlint` und `oxfm
 
 ## Setup in einem Projekt
 
+Zuerst die bisherigen Lint-Pakete deinstallieren, **dann** das Paket installieren (zwei getrennte Befehle):
+
+```bash
+npm uninstall eslint oxlint oxfmt eslint-plugin-oxlint eslint-plugin-vue @vue/eslint-config-typescript eslint-config-prettier @vue/eslint-config-prettier @nuxt/eslint
+```
+
 ```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.
+Die Reihenfolge ist wichtig: Liegt beim Install noch eine andere Version von `oxfmt`, `oxlint` oder `eslint` im Projekt, legt npm die mitgelieferte Version verschachtelt unter `node_modules/@lifeofqui/lint-config/node_modules/` ab und das Binary fehlt in `node_modules/.bin`. Prüfen mit `ls node_modules/.bin | grep -E '^(eslint|oxlint|oxfmt)$'`. Falls doch passiert: `npm uninstall @lifeofqui/lint-config` und neu installieren. `npm dedupe` hilft hier nicht.
+
+Ist `@nuxt/eslint` auch in `modules` der `nuxt.config.ts` eingetragen, den Eintrag dort ebenfalls entfernen.
 
 **`.oxlintrc.json`**
 
@@ -44,11 +52,12 @@ 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 |
+| 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                                                                                               |
+| `gitignore`        | `'.gitignore'`       | Ignore-Datei (relativ zum Arbeitsverzeichnis), deren Muster ESLint überspringt, wie Oxlint und Oxfmt. Fehlt sie, passiert nichts; `false` schaltet es ab |
+| `configs`          | `[]`                 | Projektspezifische Flat-Configs, werden nach den geteilten angewendet                                                                                    |
 
 **Scripts** (Standard, `npm-run-all` im Projekt)
 
@@ -68,7 +77,7 @@ Optionen von `defineLintConfig`:
 ## Projektspezifische Anpassungen
 
 - **Oxlint**: eigene `rules` / `overrides` in `.oxlintrc.json` nach dem `extends`. Spätere Einträge gewinnen.
-- **Oxfmt**: `export default { ...base, printWidth: 120 }`
+- **Oxfmt**: `export default { ...base, printWidth: 120 }`, zusätzliche Ignores mit `ignorePatterns: [...base.ignorePatterns, 'datei.json']`
 - **ESLint**: `defineLintConfig({ configs: [{ files: ['…'], rules: { … } }] })`
 
 ## Updates verteilen
@@ -80,6 +89,12 @@ Optionen von `defineLintConfig`:
 
 Semver: neue oder verschärfte Regeln und Tool-Updates mit Formatierungsänderungen → `minor`, Lockerungen und Fixes → `patch`, geänderte Datei-Struktur oder Optionen → `major`.
 
+## Stolperfalle: Inline-Handler mit mehreren Anweisungen
+
+Oxfmt entfernt mit `semi: false` das `;` aus Vue-Handlern wie `@click="a = 1; b = 2"` und schreibt die Anweisungen untereinander. Der Vue-Compiler erkennt mehrere Anweisungen aber nur am `;` und bricht dann den **Build** ab („Error parsing JavaScript expression“). Lint und Typecheck merken davon nichts.
+
+Deshalb keine Inline-Handler mit mehreren Anweisungen schreiben, sondern eine Funktion aufrufen (`@click="resetFilters"`). Nach einer Umstellung auf dieses Paket immer auch `npm run build` laufen lassen.
+
 ## 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.d.ts

@@ -5,6 +5,11 @@ export interface LintConfigOptions {
   ignores?: string[]
   /** Oxlint config whose rules ESLint turns off. Defaults to `./.oxlintrc.json`. */
   oxlintConfigFile?: string
+  /**
+   * Ignore file whose patterns ESLint skips, relative to the working directory. Defaults to
+   * `.gitignore`; skipped silently if missing. `false` turns it off.
+   */
+  gitignore?: string | false
   /** Project-specific flat configs, applied after the shared ones. */
   configs?: Linter.Config[]
 }

package/eslint.js

@@ -1,7 +1,10 @@
 import { defineConfigWithVueTs, vueTsConfigs } from '@vue/eslint-config-typescript'
+import { includeIgnoreFile } from 'eslint/config'
 import skipFormatting from 'eslint-config-prettier'
 import pluginOxlint from 'eslint-plugin-oxlint'
 import pluginVue from 'eslint-plugin-vue'
+import { existsSync } from 'node:fs'
+import { resolve } from 'node:path'
 import { fileURLToPath } from 'node:url'
 
 const baseOxlintConfigFile = fileURLToPath(new URL('./oxlintrc.json', import.meta.url))
@@ -15,14 +18,29 @@ const defaultIgnores = ['**/.output', '**/.data', '**/.nuxt', '**/.nitro', '**/.
  * @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 {string | false} [options.gitignore] Ignore file whose patterns ESLint skips, relative to the
+ *   working directory. Skipped silently if missing; `false` turns it off.
  * @param {object[]} [options.configs] Project-specific flat configs, applied after the shared ones.
  */
 export function defineLintConfig({
   ignores = [],
   oxlintConfigFile = './.oxlintrc.json',
+  gitignore = '.gitignore',
   configs = [],
 } = {}) {
+  const gitignoreFile = gitignore === false ? null : resolve(gitignore)
+
   return [
+    // Lint the same files as Oxlint and Oxfmt, which both respect .gitignore
+    ...(gitignoreFile && existsSync(gitignoreFile)
+      ? [
+          includeIgnoreFile(gitignoreFile, {
+            gitignoreResolution: true,
+            name: 'lifeofqui/gitignore',
+          }),
+        ]
+      : []),
+
     ...defineConfigWithVueTs(
       { ignores: [...defaultIgnores, ...ignores] },
 

package/oxfmt.d.ts

@@ -1,4 +1,4 @@
 import type { OxfmtConfig } from 'oxfmt'
 
-declare const config: OxfmtConfig
+declare const config: OxfmtConfig & { ignorePatterns: string[] }
 export default config

package/oxlintrc.json

@@ -25,6 +25,7 @@
     "import/no-duplicates": "error",
     "import/no-mutable-exports": "error",
     "import/no-named-default": "error",
+    "import/no-unassigned-import": ["warn", { "allow": ["**/*.css"] }],
     "unicorn/error-message": "error",
     "unicorn/escape-case": "error",
     "unicorn/no-abusive-eslint-disable": "error",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lifeofqui/lint-config",
-  "version": "1.0.1",
+  "version": "1.2.0",
   "description": "Shared ESLint, Oxlint and Oxfmt setup for Vue/Nuxt projects",
   "license": "MIT",
   "author": "Quirin Koch",
@@ -37,7 +37,7 @@
     "eslint-config-prettier": "10.1.8",
     "eslint-plugin-oxlint": "1.90.0",
     "eslint-plugin-vue": "10.12.0",
-    "oxfmt": "0.70.0",
+    "oxfmt": "0.75.0",
     "oxlint": "1.90.0"
   },
   "engines": {