Add ESLint support

Author: skirtles-code

src/index.ts

@@ -67,6 +67,7 @@ type Config = {
   includeGithubPages: boolean
   includePlayground: boolean
   includeExamples: boolean
+  includeEsLint: boolean
 }
 
 async function init() {
@@ -125,6 +126,7 @@ async function init() {
     process.exit(1)
   }
 
+  const includeEsLint = await togglePrompt('Include ESLint?', true, 'Yes', 'No')
   const includeDocs = await togglePrompt('Include VitePress for documentation?', true)
   const includeGithubPages = includeDocs && await togglePrompt('Include GitHub Pages config for documentation?')
   const includePlayground = await togglePrompt('Include playground application for development?', true)
@@ -160,7 +162,8 @@ async function init() {
     includeDocs,
     includeGithubPages,
     includePlayground,
-    includeExamples
+    includeExamples,
+    includeEsLint
   }
 
   copyTemplate('base', config)
@@ -177,6 +180,10 @@ async function init() {
     copyTemplate('playground', config)
   }
 
+  if (config.includeEsLint) {
+    copyTemplate('eslint', config)
+  }
+
   console.log('Project created')
   console.log('Note: pnpm must be used as the package manager')
   console.log()

src/template/base/config/package.json.ejs

@@ -5,7 +5,10 @@
     "clean": "pnpm run -r clean",
     "build": "pnpm run -r build",
     "type-check": "pnpm run -r type-check",
-    "lint": "eslint . --ext .vue,.js,.jsx,.cjs,.mjs,.ts,.tsx,.cts,.mts --fix --ignore-path .gitignore",
+    <%_ if (config.includeEsLint) { _%>
+    "lint": "eslint",
+    "lint:fix": "eslint --fix",
+    <%_ } _%>
     <%_ if (config.includePlayground) { _%>
     "dev": "pnpm run --filter ./packages/playground -r dev",
     <%_ } _%>
@@ -18,18 +21,29 @@
     "preinstall": "node scripts/preinstall.js",
     "postinstall": "simple-git-hooks"
   },
+  <%_ if (config.includeEsLint) { _%>
   "simple-git-hooks": {
     "pre-commit": "pnpm run type-check && pnpm exec lint-staged"
   },
   "lint-staged": {
     "*.{vue,js,jsx,cjs,mjs,ts,tsx,cts,mts}": "eslint --fix"
   },
+  <%_ } else { _%>
+  "simple-git-hooks": {
+    "pre-commit": "pnpm run type-check"
+  },
+  <%_ } _%>
   "devDependencies": {
+    <%_ if (config.includeEsLint) { _%>
+    "@eslint/compat": "^1.2.6",
     "@typescript-eslint/parser": "^8.23.0",
+    "@vitest/eslint-plugin": "1.1.25",
     "@vue/eslint-config-typescript": "^14.3.0",
     "eslint": "^9.18.0",
     "eslint-plugin-vue": "^9.32.0",
+    "jiti": "^2.4.2",
     "lint-staged": "^15.4.3",
+    <%_ } _%>
     "simple-git-hooks": "^2.11.1"
   }
 }

src/template/base/config/packages/@projectName@/package.json

@@ -50,14 +50,7 @@
     "vite-plugin-dts": "^4.5.0",
     "vitest": "^3.0.2",
     "vue": "^3.5.13",
-    "vue-tsc": "^2.2.0",
-
-    "@vitest/eslint-plugin": "1.1.25",
-    "@vue/eslint-config-typescript": "^14.3.0",
-    "eslint": "^9.18.0",
-    "eslint-plugin-vue": "^9.32.0",
-    "jiti": "^2.4.2",
-    "vite-plugin-vue-devtools": "^7.7.0"
+    "vue-tsc": "^2.2.0"
   },
   "scripts": {
     "clean": "rimraf dist coverage",

src/template/base/config/tsconfig.json

@@ -1,4 +1,4 @@
 {
-  "files": [".eslintrc.cjs"],
+  "files": ["eslint.config.mts"],
   "include": ["scripts/**/*"]
 }

src/template/eslint/config/eslint.config.mts

@@ -0,0 +1,24 @@
+import path from 'node:path'
+import { fileURLToPath } from 'node:url'
+
+import { includeIgnoreFile } from '@eslint/compat'
+import pluginVue from 'eslint-plugin-vue'
+import { defineConfigWithVueTs, vueTsConfigs } from '@vue/eslint-config-typescript'
+import pluginVitest from '@vitest/eslint-plugin'
+
+export default defineConfigWithVueTs(
+  {
+    name: 'app/files-to-lint',
+    files: ['**/*.{ts,mts,vue}'],
+  },
+
+  includeIgnoreFile(path.resolve(path.dirname(fileURLToPath(import.meta.url)), '.gitignore')),
+
+  pluginVue.configs['flat/essential'],
+  vueTsConfigs.recommended,
+
+  {
+    ...pluginVitest.configs.recommended,
+    files: ['src/**/__tests__/*'],
+  },
+)