Skip to content

feat: use GlobalDirectives instead of ComponentCustomProperties #839

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
antfu merged 2 commits into from
May 26, 2025
Merged

feat: use GlobalDirectives instead of ComponentCustomProperties #839

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7f389fa
feat: generate `GlobalDirectives`
KazariEX May 7, 2025
c1f8a38
refactor: remove `ComponentCustomProperties`
KazariEX May 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/core/declaration.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down Expand Up @@ -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 ')}
}`
}
Expand Down
8 changes: 4 additions & 4 deletions test/__snapshots__/dts.test.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ export {}

/* prettier-ignore */
declare module 'vue' {
export interface ComponentCustomProperties {
export interface GlobalDirectives {
vLoading: typeof import('test/directive/Loading')['default']
}
}
Expand All @@ -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']
}
}
Expand Down Expand Up @@ -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']
Expand All @@ -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']
}
}
Expand Down
4 changes: 2 additions & 2 deletions test/dts.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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')
Expand Down Expand Up @@ -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']
Expand Down