perf: 优化全局 ts 配置

pany-ang · pany-ang · commit d29e5ba06274 · 2024-11-21T19:52:07.000+08:00
diff --git a/tsconfig.json b/tsconfig.json
@@ -1,5 +1,7 @@
+// https://www.typescriptlang.org/tsconfig
 // https://cn.vuejs.org/guide/typescript/overview#configuring-tsconfig-json
 // https://cn.vite.dev/guide/features#typescript-compiler-options
+
 {
   "compilerOptions": {
     "target": "esnext",
@@ -27,6 +29,13 @@
     "isolatedModules": true,
     "skipLibCheck": true
   },
-  // 编译器默认排除的编译文件
+  // 需要被编译的文件列表
+  "include": [
+    "**/*.ts",
+    "**/*.tsx",
+    "**/*.vue",
+    "**/*.d.ts"
+  ],
+  // 从编译中排除的文件列表
   "exclude": ["node_modules", "dist"]
 }
diff --git a/types/env.d.ts b/types/env.d.ts
@@ -1,7 +1,7 @@
 /** 声明 vite 环境变量的类型（如果未声明则默认是 any） */
 interface ImportMetaEnv {
   readonly VITE_APP_TITLE: string
-  readonly VITE_BASE_API: string
+  readonly VITE_BASE_URL: string
   readonly VITE_ROUTER_HISTORY: "hash" | "html5"
   readonly VITE_PUBLIC_PATH: string
 }
diff --git a/types/global-components.d.ts b/types/global-components.d.ts
@@ -1,10 +1,10 @@
 import type SvgIcon from "@/components/SvgIcon/index.vue"
 
-/** 由 app.component 全局注册的组件需要在这里声明 TS 类型才能获得 Volar 插件提供的类型提示） */
+export {}
+
+// 由 app.component 全局注册的组件需要在这里声明 TS 类型才能获得 Volar 插件提供的类型提示）
 declare module "vue" {
   export interface GlobalComponents {
     SvgIcon: typeof SvgIcon
   }
 }
-
-export {}
diff --git a/types/global-directives.d.ts b/types/global-directives.d.ts
@@ -0,0 +1,11 @@
+import type { Directive } from "vue"
+
+export {}
+
+// 由 app.directive 全局注册的自定义指令需要在这里声明 TS 类型才能获得类型提示
+declare module "vue" {
+  export interface ComponentCustomProperties {
+    vLoading: Directive<Element, boolean>
+    vPermission: Directive<Element, string[]>
+  }
+}
diff --git a/types/shims-vue.d.ts b/types/shims-vue.d.ts
diff --git a/types/vue-router.d.ts b/types/vue-router.d.ts
@@ -1,5 +1,7 @@
 import "vue-router"
 
+export {}
+
 declare module "vue-router" {
   interface RouteMeta {
     /**

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`/** 声明 vite 环境变量的类型（如果未声明则默认是 any） */`
`2`	`2`	`interface ImportMetaEnv {`
`3`	`3`	`readonly VITE_APP_TITLE: string`
`4`		`- readonly VITE_BASE_API: string`
	`4`	`+ readonly VITE_BASE_URL: string`
`5`	`5`	`readonly VITE_ROUTER_HISTORY: "hash" \| "html5"`
`6`	`6`	`readonly VITE_PUBLIC_PATH: string`
`7`	`7`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,10 +1,10 @@`
`1`	`1`	`import type SvgIcon from "@/components/SvgIcon/index.vue"`
`2`	`2`
`3`		`-/** 由 app.component 全局注册的组件需要在这里声明 TS 类型才能获得 Volar 插件提供的类型提示） */`
	`3`	`+export {}`
	`4`	`+`
	`5`	`+// 由 app.component 全局注册的组件需要在这里声明 TS 类型才能获得 Volar 插件提供的类型提示）`
`4`	`6`	`declare module "vue" {`
`5`	`7`	`export interface GlobalComponents {`
`6`	`8`	`SvgIcon: typeof SvgIcon`
`7`	`9`	`}`
`8`	`10`	`}`
`9`		`-`
`10`		`-export {}`