Skip to content

feat(mkdist): emit .d.vue.ts as type declaration of .vue files #83

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.

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

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
32 changes: 32 additions & 0 deletions src/plugins/mkdist.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
import type { LoaderFile } from '../block-loader/types'
import type { VueSFCTransformerFileLoader } from '../sfc-transformer'
import type { Loader } from '../types/mkdist'
import { readFileSync } from 'node:fs'
import { createRequire } from 'node:module'
import { resolve } from 'node:path'
import { scriptLoader } from '../block-loader/script'
import { styleLoader } from '../block-loader/style'
Expand All @@ -19,6 +21,27 @@ function importEsbuild(): Promise<typeof import('esbuild')> | typeof import('esb
})()
}

let _isMkdistSupportDualVueDts: boolean | undefined
function isMkdistSupportDualVueDts(): boolean {
if (typeof _isMkdistSupportDualVueDts === 'boolean') {
return _isMkdistSupportDualVueDts
}
try {
const require = createRequire(import.meta.url)
const mkdistPath = require.resolve('mkdist')
const packageJson = readFileSync(resolve(mkdistPath, '..', '..', 'package.json'), 'utf-8')
const { version = '0.0.0' } = JSON.parse(packageJson) as { version: string }
const [major = 0, minor = 0, patch = 0] = version.split('.').map(n => Number.parseInt(n))
const normalizedVersion = major * 1_000_000 + minor * 1_000 + patch

return !Number.isNaN(normalizedVersion) && normalizedVersion > 2_003_000
}
catch (error) {
console.error(`Error checking mkdist version: ${error}`)
return false
}
}

const vueSFCTransformer = defineVueSFCTransformer({
blockLoaders: {
template: templateLoader,
Expand Down Expand Up @@ -77,6 +100,15 @@ export const vueLoader: Loader = async (input, mkdistContext) => {
extension: '.js',
getContents: () => 'export default {}',
}))?.filter(f => f.declaration) || []
if (dts.length && isMkdistSupportDualVueDts()) {
dts.push({
contents: await input.getContents(),
path: input.path,
srcPath: input.srcPath,
extension: '.d.vue.ts',
declaration: true,
})
}

return [
{
Expand Down
23 changes: 22 additions & 1 deletion test/mkdist.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -234,7 +234,16 @@
const msg = 1
</script>`

expect(await legacyDeclaration(src)).toMatchInlineSnapshot(`
"declare const _default: import("vue").DefineComponent<{
msg: string;
}, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<{
msg: string;
}> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
export default _default;
"
`)
expect(await declaration(src)).toMatchInlineSnapshot(`

Check failure on line 246 in test/mkdist.test.ts

View workflow job for this annotation

GitHub Actions / test

test/mkdist.test.ts > transform typescript script setup > generates declaration

Error: Snapshot `transform typescript script setup > generates declaration 2` mismatched - Expected + Received - "declare const _default: import("vue").DefineComponent<{ - msg: string; - }, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<{ - msg: string; - }> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>; - export default _default; - " + undefined ❯ test/mkdist.test.ts:246:36
"declare const _default: import("vue").DefineComponent<{
msg: string;
}, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<{
Expand All @@ -245,6 +254,11 @@
`)

expect(await fixture(`<template><div /></template>`)).toMatchInlineSnapshot(`"<template><div /></template>"`)
expect(await legacyDeclaration(`<template><div /></template>`)).toMatchInlineSnapshot(`
"declare const _default: import("vue").DefineComponent<{}, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
export default _default;
"
`)
expect(await declaration(`<template><div /></template>`)).toMatchInlineSnapshot(`
"declare const _default: import("vue").DefineComponent<{}, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
export default _default;
Expand Down Expand Up @@ -424,11 +438,18 @@
return await readFile(join(tmpDir, 'dist/index.vue'), 'utf-8')
}

async function declaration(src: string): Promise<string | undefined> {
async function legacyDeclaration(src: string): Promise<string | undefined> {
await rm(tmpDir, { force: true, recursive: true })
await mkdir(join(tmpDir, 'src'), { recursive: true })
await writeFile(join(tmpDir, 'src/index.vue'), src)
await mkdist({ declaration: true, loaders: ['js', vueLoader], rootDir: tmpDir })
return await readFile(join(tmpDir, 'dist/index.vue.d.ts'), 'utf-8').catch(() => undefined)
}
async function declaration(src: string): Promise<string | undefined> {
await rm(tmpDir, { force: true, recursive: true })
await mkdir(join(tmpDir, 'src'), { recursive: true })
await writeFile(join(tmpDir, 'src/index.vue'), src)
await mkdist({ declaration: true, loaders: ['js', vueLoader], rootDir: tmpDir })
return await readFile(join(tmpDir, 'dist/index.d.vue.ts'), 'utf-8').catch(() => undefined)
}
})
Loading