feat: feat-eslint-vscode-settings (#241)

Author: Yordan-Ramchev

Diff for: index.ts

@@ -484,7 +484,10 @@ async function init() {
 
   // Render ESLint config
   // By default ESLint, Prettier and Husky will be added
+  // if (needsEslint) {
   renderEslint(root, { needsTypeScript, needsCypress, needsCypressCT, needsPlaywright })
+  render('config/eslint')
+  // }
   render('config/husky')
 
   // if (needsPrettier) {

Diff for: scripts/snapshot.mjs

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

Diff for: template/base/.vscode/settings.json

@@ -4,9 +4,5 @@
   "files.trimTrailingWhitespace": true,
   "files.eol": "\n",
   "files.insertFinalNewline": true,
-  "files.trimFinalNewlines": true,
-  "editor.codeActionsOnSave": {
-    "source.fixAll.eslint": true,
-    "source.fixAll.stylelint": true
-  }
+  "files.trimFinalNewlines": true
 }

Diff for: template/config/eslint/.vscode/extensions.json

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

Diff for: template/config/eslint/.vscode/settings.json

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

Diff for: utils/renderEslint.ts

@@ -106,10 +106,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')
 }

Diff for: 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(/^_/, '.'))