feat(types): use GlobalDirectives instead of ComponentCustomProperties (#839)

KazariEX · web-flow · commit 61c2b07827d4 · 2025-05-26T12:56:21.000+08:00
diff --git a/src/core/declaration.ts b/src/core/declaration.ts
@@ -31,7 +31,7 @@ export function parseDeclaration(code: string): DeclarationImports | undefined {
   if (componentDeclaration)
     imports.component = extractImports(componentDeclaration)
 
-  const directiveDeclaration = /export\s+interface\s+ComponentCustomProperties\s*\{.*?\}/s.exec(code)?.[0]
+  const directiveDeclaration = /export\s+interface\s+GlobalDirectives\s*\{.*?\}/s.exec(code)?.[0]
   if (directiveDeclaration)
     imports.directive = extractImports(directiveDeclaration)
 
@@ -132,7 +132,7 @@ declare module 'vue' {`
   }
   if (Object.keys(declarations.directive).length > 0) {
     code += `
-  export interface ComponentCustomProperties {
+  export interface GlobalDirectives {
     ${declarations.directive.join('\n    ')}
   }`
   }
diff --git a/test/__snapshots__/dts.test.ts.snap b/test/__snapshots__/dts.test.ts.snap
@@ -29,7 +29,7 @@ export {}
 
 /* prettier-ignore */
 declare module 'vue' {
-  export interface ComponentCustomProperties {
+  export interface GlobalDirectives {
     vLoading: typeof import('test/directive/Loading')['default']
   }
 }
@@ -51,7 +51,7 @@ declare module 'vue' {
     RouterView: typeof import('vue-router')['RouterView']
     TestComp: typeof import('test/component/TestComp')['default']
   }
-  export interface ComponentCustomProperties {
+  export interface GlobalDirectives {
     vLoading: typeof import('test/directive/Loading')['default']
   }
 }
@@ -130,7 +130,7 @@ declare module 'vue' {
     SomeComp: typeof import('test/component/SomeComp')['default']
     TestComp: typeof import('test/component/TestComp')['default']
   }
-  export interface ComponentCustomProperties {
+  export interface GlobalDirectives {
     vDirective: typeof import('foo')
     vLoading: typeof import('test/directive/Loading')['default']
     vSome: typeof import('test/directive/Some')['default']
@@ -154,7 +154,7 @@ declare module 'vue' {
     RouterView: typeof import('vue-router')['RouterView']
     TestComp: typeof import('test/component/TestComp')['default']
   }
-  export interface ComponentCustomProperties {
+  export interface GlobalDirectives {
     vLoading: typeof import('test/directive/Loading')['default']
   }
 }
diff --git a/test/dts.test.ts b/test/dts.test.ts
@@ -57,7 +57,7 @@ declare module 'vue' {
     SomeComp: typeof import('test/component/SomeComp')['default']
     TestComp: typeof import('test/component/OldComp')['default']
   }
-  export   interface   ComponentCustomProperties{
+  export   interface   GlobalDirectives{
     // with comment: b
     // a:
     vSome: typeof import('test/directive/Some')['default'];vDirective:typeof import('foo')
@@ -179,7 +179,7 @@ declare module 'vue' {
     IMdiLightAlarm: typeof import('~icons/mdi-light/alarm')['default']
   }
 
-  export interface ComponentCustomProperties {
+  export interface GlobalDirectives {
     vDirective: typeof import('foo')
     vLoading: typeof import('test/directive/Loading')['default']
     vSome: typeof import('test/directive/Some')['default']

Original file line number	Diff line number	Diff line change
`@@ -29,7 +29,7 @@ export {}`
`29`	`29`
`30`	`30`	`/* prettier-ignore */`
`31`	`31`	`declare module 'vue' {`
`32`		`- export interface ComponentCustomProperties {`
	`32`	`+ export interface GlobalDirectives {`
`33`	`33`	`vLoading: typeof import('test/directive/Loading')['default']`
`34`	`34`	`}`
`35`	`35`	`}`
`@@ -51,7 +51,7 @@ declare module 'vue' {`
`51`	`51`	`RouterView: typeof import('vue-router')['RouterView']`
`52`	`52`	`TestComp: typeof import('test/component/TestComp')['default']`
`53`	`53`	`}`
`54`		`- export interface ComponentCustomProperties {`
	`54`	`+ export interface GlobalDirectives {`
`55`	`55`	`vLoading: typeof import('test/directive/Loading')['default']`
`56`	`56`	`}`
`57`	`57`	`}`
`@@ -130,7 +130,7 @@ declare module 'vue' {`
`130`	`130`	`SomeComp: typeof import('test/component/SomeComp')['default']`
`131`	`131`	`TestComp: typeof import('test/component/TestComp')['default']`
`132`	`132`	`}`
`133`		`- export interface ComponentCustomProperties {`
	`133`	`+ export interface GlobalDirectives {`
`134`	`134`	`vDirective: typeof import('foo')`
`135`	`135`	`vLoading: typeof import('test/directive/Loading')['default']`
`136`	`136`	`vSome: typeof import('test/directive/Some')['default']`
`@@ -154,7 +154,7 @@ declare module 'vue' {`
`154`	`154`	`RouterView: typeof import('vue-router')['RouterView']`
`155`	`155`	`TestComp: typeof import('test/component/TestComp')['default']`
`156`	`156`	`}`
`157`		`- export interface ComponentCustomProperties {`
	`157`	`+ export interface GlobalDirectives {`
`158`	`158`	`vLoading: typeof import('test/directive/Loading')['default']`
`159`	`159`	`}`
`160`	`160`	`}`