feat: add vscode config for ESLint (#467)

Author: yoshi-pi

index.ts

@@ -120,6 +120,7 @@ async function init() {
       argv.nightwatch ??
       argv.playwright ??
       argv.eslint ??
+      argv['eslint-with-prettier'] ??
       (argv.devtools || argv['vue-devtools'])
     ) === 'boolean'
 
@@ -463,6 +464,7 @@ async function init() {
       needsPrettier,
       needsPlaywright
     })
+    render('config/eslint')
   }
 
   if (needsPrettier) {

scripts/snapshot.mjs

@@ -54,7 +54,7 @@ function fullCombination(arr) {
 }
 
 let flagCombinations = fullCombination(featureFlags)
-flagCombinations.push(['default'], ['devtools'])
+flagCombinations.push(['default'], ['devtools'], ['eslint'], ['eslint-with-prettier'])
 
 // `--with-tests` are equivalent of `--vitest --cypress`
 // Previously it means `--cypress` without `--vitest`.

template/config/eslint/.vscode/extensions.json

@@ -0,0 +1,3 @@
+{
+  "recommendations": ["dbaeumer.vscode-eslint"]
+}

template/config/eslint/.vscode/settings.json

@@ -0,0 +1,5 @@
+{
+  "editor.codeActionsOnSave": {
+    "source.fixAll": "explicit"
+  }
+}

utils/renderEslint.ts

@@ -85,10 +85,4 @@ export default function renderEslint(
     const fullPath = path.resolve(rootDir, fileName)
     fs.writeFileSync(fullPath, content as string, 'utf-8')
   }
-
-  // update .vscode/extensions.json
-  const extensionsJsonPath = path.resolve(rootDir, '.vscode/extensions.json')
-  const existingExtensions = JSON.parse(fs.readFileSync(extensionsJsonPath, 'utf8'))
-  existingExtensions.recommendations.push('dbaeumer.vscode-eslint')
-  fs.writeFileSync(extensionsJsonPath, JSON.stringify(existingExtensions, null, 2) + '\n', 'utf-8')
 }

utils/renderTemplate.ts

@@ -51,6 +51,15 @@ function renderTemplate(src, dest, callbacks) {
     return
   }
 
+  if (filename === 'settings.json' && fs.existsSync(dest)) {
+    // merge instead of overwriting
+    const settings = JSON.parse(fs.readFileSync(dest, 'utf8'))
+    const newSettings = JSON.parse(fs.readFileSync(src, 'utf8'))
+    const extensions = deepMerge(settings, newSettings)
+    fs.writeFileSync(dest, JSON.stringify(settings, null, 2) + '\n')
+    return
+  }
+
   if (filename.startsWith('_')) {
     // rename `_file` to `.file`
     dest = path.resolve(path.dirname(dest), filename.replace(/^_/, '.'))