Skip to content

Commit

Permalink
fix(compiler-sfc): support resolving type declaration from normal scr…
Browse files Browse the repository at this point in the history
…ipt (vuejs#5831)

fix vuejs#5830
  • Loading branch information
edison1105 authored and zhangzhonghe committed Apr 12, 2023
1 parent 63a3997 commit 4fd7bc7
Show file tree
Hide file tree
Showing 3 changed files with 99 additions and 17 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -1446,6 +1446,24 @@ export default /*#__PURE__*/_defineComponent({



return { emit }
}

})"
`;

exports[`SFC compile <script setup> > with TypeScript > defineEmits w/ type from normal script 1`] = `
"import { defineComponent as _defineComponent } from 'vue'

export interface Emits { (e: 'foo' | 'bar'): void }

export default /*#__PURE__*/_defineComponent({
emits: [\\"foo\\", \\"bar\\"],
setup(__props, { expose, emit }: { emit: ({ (e: 'foo' | 'bar'): void }), expose: any, slots: any, attrs: any }) {
expose();



return { emit }
}

Expand Down Expand Up @@ -1764,6 +1782,30 @@ return { props, get defaults() { return defaults } }
})"
`;

exports[`SFC compile <script setup> > with TypeScript > withDefaults (static) + normal script 1`] = `
"import { defineComponent as _defineComponent } from 'vue'

interface Props {
a?: string;
}

export default /*#__PURE__*/_defineComponent({
props: {
a: { type: String, required: false, default: \\"a\\" }
},
setup(__props: any, { expose }) {
expose();

const props = __props as { a: string };



return { props }
}

})"
`;

exports[`SFC compile <script setup> > with TypeScript > withDefaults (static) 1`] = `
"import { defineComponent as _defineComponent } from 'vue'

Expand Down
31 changes: 31 additions & 0 deletions packages/compiler-sfc/__tests__/compileScript.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1121,6 +1121,22 @@ const emit = defineEmits(['a', 'b'])
})
})

test('withDefaults (static) + normal script', () => {
const { content } = compile(`
<script lang="ts">
interface Props {
a?: string;
}
</script>
<script setup lang="ts">
const props = withDefaults(defineProps<Props>(), {
a: "a",
});
</script>
`)
assertCode(content)
})

// #7111
test('withDefaults (static) w/ production mode', () => {
const { content } = compile(
Expand Down Expand Up @@ -1261,6 +1277,21 @@ const emit = defineEmits(['a', 'b'])
expect(content).toMatch(`emits: ["foo", "bar"]`)
})


test('defineEmits w/ type from normal script', () => {
const { content } = compile(`
<script lang="ts">
export interface Emits { (e: 'foo' | 'bar'): void }
</script>
<script setup lang="ts">
const emit = defineEmits<Emits>()
</script>
`)
assertCode(content)
expect(content).toMatch(`emit: ({ (e: 'foo' | 'bar'): void }),`)
expect(content).toMatch(`emits: ["foo", "bar"]`)
})

test('defineEmits w/ type (type alias)', () => {
const { content } = compile(`
<script setup lang="ts">
Expand Down
43 changes: 26 additions & 17 deletions packages/compiler-sfc/src/compileScript.ts
Original file line number Diff line number Diff line change
Expand Up @@ -136,6 +136,12 @@ export interface ImportBinding {
isUsedInTemplate: boolean
}

type FromNormalScript<T> = T & { __fromNormalScript?: boolean | null }
type PropsDeclType = FromNormalScript<TSTypeLiteral | TSInterfaceBody>
type EmitsDeclType = FromNormalScript<
TSFunctionType | TSTypeLiteral | TSInterfaceBody
>

/**
* Compile `<script setup>`
* It requires the whole SFC descriptor because we need to handle and merge
Expand Down Expand Up @@ -287,15 +293,11 @@ export function compileScript(
let propsRuntimeDefaults: ObjectExpression | undefined
let propsDestructureDecl: Node | undefined
let propsDestructureRestId: string | undefined
let propsTypeDecl: TSTypeLiteral | TSInterfaceBody | undefined
let propsTypeDecl: PropsDeclType | undefined
let propsTypeDeclRaw: Node | undefined
let propsIdentifier: string | undefined
let emitsRuntimeDecl: Node | undefined
let emitsTypeDecl:
| TSFunctionType
| TSTypeLiteral
| TSInterfaceBody
| undefined
let emitsTypeDecl: EmitsDeclType | undefined
let emitsTypeDeclRaw: Node | undefined
let emitIdentifier: string | undefined
let hasAwait = false
Expand Down Expand Up @@ -436,7 +438,7 @@ export function compileScript(
propsTypeDecl = resolveQualifiedType(
propsTypeDeclRaw,
node => node.type === 'TSTypeLiteral'
) as TSTypeLiteral | TSInterfaceBody | undefined
) as PropsDeclType | undefined

if (!propsTypeDecl) {
error(
Expand Down Expand Up @@ -567,7 +569,7 @@ export function compileScript(
emitsTypeDecl = resolveQualifiedType(
emitsTypeDeclRaw,
node => node.type === 'TSFunctionType' || node.type === 'TSTypeLiteral'
) as TSFunctionType | TSTypeLiteral | TSInterfaceBody | undefined
) as EmitsDeclType | undefined

if (!emitsTypeDecl) {
error(
Expand Down Expand Up @@ -667,7 +669,7 @@ export function compileScript(
function resolveQualifiedType(
node: Node,
qualifier: (node: Node) => boolean
) {
): Node | undefined {
if (qualifier(node)) {
return node
}
Expand All @@ -677,7 +679,8 @@ export function compileScript(
) {
const refName = node.typeName.name
const body = getAstBody()
for (const node of body) {
for (let i = 0; i < body.length; i++) {
const node = body[i]
let qualified = isQualifiedType(
node,
qualifier,
Expand All @@ -690,6 +693,8 @@ export function compileScript(
filterExtendsType(extendsTypes, bodies)
qualified.body = bodies
}
;(qualified as FromNormalScript<Node>).__fromNormalScript =
scriptAst && i >= scriptSetupAst.body.length
return qualified
}
}
Expand Down Expand Up @@ -877,8 +882,10 @@ export function compileScript(
}
}

function genSetupPropsType(node: TSTypeLiteral | TSInterfaceBody) {
const scriptSetupSource = scriptSetup!.content
function genSetupPropsType(node: PropsDeclType) {
const scriptSource = node.__fromNormalScript
? script!.content
: scriptSetup!.content
if (hasStaticWithDefaults()) {
// if withDefaults() is used, we need to remove the optional flags
// on props that have default values
Expand All @@ -903,20 +910,19 @@ export function compileScript(
res +=
m.key.name +
(m.type === 'TSMethodSignature' ? '()' : '') +
scriptSetupSource.slice(
scriptSource.slice(
m.typeAnnotation.start!,
m.typeAnnotation.end!
) +
', '
} else {
res +=
scriptSetupSource.slice(m.start!, m.typeAnnotation.end!) + `, `
res += scriptSource.slice(m.start!, m.typeAnnotation.end!) + `, `
}
}
}
return (res.length ? res.slice(0, -2) : res) + ` }`
} else {
return scriptSetupSource.slice(node.start!, node.end!)
return scriptSource.slice(node.start!, node.end!)
}
}

Expand Down Expand Up @@ -1480,7 +1486,10 @@ export function compileScript(
if (destructureElements.length) {
args += `, { ${destructureElements.join(', ')} }`
if (emitsTypeDecl) {
args += `: { emit: (${scriptSetup.content.slice(
const content = emitsTypeDecl.__fromNormalScript
? script!.content
: scriptSetup.content
args += `: { emit: (${content.slice(
emitsTypeDecl.start!,
emitsTypeDecl.end!
)}), expose: any, slots: any, attrs: any }`
Expand Down

0 comments on commit 4fd7bc7

Please sign in to comment.