Skip to content

feat(dts): emit .d.vue.ts as type declaration of .vue files #301

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
merged 8 commits into from
Sep 11, 2025
Merged

feat(dts): emit .d.vue.ts as type declaration of .vue files #301

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
a9da461
fix(vue): force emit dts for build-in loader
Teages Apr 8, 2025
aa87bea
test: isolate test environment
Teages Apr 8, 2025
73f6639
Merge branch 'main' into fix/emit-dts-for-build-in-loader
Teages Jul 15, 2025
e68b87b
type: ignore unknown source when generate normal type declarations
Teages Jul 19, 2025
f19ac6e
type: generate `.d.vue.ts` for vue files
Teages Jul 19, 2025
c538d66
fix: use input file contents to generate vue dts
Teages Jul 19, 2025
9269a5a
test: update `.d.vue.ts` test result
Teages Jul 19, 2025
b0b56b5
Merge branch 'main' into fix/emit-dts-for-build-in-loader
danielroe Aug 11, 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
31 changes: 24 additions & 7 deletions src/loaders/vue.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,12 +76,22 @@ function defineVueLoader(options?: DefineVueLoaderOptions): Loader {
].filter((item) => !!item);

// generate dts
await context.loadFile({
path: `${input.path}.js`,
srcPath: `${input.srcPath}.js`,
extension: ".js",
getContents: () => "export default {}",
});
addOutput(
{
contents: "export default {}",
path: `${input.path}.js`,
srcPath: `${input.srcPath}.js`,
extension: ".d.ts",
declaration: true,
},
{
contents: await input.getContents(),
path: input.path,
srcPath: input.srcPath,
extension: ".d.vue.ts",
declaration: true,
},
);

const results = await Promise.all(
blocks.map(async (data) => {
Expand All @@ -99,7 +109,14 @@ function defineVueLoader(options?: DefineVueLoaderOptions): Loader {
);

if (!modified) {
return;
addOutput({
path: input.path,
srcPath: input.srcPath,
extension: ".vue",
contents: raw,
declaration: false,
});
return output;
}

// skiped blocks
Expand Down
6 changes: 5 additions & 1 deletion src/utils/dts.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,13 +22,17 @@ export type DeclarationOutput = Record<
{ contents: string; errors?: Error[] }
>;

const KNOWN_TS_SOURCE_EXT_RE = /\.[cm]?[jt]sx?$/;

export async function getDeclarations(
vfs: Map<string, string>,
opts?: MkdistOptions,
): Promise<DeclarationOutput> {
const ts = await import("typescript").then((r) => r.default || r);

const inputFiles = [...vfs.keys()];
const inputFiles = [...vfs.keys()].filter((path) =>
path.match(KNOWN_TS_SOURCE_EXT_RE),
);

const tsHost = ts.createCompilerHost(opts.typescript.compilerOptions);

Expand Down
4 changes: 4 additions & 0 deletions src/utils/vue-dts.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,10 @@ export async function getVueDeclarations(
}
}

for (const [vuePath, dtsSrcPath] of Object.entries(fileMapping)) {
output[vuePath] = output[dtsSrcPath];
}

return output;
}

Expand Down
210 changes: 206 additions & 4 deletions test/index.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@ import {
afterAll,
} from "vitest";
import { createLoader } from "../src/loader";
import { afterEach } from "vitest";

describe("mkdist", () => {
let mkdist: typeof import("../src/make").mkdist;
Expand Down Expand Up @@ -131,18 +130,25 @@ describe("mkdist", () => {
"dist/components/index.d.ts",
"dist/components/blank.vue",
"dist/components/blank.vue.d.ts",
// TODO: "dist/components/blank.d.vue.ts",
"dist/components/define-model.vue",
"dist/components/define-model.vue.d.ts",
// TODO: "dist/components/define-model.d.vue.ts",
"dist/components/emit-and-with-default.vue",
"dist/components/emit-and-with-default.vue.d.ts",
// TODO: "dist/components/emit-and-with-default.d.vue.ts",
"dist/components/js.vue",
"dist/components/js.vue.d.ts",
// TODO: "dist/components/js.d.vue.ts",
"dist/components/script-multi-block.vue",
"dist/components/script-multi-block.vue.d.ts",
// TODO: "dist/components/script-multi-block.d.vue.ts",
"dist/components/script-setup-ts.vue",
"dist/components/script-setup-ts.vue.d.ts",
// TODO: "dist/components/script-setup-ts.d.vue.ts",
"dist/components/ts.vue",
"dist/components/ts.vue.d.ts",
// TODO: "dist/components/ts.d.vue.ts",
"dist/components/jsx.mjs",
"dist/components/tsx.mjs",
"dist/components/jsx.d.ts",
Expand Down Expand Up @@ -639,7 +645,7 @@ describe("mkdist", () => {

describe("mkdist with fallback vue loader", () => {
const consoleWarnSpy = vi.spyOn(console, "warn");
beforeAll(() => {
beforeAll(async () => {
vi.resetModules();
vi.doMock("vue-sfc-transformer/mkdist", async () => {
throw new Error("vue-sfc-transformer is not installed");
Expand All @@ -650,7 +656,7 @@ describe("mkdist with fallback vue loader", () => {
vi.doUnmock("vue-sfc-transformer/mkdist");
});

afterEach(() => {
beforeEach(() => {
consoleWarnSpy.mockReset();
});

Expand Down Expand Up @@ -727,10 +733,192 @@ describe("mkdist with fallback vue loader", () => {
getContents: () => input,
path: "test.vue",
});
return results?.[0].contents || input;
return results?.filter((res) => !res.declaration)?.[0].contents || input;
}
});

describe("mkdist with fallback vue loader (emit types)", () => {
let mkdist: typeof import("../src/make").mkdist;

const consoleWarnSpy = vi.spyOn(console, "warn");
beforeAll(async () => {
mkdist = (await import("../src/make")).mkdist;

vi.resetModules();
vi.doMock("vue-sfc-transformer/mkdist", async () => {
throw new Error("vue-sfc-transformer is not installed");
});
});

afterAll(() => {
vi.doUnmock("vue-sfc-transformer/mkdist");
});

beforeEach(() => {
consoleWarnSpy.mockReset();
});

it("emit types", async () => {
const rootDir = resolve(__dirname, "fixture");
const { writtenFiles } = await mkdist({
rootDir,
declaration: true,
addRelativeDeclarationExtensions: true,
});
expect(writtenFiles.sort()).toEqual(
[
"dist/README.md",
"dist/bar.d.ts",
"dist/bar.mjs",
"dist/demo.css",
"dist/dir-export.d.ts",
"dist/dir-export.mjs",
"dist/foo.mjs",
"dist/foo.d.ts",
"dist/index.mjs",
"dist/index.d.ts",
"dist/star/index.mjs",
"dist/star/index.d.ts",
"dist/star/other.mjs",
"dist/star/other.d.ts",
"dist/types.d.ts",
"dist/components/index.mjs",
"dist/components/index.d.ts",
"dist/components/blank.vue",
"dist/components/blank.vue.d.ts",
"dist/components/blank.d.vue.ts",
"dist/components/define-model.vue",
"dist/components/define-model.vue.d.ts",
"dist/components/define-model.d.vue.ts",
"dist/components/emit-and-with-default.vue",
"dist/components/emit-and-with-default.vue.d.ts",
"dist/components/emit-and-with-default.d.vue.ts",
"dist/components/js.vue",
"dist/components/js.vue.d.ts",
"dist/components/js.d.vue.ts",
"dist/components/script-multi-block.vue",
"dist/components/script-multi-block.vue.d.ts",
"dist/components/script-multi-block.d.vue.ts",
"dist/components/script-setup-ts.vue",
"dist/components/script-setup-ts.vue.d.ts",
"dist/components/script-setup-ts.d.vue.ts",
"dist/components/ts.vue",
"dist/components/ts.vue.d.ts",
"dist/components/ts.d.vue.ts",
"dist/components/jsx.mjs",
"dist/components/tsx.mjs",
"dist/components/jsx.d.ts",
"dist/components/tsx.d.ts",
"dist/bar/index.mjs",
"dist/bar/index.d.ts",
"dist/bar/esm.mjs",
"dist/bar/esm.d.mts",
"dist/ts/test1.mjs",
"dist/ts/test2.mjs",
"dist/ts/test1.d.mts",
"dist/ts/test2.d.cts",
"dist/nested.css",
"dist/prop-types/index.mjs",
"dist/prop-types/index.d.ts",
]
.map((f) => resolve(rootDir, f))
.sort(),
);

expect(await readFile(resolve(rootDir, "dist/foo.d.ts"), "utf8")).toMatch(
"manual declaration",
);

expect(await readFile(resolve(rootDir, "dist/star/index.d.ts"), "utf8"))
.toMatchInlineSnapshot(`
"export * from "./other.js";
export type { Other } from "./other.js";
export declare function wonder(twinkle: import("./other.js").Other): string;
"
`);

expect(await readFile(resolve(rootDir, "dist/dir-export.d.ts"), "utf8"))
.toMatchInlineSnapshot(`
"export { default as bar } from "./bar.js";
export * from "./star/index.js";
"
`);

expect(
await readFile(resolve(rootDir, "dist/bar/esm.d.mts"), "utf8"),
).toMatch("declare");

expect(
await readFile(resolve(rootDir, "dist/components/index.d.ts"), "utf8"),
).toMatchInlineSnapshot(`
"export * as jsx from "./jsx.jsx.js";
export * as tsx from "./tsx.tsx.js";
export * as blank from "./blank.vue.js";
export * as scriptSetupTS from "./script-setup-ts.vue.js";
export * as scriptMultiBlock from "./script-multi-block.vue.js";
export * as ts from "./ts.vue.js";
"
`);

expect(
await readFile(resolve(rootDir, "dist/components/ts.vue.d.ts"), "utf8"),
).toMatchInlineSnapshot(`
"declare const _default: import("vue").DefineComponent<{}, {}, {
test: string;
str: "test";
}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
export default _default;
"
`);

expect(
await readFile(
resolve(rootDir, "dist/components/blank.vue.d.ts"),
"utf8",
),
).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 readFile(
resolve(rootDir, "dist/components/script-multi-block.vue.d.ts"),
"utf8",
),
).toMatchInlineSnapshot(`
"interface MyComponentProps {
msg: string;
}
declare const _default: import("vue").DefineComponent<MyComponentProps, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<MyComponentProps> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
export default _default;
"
`);

expect(
await readFile(
resolve(rootDir, "dist/components/script-setup-ts.vue.d.ts"),
"utf8",
),
).toMatchInlineSnapshot(`
"import { Color } from "#prop-types";
type __VLS_Props = {
msg: string;
color: Color;
};
declare const _default: import("vue").DefineComponent<__VLS_Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
export default _default;
"
`);

expect(consoleWarnSpy).toHaveBeenCalledWith(
"[mkdist] vue-sfc-transformer is not installed. mkdist will not transform typescript syntax in Vue SFCs.",
);
expect(consoleWarnSpy).toHaveBeenCalledTimes(1);
}, 50_000);
});

describe("mkdist with vue-tsc v1", () => {
beforeAll(() => {
vi.resetModules();
Expand Down Expand Up @@ -787,18 +975,25 @@ describe("mkdist with vue-tsc v1", () => {
"dist/components/index.d.ts",
"dist/components/blank.vue",
"dist/components/blank.vue.d.ts",
// TODO: "dist/components/blank.d.vue.ts",
"dist/components/define-model.vue",
"dist/components/define-model.vue.d.ts",
// TODO: "dist/components/define-model.d.vue.ts",
"dist/components/emit-and-with-default.vue",
"dist/components/emit-and-with-default.vue.d.ts",
// TODO: "dist/components/emit-and-with-default.d.vue.ts",
"dist/components/js.vue",
"dist/components/js.vue.d.ts",
// TODO: "dist/components/js.d.vue.ts",
"dist/components/script-multi-block.vue",
"dist/components/script-multi-block.vue.d.ts",
// TODO: "dist/components/script-multi-block.d.vue.ts",
"dist/components/script-setup-ts.vue",
"dist/components/script-setup-ts.vue.d.ts",
// TODO: "dist/components/script-setup-ts.d.vue.ts",
"dist/components/ts.vue",
"dist/components/ts.vue.d.ts",
// TODO: "dist/components/ts.d.vue.ts",
"dist/components/jsx.mjs",
"dist/components/tsx.mjs",
"dist/components/jsx.d.ts",
Expand Down Expand Up @@ -989,18 +1184,25 @@ describe("mkdist with vue-tsc ~v2.0.21", () => {
"dist/components/index.d.ts",
"dist/components/blank.vue",
"dist/components/blank.vue.d.ts",
// TODO: "dist/components/blank.d.vue.ts",
"dist/components/define-model.vue",
"dist/components/define-model.vue.d.ts",
// TODO: "dist/components/define-model.d.vue.ts",
"dist/components/emit-and-with-default.vue",
"dist/components/emit-and-with-default.vue.d.ts",
// TODO: "dist/components/emit-and-with-default.d.vue.ts",
"dist/components/js.vue",
"dist/components/js.vue.d.ts",
// TODO: "dist/components/js.d.vue.ts",
"dist/components/script-multi-block.vue",
"dist/components/script-multi-block.vue.d.ts",
// TODO: "dist/components/script-multi-block.d.vue.ts",
"dist/components/script-setup-ts.vue",
"dist/components/script-setup-ts.vue.d.ts",
// TODO: "dist/components/script-setup-ts.d.vue.ts",
"dist/components/ts.vue",
"dist/components/ts.vue.d.ts",
// TODO: "dist/components/ts.d.vue.ts",
"dist/components/jsx.mjs",
"dist/components/tsx.mjs",
"dist/components/jsx.d.ts",
Expand Down
Loading