Align the project's own configuration with the configuration it generates

Author: skirtles-code

.editorconfig

@@ -1,7 +1,13 @@
+root = true
+
 [*]
 charset = utf-8
 indent_style = space
 indent_size = 2
 end_of_line = lf
 insert_final_newline = true
 trim_trailing_whitespace = true
+
+[*.md]
+indent_size = 4
+trim_trailing_whitespace = false

eslint.config.mts

@@ -0,0 +1,23 @@
+import path from 'node:path'
+import { fileURLToPath } from 'node:url'
+
+import { includeIgnoreFile } from '@eslint/compat'
+import pluginVue from 'eslint-plugin-vue'
+import stylistic from '@stylistic/eslint-plugin'
+import { defineConfigWithVueTs, vueTsConfigs } from '@vue/eslint-config-typescript'
+
+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,
+
+  stylistic.configs.customize({
+    commaDangle: 'never'
+  })
+)

package.json

@@ -6,14 +6,31 @@
     "node": ">=v18.3.0"
   },
   "devDependencies": {
+    "@eslint/compat": "^1.2.6",
+    "@stylistic/eslint-plugin": "^4.0.0",
+    "@typescript-eslint/parser": "^8.23.0",
+    "@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"
   },
   "scripts": {
     "clean": "pnpm run -r clean",
     "docs:dev": "pnpm run --filter ./packages/docs -r dev",
     "docs:build": "pnpm run --filter ./packages/docs -r build",
+    "type-check": "pnpm run -r type-check",
+    "lint": "eslint",
+    "lint:fix": "eslint --fix",
     "build": "pnpm run -r build",
-    "preinstall": "npx only-allow pnpm"
+    "preinstall": "node scripts/preinstall.js",
+    "postinstall": "simple-git-hooks"
+  },
+  "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"
   }
 }

packages/create-vue-lib/src/index.ts

@@ -22,7 +22,8 @@ async function prompt(options: Omit<PromptObject, 'name'>) {
     )
 
     return result.name
-  } catch (cancelled) {
+  }
+  catch (cancelled) {
     console.log(cancelled.message)
     process.exit(1)
   }
@@ -125,13 +126,15 @@ function processArgs(): Args {
     })
 
     argValues = args.values
-  } catch (err) {
+  }
+  catch (err) {
     if (err.code === 'ERR_PARSE_ARGS_UNKNOWN_OPTION') {
       console.log('Error:')
       console.log(err.message)
       console.log('See --help for valid options')
       process.exit(1)
-    } else {
+    }
+    else {
       throw err
     }
   }
@@ -201,7 +204,8 @@ async function init() {
     if (fs.existsSync(path.join(targetDirPath, 'package.json'))) {
       console.log('Target directory already contains package.json')
     }
-  } else {
+  }
+  else {
     if (fs.existsSync(targetDirPath)) {
       console.log('Target directory already exists')
     }
@@ -399,14 +403,16 @@ function copyFiles(templateFile: string, config: Config) {
     }
 
     fs.writeFileSync(target, content)
-  } else if (['package.json', 'vite.config.mts', 'config.mts', 'index.md', 'introduction.md', 'App.vue', 'tsconfig.app.json', 'env.d.ts'].includes(filename)) {
+  }
+  else if (['package.json', 'vite.config.mts', 'config.mts', 'index.md', 'introduction.md', 'App.vue', 'tsconfig.app.json', 'env.d.ts'].includes(filename)) {
     const template = fs.readFileSync(templatePath, 'utf-8')
     const content = template
       .replace(/@projectName@/g, config.mainPackageDirName)
       .replace(new RegExp(`@(${Object.keys(config).join('|')})@`, 'g'), (all, setting) => config[setting] ?? all)
 
     fs.writeFileSync(targetPath, content)
-  } else {
+  }
+  else {
     fs.copyFileSync(templatePath, targetPath)
   }
 }

packages/docs/.vitepress/config.mts

@@ -1,5 +1,3 @@
-import { resolve } from 'node:path'
-
 import { defineConfigWithTheme } from 'vitepress'
 
 export default defineConfigWithTheme({

packages/docs/env.d.ts

@@ -0,0 +1 @@
+/// <reference types="vite/client" />

packages/docs/package.json

@@ -3,8 +3,13 @@
   "scripts": {
     "clean": "rimraf dist .vitepress/cache",
     "dev": "vitepress dev .",
-    "build": "vitepress build .",
-    "preview": "vitepress preview ."
+    "type-check:code": "vue-tsc --noEmit -p tsconfig.app.json --composite false",
+    "type-check:config": "vue-tsc --noEmit -p tsconfig.node.json --composite false",
+    "type-check": "run-p -c type-check:*",
+    "build:only": "vitepress build .",
+    "build": "run-p -c type-check \"build:only {@}\" --",
+    "preview": "vitepress preview .",
+    "preinstall": "node ../../scripts/preinstall.js"
   },
   "dependencies": {
     "vue": "^3.5.13"

packages/docs/src/index.md

@@ -1,4 +1,4 @@
-<script setup>
+<script setup lang="ts">
 import { useRouter, withBase } from 'vitepress'
 import { onMounted } from 'vue'
 

packages/docs/tsconfig.app.json

@@ -0,0 +1,14 @@
+{
+  "extends": "@vue/tsconfig/tsconfig.dom.json",
+  "include": [
+    "env.d.ts",
+    "src/**/*",
+    "src/**/*.vue",
+    ".vitepress/theme/**/*",
+    ".vitepress/theme/**/*.vue",
+    "src/**/*.md"
+  ],
+  "vueCompilerOptions": {
+    "vitePressExtensions": [".md"]
+  }
+}

packages/docs/tsconfig.json

@@ -0,0 +1,11 @@
+{
+  "files": [],
+  "references": [
+    {
+      "path": "./tsconfig.node.json"
+    },
+    {
+      "path": "./tsconfig.app.json"
+    }
+  ]
+}