@archpublicwebsite/eslint-config 1.0.21 → 1.0.23

package/tools/setup/install.mjs

@@ -13,19 +13,16 @@ function log(msg) {
 
 function getProjectRoot() {
   const root = process.env.INIT_CWD || process.cwd()
-  if (!existsSync(join(root, 'package.json')))
-    return null
+  if (!existsSync(join(root, 'package.json'))) return null
   return root
 }
 
 function ensureDir(dirPath) {
-  if (!existsSync(dirPath))
-    mkdirSync(dirPath, { recursive: true })
+  if (!existsSync(dirPath)) mkdirSync(dirPath, { recursive: true })
 }
 
 function writeIfMissing(filePath, content) {
-  if (existsSync(filePath))
-    return false
+  if (existsSync(filePath)) return false
   writeFileSync(filePath, content, 'utf8')
   return true
 }
@@ -56,8 +53,7 @@ indent_size = 2
 [Makefile]
 indent_style = tab
 `
-  if (writeIfMissing(editorConfigPath, content))
-    log('Created .editorconfig')
+  if (writeIfMissing(editorConfigPath, content)) log('Created .editorconfig')
 }
 
 // ─── .eslint-user-ignore ────────────────────────────────────────────────────
@@ -80,8 +76,7 @@ function ensureEslintUserIgnore(projectRoot) {
 # docs/**
 # *.pdf
 `
-  if (writeIfMissing(ignorePath, content))
-    log('Created .eslint-user-ignore')
+  if (writeIfMissing(ignorePath, content)) log('Created .eslint-user-ignore')
 }
 
 // ─── eslint.config.mjs ─────────────────────────────────────────────────────
@@ -97,8 +92,7 @@ export default createArchipelagoConfig({
   },
 })
 `
-  if (writeIfMissing(eslintConfigPath, content))
-    log('Created eslint.config.mjs')
+  if (writeIfMissing(eslintConfigPath, content)) log('Created eslint.config.mjs')
 }
 
 // ─── .prettierrc ────────────────────────────────────────────────────────────
@@ -110,8 +104,7 @@ function ensurePrettierConfig(projectRoot) {
 export default config
 `
 
-  if (writeIfMissing(prettierModuleConfigPath, prettierModuleConfigContent))
-    log('Created prettier.config.mjs')
+  if (writeIfMissing(prettierModuleConfigPath, prettierModuleConfigContent)) log('Created prettier.config.mjs')
 
   const prettierPath = join(projectRoot, '.prettierrc')
   const defaults = {
@@ -135,24 +128,81 @@ export default config
     const plugins = Array.isArray(current.plugins) ? current.plugins : []
     const deduped = [...new Set([...plugins, 'prettier-plugin-tailwindcss'])]
     current.plugins = deduped
-    if (typeof current.singleQuote !== 'boolean')
-      current.singleQuote = true
-    if (typeof current.semi !== 'boolean')
-      current.semi = false
+    if (typeof current.singleQuote !== 'boolean') current.singleQuote = true
+    if (typeof current.semi !== 'boolean') current.semi = false
     writeFileSync(prettierPath, `${JSON.stringify(current, null, 2)}\n`, 'utf8')
     log('Updated .prettierrc')
-  }
-  catch {
+  } catch {
     // Keep existing file untouched if it is not JSON.
   }
 }
 
+// ─── tsconfig.base.json ──────────────────────────────────────────────────────
+// Shared TypeScript compiler settings used by every package and app.
+// Includes @vue/typescript-plugin so the IDE delegates .vue file handling to
+// Volar instead of the plain TS server (eliminates "Cannot find name 'div'" etc.)
+
+function ensureTsConfigBase(projectRoot) {
+  const tsconfigBasePath = join(projectRoot, 'tsconfig.base.json')
+  const content = `{
+  "compilerOptions": {
+    "target": "ES2020",
+    "module": "ESNext",
+    "moduleResolution": "Bundler",
+    "lib": ["DOM", "DOM.Iterable", "ES2020"],
+    "strict": true,
+    "jsx": "preserve",
+    "resolveJsonModule": true,
+    "skipLibCheck": true,
+    "types": ["vite/client"],
+    "plugins": [
+      {
+        "name": "@vue/typescript-plugin",
+        "languages": ["vue"]
+      }
+    ]
+  }
+}
+`
+  if (writeIfMissing(tsconfigBasePath, content)) log('Created tsconfig.base.json')
+}
+
+// ─── tsconfig.json ───────────────────────────────────────────────────────────
+// Root TypeScript project file that extends tsconfig.base.json.
+// Covers src/ and packages/ source; excludes apps/ (each app owns its tsconfig).
+// Add path aliases here as workspace packages grow.
+
+function ensureTsConfig(projectRoot) {
+  const tsconfigPath = join(projectRoot, 'tsconfig.json')
+  const content = `{
+  "extends": "./tsconfig.base.json",
+  "compilerOptions": {
+    "paths": {}
+  },
+  "include": [
+    "src/**/*.ts",
+    "src/**/*.vue",
+    "packages/**/*.ts",
+    "packages/**/*.vue",
+    "vite.config.ts"
+  ],
+  "exclude": [
+    "apps/**",
+    "node_modules",
+    "**/dist/**",
+    "**/.nuxt/**",
+    "**/.output/**"
+  ]
+}
+`
+  if (writeIfMissing(tsconfigPath, content)) log('Created tsconfig.json')
+}
+
 function ensureCommitlintConfig(projectRoot) {
   const commitlintConfigPath = join(projectRoot, 'commitlint.config.cjs')
   const content = `module.exports = require('@archpublicwebsite/eslint-config/commitlint')
 `
-  if (writeIfMissing(commitlintConfigPath, content))
-    log('Created commitlint.config.cjs')
+  if (writeIfMissing(commitlintConfigPath, content)) log('Created commitlint.config.cjs')
 }
 
 function ensureLintStagedConfig(projectRoot) {
@@ -161,8 +211,7 @@ function ensureLintStagedConfig(projectRoot) {
 
 export default config
 `
-  if (writeIfMissing(lintStagedConfigPath, content))
-    log('Created lint-staged.config.mjs')
+  if (writeIfMissing(lintStagedConfigPath, content)) log('Created lint-staged.config.mjs')
 }
 
 function ensurePrettierIgnore(projectRoot) {
@@ -178,8 +227,7 @@ pnpm-lock.yaml
 package-lock.json
 yarn.lock
 `
-  if (writeIfMissing(prettierIgnorePath, content))
-    log('Created .prettierignore')
+  if (writeIfMissing(prettierIgnorePath, content)) log('Created .prettierignore')
 }
 
 // ─── .hooks ─────────────────────────────────────────────────────────────────
@@ -233,18 +281,15 @@ node node_modules/@archpublicwebsite/eslint-config/tools/git-hooks/pre-push.mjs
       created = true
     }
   })
-  if (created)
-    log('Created .hooks/ (pre-commit, prepare-commit-msg, commit-msg, post-commit, pre-push)')
+  if (created) log('Created .hooks/ (pre-commit, prepare-commit-msg, commit-msg, post-commit, pre-push)')
 }
 
 function ensureHooksPath(projectRoot) {
-  if (!existsSync(join(projectRoot, '.git')))
-    return
+  if (!existsSync(join(projectRoot, '.git'))) return
   try {
     execSync('git config core.hooksPath .hooks', { cwd: projectRoot, stdio: 'ignore' })
     log('Set git core.hooksPath → .hooks')
-  }
-  catch {
+  } catch {
     // Ignore setup failures in non-git contexts.
   }
 }
@@ -284,8 +329,7 @@ function ensurePackageScripts(projectRoot) {
   let pkg
   try {
     pkg = JSON.parse(readFileSync(packageJsonPath, 'utf8'))
-  }
-  catch {
+  } catch {
     return
   }
 
@@ -299,7 +343,8 @@ function ensurePackageScripts(projectRoot) {
     precommit: 'node node_modules/@archpublicwebsite/eslint-config/tools/git-hooks/pre-commit.mjs',
     prepush: 'node node_modules/@archpublicwebsite/eslint-config/tools/git-hooks/pre-push.mjs',
     'security:global-scan': 'bash ./node_modules/@archpublicwebsite/eslint-config/tools/security/scan-global.sh',
-    'security:safe-check': 'bash ./node_modules/@archpublicwebsite/eslint-config/tools/security/safe-reinstall.sh --check-only',
+    'security:safe-check':
+      'bash ./node_modules/@archpublicwebsite/eslint-config/tools/security/safe-reinstall.sh --check-only',
     'security:pre-push': 'node node_modules/@archpublicwebsite/eslint-config/tools/git-hooks/pre-push.mjs',
   }
 
@@ -311,13 +356,26 @@ function ensurePackageScripts(projectRoot) {
     }
   }
 
+  const lintStagedConfigPath = join(projectRoot, 'lint-staged.config.mjs')
+  const hasLintStagedConfig = existsSync(lintStagedConfigPath)
+
+  // Auto-heal legacy/broken lint-staged script when it points to a missing file.
+  if (
+    typeof scripts['lint-staged'] === 'string' &&
+    scripts['lint-staged'].includes('--config lint-staged.config.mjs') &&
+    !hasLintStagedConfig
+  ) {
+    scripts['lint-staged'] = 'lint-staged'
+    updated = true
+  }
+
   if (!updated) {
     return
   }
 
   pkg.scripts = scripts
   writeFileSync(packageJsonPath, `${JSON.stringify(pkg, null, 2)}\n`, 'utf8')
-  log('Updated package.json scripts (precommit, security:global-scan, security:safe-check)')
+  log('Updated package.json scripts (lint-staged, precommit, security:global-scan, security:safe-check)')
 }
 
 // ─── .vscode/extensions.json ────────────────────────────────────────────────
@@ -328,26 +386,24 @@ function ensureVscodeExtensions(projectRoot) {
 
   ensureDir(vscodeDir)
 
-  const recommended = [
-    'dbaeumer.vscode-eslint',
-    'esbenp.prettier-vscode',
-    'vue.volar',
-  ]
+  const recommended = ['dbaeumer.vscode-eslint', 'esbenp.prettier-vscode', 'vue.volar']
+  const unwanted = ['octref.vetur', 'vue.vscode-typescript-vue-plugin']
 
-  let current = { recommendations: [] }
+  let current = { recommendations: [], unwantedRecommendations: [] }
   if (existsSync(extPath)) {
     try {
       current = JSON.parse(readFileSync(extPath, 'utf8'))
-      if (!Array.isArray(current.recommendations))
-        current.recommendations = []
-    }
-    catch {
-      current = { recommendations: [] }
+      if (!Array.isArray(current.recommendations)) current.recommendations = []
+      if (!Array.isArray(current.unwantedRecommendations)) current.unwantedRecommendations = []
+    } catch {
+      current = { recommendations: [], unwantedRecommendations: [] }
     }
   }
 
   const merged = [...new Set([...current.recommendations, ...recommended])]
+  const mergedUnwanted = [...new Set([...current.unwantedRecommendations, ...unwanted])]
   current.recommendations = merged
+  current.unwantedRecommendations = mergedUnwanted
   writeFileSync(extPath, `${JSON.stringify(current, null, 2)}\n`, 'utf8')
   log('Created/updated .vscode/extensions.json')
 }
@@ -356,13 +412,14 @@ function ensureVscodeExtensions(projectRoot) {
 
 function main() {
   const projectRoot = getProjectRoot()
-  if (!projectRoot)
-    return
+  if (!projectRoot) return
 
   log('Setting up project...')
 
   ensureEditorConfig(projectRoot)
   ensureEslintUserIgnore(projectRoot)
+  ensureTsConfigBase(projectRoot)
+  ensureTsConfig(projectRoot)
   ensureEslintConfig(projectRoot)
   ensurePrettierConfig(projectRoot)
   ensurePrettierIgnore(projectRoot)

package/tools/setup/vscode.mjs

@@ -9,20 +9,30 @@ const TAG = '[@archpublicwebsite/eslint-config]'
  * the correct file types.
  */
 const VSCODE_ESLINT_SETTINGS = {
+  // Use workspace TypeScript for consistent Volar/TS plugin resolution
+  'typescript.tsdk': 'node_modules/typescript/lib',
+  'typescript.enablePromptUseWorkspaceTsdk': true,
+
+  // Ensure Vue SFC files are always handled as Vue documents
+  'files.associations': {
+    '*.vue': 'vue',
+  },
+
+  // Volar + TS integration for Vue 3 SFC template diagnostics
+  'vue.server.hybridMode': true,
+  'volar.takeOverMode.enabled': true,
+
+  // Prevent duplicate/broken diagnostics from built-in TS/JS validators
+  // (vue-tsc + Volar remain the source of truth for Vue type diagnostics).
+  'typescript.validate.enable': false,
+  'javascript.validate.enable': false,
+
   // Use flat config mode (required for eslint.config.mjs)
   'eslint.useFlatConfig': true,
+  'eslint.workingDirectories': [{ mode: 'auto' }],
 
   // Enable ESLint for these languages
-  'eslint.validate': [
-    'javascript',
-    'javascriptreact',
-    'typescript',
-    'typescriptreact',
-    'vue',
-    'json',
-    'jsonc',
-    'markdown',
-  ],
+  'eslint.validate': ['javascript', 'javascriptreact', 'typescript', 'typescriptreact', 'vue', 'json', 'jsonc'],
 
   // Auto-fix on save via ESLint
   'editor.codeActionsOnSave': {
@@ -33,7 +43,22 @@ const VSCODE_ESLINT_SETTINGS = {
   // Let ESLint handle formatting instead of the built-in formatter
   'editor.formatOnSave': false,
 
-  // Disable the default VS Code JSON formatter for files ESLint handles
+  // Formatters per language — ESLint enforces no-semi, single-quote on save
+  '[javascript]': {
+    'editor.defaultFormatter': 'dbaeumer.vscode-eslint',
+  },
+  '[javascriptreact]': {
+    'editor.defaultFormatter': 'dbaeumer.vscode-eslint',
+  },
+  '[typescript]': {
+    'editor.defaultFormatter': 'dbaeumer.vscode-eslint',
+  },
+  '[typescriptreact]': {
+    'editor.defaultFormatter': 'dbaeumer.vscode-eslint',
+  },
+  '[vue]': {
+    'editor.defaultFormatter': 'Vue.volar',
+  },
   '[json]': {
     'editor.defaultFormatter': 'dbaeumer.vscode-eslint',
   },
@@ -71,16 +96,15 @@ function deepMerge(target, source) {
     const srcVal = source[key]
     const tgtVal = result[key]
     if (
-      srcVal !== null
-      && typeof srcVal === 'object'
-      && !Array.isArray(srcVal)
-      && tgtVal !== null
-      && typeof tgtVal === 'object'
-      && !Array.isArray(tgtVal)
+      srcVal !== null &&
+      typeof srcVal === 'object' &&
+      !Array.isArray(srcVal) &&
+      tgtVal !== null &&
+      typeof tgtVal === 'object' &&
+      !Array.isArray(tgtVal)
     ) {
       result[key] = deepMerge(tgtVal, srcVal)
-    }
-    else {
+    } else {
       result[key] = srcVal
     }
   }
@@ -107,8 +131,7 @@ export function ensureVscodeSettings(projectRoot) {
     try {
       const raw = readFileSync(settingsPath, 'utf8')
       current = JSON.parse(raw)
-    }
-    catch {
+    } catch {
       // File exists but is not valid JSON – back it up and start fresh
       const backupPath = `${settingsPath}.backup`
       writeFileSync(backupPath, readFileSync(settingsPath, 'utf8'), 'utf8')