feat: eslint flat config (#2)

kingyue737 · Mar 22, 2024 · e4e35f4 · e4e35f4
1 parent bb44eca
commit e4e35f4
Show file tree

Hide file tree

Showing 16 changed files with 247 additions and 176 deletions.
diff --git a/.eslintrc.cjs b/.eslintrc.cjs
diff --git a/.prettierignore b/.prettierignore
@@ -1,3 +1,4 @@
 src/auto-imports.d.ts
 src/components.d.ts
 src/typed-router.d.ts
+pnpm-lock.yaml
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -9,5 +9,5 @@
     }
   ],
   "editor.defaultFormatter": "esbenp.prettier-vscode",
-  "typescript.tsdk": "node_modules/typescript/lib"
+  "eslint.experimental.useFlatConfig": true
 }
diff --git a/README.md b/README.md
@@ -93,7 +93,7 @@ Currently I want to keep this template as light as possible, see [Vitify Admin](
 ### Coding Style
 
 - [Prettier](https://prettier.io/), single quotes, no semi
-- [ESLint](https://eslint.org/) with adapted [@vue/eslint-config-typescript](https://github.com/vuejs/eslint-config-typescript)
+- [ESLint flat config](https://eslint.org/docs/latest/use/configure/configuration-files-new) with adapted [@nuxt/eslint](https://github.com/nuxt/eslint), future-proof
 
 ### Dev tools
 

diff --git a/eslint.config.js b/eslint.config.js
@@ -0,0 +1,28 @@
+import {
+  createConfigForNuxt,
+  defineFlatConfigs,
+} from '@nuxt/eslint-config/flat'
+import playwright from 'eslint-plugin-playwright'
+
+export default defineFlatConfigs(
+  createConfigForNuxt({
+    dirs: {
+      // components: ['src/components'], // this will turn off multi-word component name
+      pages: ['src/pages'],
+      composables: ['src/composables', 'src/utils'],
+      layouts: ['src/layouts'],
+      plugins: ['src/plugins'],
+    },
+  }),
+  {
+    ...playwright.configs['flat/recommended'],
+    files: ['e2e/**/*.{js,ts,jsx,tsx}'],
+  },
+  {
+    rules: {
+      'vue/valid-v-slot': ['error', { allowModifiers: true }],
+      'vue/no-multiple-template-root': 'off',
+      '@typescript-eslint/no-explicit-any': 'off',
+    },
+  },
+)
diff --git a/index.html b/index.html
@@ -1,4 +1,4 @@
-<!DOCTYPE html>
+<!doctype html>
 <html lang="en">
   <head>
     <meta charset="UTF-8" />

diff --git a/package.json b/package.json
@@ -9,8 +9,8 @@
     "test:unit": "vitest",
     "test:e2e": "playwright test",
     "typecheck": "vue-tsc --build --force",
-    "lint": "eslint . --ext .vue,.js,.jsx,.cjs,.mjs,.ts,.tsx,.cts,.mts --fix --ignore-path .gitignore",
-    "format": "prettier --write src/"
+    "lint": "eslint . --fix",
+    "format": "prettier . --write"
   },
   "dependencies": {
     "@vueuse/core": "^10.9.0",
@@ -23,21 +23,18 @@
   },
   "devDependencies": {
     "@mdi/js": "^7.4.47",
+    "@nuxt/eslint-config": "0.3.0-beta.3",
     "@pinia/testing": "^0.1.3",
     "@playwright/test": "^1.42.1",
-    "@rushstack/eslint-patch": "^1.8.0",
     "@testing-library/vue": "^8.0.3",
     "@tsconfig/node20": "^20.1.2",
     "@types/jsdom": "^21.1.6",
     "@types/node": "^20.11.30",
     "@vitejs/plugin-vue": "^5.0.4",
-    "@vue/eslint-config-prettier": "^9.0.0",
-    "@vue/eslint-config-typescript": "^13.0.0",
     "@vue/test-utils": "^2.4.5",
     "@vue/tsconfig": "^0.5.1",
     "eslint": "^8.57.0",
-    "eslint-plugin-playwright": "^1.5.3",
-    "eslint-plugin-vue": "^9.23.0",
+    "eslint-plugin-playwright": "^1.5.4",
     "jsdom": "^24.0.0",
     "prettier": "^3.2.5",
     "rollup-plugin-regexp": "^5.0.1",