,
- { default: {} }
-> {}
-"
+ "isRequired": false,
+ "constant": false,
+ "reactive": false
+ }
+ ],
+ "moduleExports": [],
+ "slots": [],
+ "events": [],
+ "typedefs": []
+}"
`;
-exports[`fixtures (TypeScript) > 'component-comment-multi/input.svelte' 1`] = `
+exports[`fixtures (TypeScript) "svg-props/input.svelte" 1`] = `
"import type { SvelteComponentTyped } from "svelte";
+import type { SvelteHTMLElements } from "svelte/elements";
-export interface ComponentCommentMultiProps {}
-
-/**
- * @example
- *
- * Component comment
- *
- */
-export default class ComponentCommentMulti extends SvelteComponentTyped<
- ComponentCommentMultiProps,
- Record,
- { default: {} }
-> {}
-"
-`;
-
-exports[`fixtures (TypeScript) > 'component-comment-single/input.svelte' 1`] = `
-"import type { SvelteComponentTyped } from "svelte";
+type RestProps = SvelteHTMLElements["svg"];
-export interface ComponentCommentSingleProps {}
+export interface SvgPropsProps extends RestProps {
+ [key: \`data-${string}\`]: any;
+}
-/** Component comment */
-export default class ComponentCommentSingle extends SvelteComponentTyped<
- ComponentCommentSingleProps,
- Record,
- { default: {} }
-> {}
+export default class SvgProps extends SvelteComponentTyped, {}> {}
"
`;
-exports[`fixtures (TypeScript) > 'context-module/input.svelte' 1`] = `
+exports[`fixtures (TypeScript) "slots-named/input.svelte" 1`] = `
"import type { SvelteComponentTyped } from "svelte";
-export type bool = string;
-
-export type a = { b: 4 };
-
-/**
- * Description for e
- */
-export type e = { [key: string]: any };
-
-/**
- * Log something
- */
-export declare function log(message: string): void;
-
-export declare function b(): {};
-
-export declare function b2(): () => {};
-
-export declare function b3(): () => false;
-
-export interface ContextModuleProps {}
-
-export default class ContextModule extends SvelteComponentTyped, {}> {
- a: string;
+export interface SlotsNamedProps {
+ /**
+ * @default ""
+ */
+ text?: string;
}
-"
-`;
-
-exports[`fixtures (TypeScript) > 'dispatched-events/input.svelte' 1`] = `
-"import type { SvelteComponentTyped } from "svelte";
-export interface DispatchedEventsProps {}
-
-export default class DispatchedEvents extends SvelteComponentTyped<
- DispatchedEventsProps,
- {
- hover: CustomEvent;
- destroy: CustomEvent;
- ["destroy--component"]: CustomEvent;
- ["destroy:component"]: CustomEvent;
- },
- { default: {} }
+export default class SlotsNamed extends SvelteComponentTyped<
+ SlotsNamedProps,
+ Record,
+ { default: {}; ["bold heading"]: { text: string }; subheading: { text: string }; text: { text: string } }
> {}
"
`;
-exports[`fixtures (TypeScript) > 'dispatched-events-dynamic/input.svelte' 1`] = `
+exports[`fixtures (TypeScript) "dispatched-events-dynamic/input.svelte" 1`] = `
"import type { SvelteComponentTyped } from "svelte";
export interface DispatchedEventsDynamicProps {}
@@ -1263,32 +1157,34 @@ export default class DispatchedEventsDynamic extends SvelteComponentTyped<
"
`;
-exports[`fixtures (TypeScript) > 'dispatched-events-typed/input.svelte' 1`] = `
+exports[`fixtures (TypeScript) "function-declaration/input.svelte" 1`] = `
"import type { SvelteComponentTyped } from "svelte";
-export interface DispatchedEventsTypedProps {}
-
-export default class DispatchedEventsTyped extends SvelteComponentTyped<
- DispatchedEventsTypedProps,
- {
- /** Fired on mouseover. */ hover: CustomEvent<{ h1: boolean }>;
- destroy: CustomEvent;
- },
- { default: {} }
-> {}
-"
-`;
+export interface FunctionDeclarationProps {
+ /**
+ * @default () => {}
+ */
+ fnA?: () => {};
+}
-exports[`fixtures (TypeScript) > 'empty-export/input.svelte' 1`] = `
-"import type { SvelteComponentTyped } from "svelte";
+export default class FunctionDeclaration extends SvelteComponentTyped<
+ FunctionDeclarationProps,
+ Record,
+ {}
+> {
+ fnB: () => {};
-export interface EmptyExportProps {}
+ add: () => any;
-export default class EmptyExport extends SvelteComponentTyped, {}> {}
+ /**
+ * Multiplies two numbers
+ */
+ multiply: (a: number, b: number) => number;
+}
"
`;
-exports[`fixtures (TypeScript) > 'forwarded-events/input.svelte' 1`] = `
+exports[`fixtures (TypeScript) "forwarded-events/input.svelte" 1`] = `
"import type { SvelteComponentTyped } from "svelte";
export interface ForwardedEventsProps {}
@@ -1306,34 +1202,20 @@ export default class ForwardedEvents extends SvelteComponentTyped<
"
`;
-exports[`fixtures (TypeScript) > 'function-declaration/input.svelte' 1`] = `
+exports[`fixtures (TypeScript) "mixed-events/input.svelte" 1`] = `
"import type { SvelteComponentTyped } from "svelte";
-export interface FunctionDeclarationProps {
- /**
- * @default () => {}
- */
- fnA?: () => {};
-}
+export interface MixedEventsProps {}
-export default class FunctionDeclaration extends SvelteComponentTyped<
- FunctionDeclarationProps,
- Record,
+export default class MixedEvents extends SvelteComponentTyped<
+ MixedEventsProps,
+ { ["custom-focus"]: CustomEvent; blur: FocusEvent | CustomEvent },
{}
-> {
- fnB: () => {};
-
- add: () => any;
-
- /**
- * Multiplies two numbers
- */
- multiply: (a: number, b: number) => number;
-}
+> {}
"
`;
-exports[`fixtures (TypeScript) > 'infer-basic/input.svelte' 1`] = `
+exports[`fixtures (TypeScript) "infer-basic/input.svelte" 1`] = `
"import type { SvelteComponentTyped } from "svelte";
export interface InferBasicProps {
@@ -1371,44 +1253,115 @@ export default class InferBasic extends SvelteComponentTyped 'infer-with-types/input.svelte' 1`] = `
+exports[`fixtures (TypeScript) "empty-export/input.svelte" 1`] = `
"import type { SvelteComponentTyped } from "svelte";
-export interface InferWithTypesProps {
- /**
- * @default true
- */
- propBool?: boolean;
+export interface EmptyExportProps {}
+
+export default class EmptyExport extends SvelteComponentTyped, {}> {}
+"
+`;
+
+exports[`fixtures (TypeScript) "typed-slots/input.svelte" 1`] = `
+"import type { SvelteComponentTyped } from "svelte";
+export interface TypedSlotsProps {
/**
- * @default ""
+ * @default 0
*/
- propString?: string;
+ prop?: number;
+}
+
+export default class TypedSlots extends SvelteComponentTyped<
+ TypedSlotsProps,
+ Record,
+ {
+ default: { prop: number; doubled: number };
+ /** description */
+ description: { props: { class?: string } };
+ }
+> {}
+"
+`;
+
+exports[`fixtures (TypeScript) "dispatched-events/input.svelte" 1`] = `
+"import type { SvelteComponentTyped } from "svelte";
+
+export interface DispatchedEventsProps {}
+
+export default class DispatchedEvents extends SvelteComponentTyped<
+ DispatchedEventsProps,
+ {
+ hover: CustomEvent;
+ destroy: CustomEvent;
+ ["destroy--component"]: CustomEvent;
+ ["destroy:component"]: CustomEvent;
+ },
+ { default: {} }
+> {}
+"
+`;
+
+exports[`fixtures (TypeScript) "typedefs/input.svelte" 1`] = `
+"import type { SvelteComponentTyped } from "svelte";
+
+export interface MyTypedef {
+ [key: string]: boolean;
+}
+
+export type MyTypedefArray = MyTypedef[];
+export interface TypedefsProps {
/**
- * @default undefined
+ * @default { ["1"]: true }
*/
- name: string;
+ prop1?: MyTypedef;
/**
- * @default "" + Math.random().toString(36)
+ * @default []
*/
- id?: string;
+ prop2?: MyTypedefArray;
}
-export default class InferWithTypes extends SvelteComponentTyped<
- InferWithTypesProps,
+export default class Typedefs extends SvelteComponentTyped<
+ TypedefsProps,
Record,
- { default: {} }
-> {
- propConst: { [key: string]: boolean };
+ { default: { prop1: MyTypedef; prop2: MyTypedefArray } }
+> {}
+"
+`;
- fn: () => any;
+exports[`fixtures (TypeScript) "bind-this/input.svelte" 1`] = `
+"import type { SvelteComponentTyped } from "svelte";
+
+export interface BindThisProps {
+ /**
+ * @default undefined
+ */
+ ref: null | HTMLButtonElement;
}
+
+export default class BindThis extends SvelteComponentTyped, { default: {} }> {}
+"
+`;
+
+exports[`fixtures (TypeScript) "dispatched-events-typed/input.svelte" 1`] = `
+"import type { SvelteComponentTyped } from "svelte";
+
+export interface DispatchedEventsTypedProps {}
+
+export default class DispatchedEventsTyped extends SvelteComponentTyped<
+ DispatchedEventsTypedProps,
+ {
+ /** Fired on mouseover. */ hover: CustomEvent<{ h1: boolean }>;
+ destroy: CustomEvent;
+ },
+ { default: {} }
+> {}
"
`;
-exports[`fixtures (TypeScript) > 'input-events/input.svelte' 1`] = `
+exports[`fixtures (TypeScript) "input-events/input.svelte" 1`] = `
"import type { SvelteComponentTyped } from "svelte";
export interface InputEventsProps {}
@@ -1425,20 +1378,43 @@ export default class InputEvents extends SvelteComponentTyped<
"
`;
-exports[`fixtures (TypeScript) > 'mixed-events/input.svelte' 1`] = `
-"import type { SvelteComponentTyped } from "svelte";
+exports[`fixtures (TypeScript) "required/input.svelte" 1`] = `
+"import type { SvelteComponentTyped } from "svelte";
+
+export interface RequiredProps {
+ /**
+ * @required
+ * @default true
+ */
+ prop?: boolean;
+
+ /**
+ * This is a comment.
+ * @required
+ * @default true
+ */
+ prop1?: boolean | string;
+
+ /**
+ * @default undefined
+ */
+ prop2: undefined;
-export interface MixedEventsProps {}
+ /**
+ * @default undefined
+ */
+ prop3: boolean;
+}
-export default class MixedEvents extends SvelteComponentTyped<
- MixedEventsProps,
- { ["custom-focus"]: CustomEvent; blur: FocusEvent | CustomEvent },
- {}
+export default class Required extends SvelteComponentTyped<
+ RequiredProps,
+ Record,
+ { default: { prop: boolean; prop1: boolean | string; prop2: any; prop3: boolean } }
> {}
"
`;
-exports[`fixtures (TypeScript) > 'prop-comments/input.svelte' 1`] = `
+exports[`fixtures (TypeScript) "prop-comments/input.svelte" 1`] = `
"import type { SvelteComponentTyped } from "svelte";
export interface PropCommentsProps {
@@ -1471,7 +1447,7 @@ export default class PropComments extends SvelteComponentTyped<
"
`;
-exports[`fixtures (TypeScript) > 'renamed-props/input.svelte' 1`] = `
+exports[`fixtures (TypeScript) "renamed-props/input.svelte" 1`] = `
"import type { SvelteComponentTyped } from "svelte";
export interface RenamedPropsProps {
@@ -1486,57 +1462,89 @@ export default class RenamedProps extends SvelteComponentTyped 'required/input.svelte' 1`] = `
+exports[`fixtures (TypeScript) "infer-with-types/input.svelte" 1`] = `
"import type { SvelteComponentTyped } from "svelte";
-export interface RequiredProps {
+export interface InferWithTypesProps {
/**
- * @required
* @default true
*/
- prop?: boolean;
+ propBool?: boolean;
/**
- * This is a comment.
- * @required
- * @default true
+ * @default ""
*/
- prop1?: boolean | string;
+ propString?: string;
/**
* @default undefined
*/
- prop2: undefined;
+ name: string;
/**
- * @default undefined
+ * @default "" + Math.random().toString(36)
*/
- prop3: boolean;
+ id?: string;
}
-export default class Required extends SvelteComponentTyped<
- RequiredProps,
+export default class InferWithTypes extends SvelteComponentTyped<
+ InferWithTypesProps,
Record,
- { default: { prop: boolean; prop1: boolean | string; prop2: any; prop3: boolean } }
-> {}
+ { default: {} }
+> {
+ propConst: { [key: string]: boolean };
+
+ fn: () => any;
+}
+"
+`;
+
+exports[`fixtures (TypeScript) "context-module/input.svelte" 1`] = `
+"import type { SvelteComponentTyped } from "svelte";
+
+export type bool = string;
+
+export type a = { b: 4 };
+
+/**
+ * Description for e
+ */
+export type e = { [key: string]: any };
+
+/**
+ * Log something
+ */
+export declare function log(message: string): void;
+
+export declare function b(): {};
+
+export declare function b2(): () => {};
+
+export declare function b3(): () => false;
+
+export interface ContextModuleProps {}
+
+export default class ContextModule extends SvelteComponentTyped, {}> {
+ a: string;
+}
"
`;
-exports[`fixtures (TypeScript) > 'rest-props/input.svelte' 1`] = `
+exports[`fixtures (TypeScript) "rest-props/input.svelte" 1`] = `
"import type { SvelteComponentTyped } from "svelte";
import type { SvelteHTMLElements } from "svelte/elements";
type RestProps = SvelteHTMLElements["h1"];
export interface RestPropsProps extends RestProps {
- [key: \`data-\${string}\`]: any;
+ [key: \`data-${string}\`]: any;
}
export default class RestProps extends SvelteComponentTyped, {}> {}
"
`;
-exports[`fixtures (TypeScript) > 'rest-props-multiple/input.svelte' 1`] = `
+exports[`fixtures (TypeScript) "rest-props-multiple/input.svelte" 1`] = `
"import type { SvelteComponentTyped } from "svelte";
import type { SvelteHTMLElements } from "svelte/elements";
@@ -1553,178 +1561,170 @@ export interface RestPropsMultipleProps extends RestProps {
*/
heading?: boolean;
- [key: \`data-\${string}\`]: any;
+ [key: \`data-${string}\`]: any;
}
export default class RestPropsMultiple extends SvelteComponentTyped, {}> {}
"
`;
-exports[`fixtures (TypeScript) > 'slots-named/input.svelte' 1`] = `
+exports[`fixtures (TypeScript) "component-comment-single/input.svelte" 1`] = `
"import type { SvelteComponentTyped } from "svelte";
-export interface SlotsNamedProps {
- /**
- * @default ""
- */
- text?: string;
-}
+export interface ComponentCommentSingleProps {}
-export default class SlotsNamed extends SvelteComponentTyped<
- SlotsNamedProps,
+/** Component comment */
+export default class ComponentCommentSingle extends SvelteComponentTyped<
+ ComponentCommentSingleProps,
Record,
- { default: {}; ["bold heading"]: { text: string }; subheading: { text: string }; text: { text: string } }
+ { default: {} }
> {}
"
`;
-exports[`fixtures (TypeScript) > 'slots-spread/input.svelte' 1`] = `
+exports[`fixtures (TypeScript) "bind-this-multiple/input.svelte" 1`] = `
"import type { SvelteComponentTyped } from "svelte";
-export interface SlotsSpreadProps {}
+export interface BindThisMultipleProps {
+ /**
+ * @default undefined
+ */
+ ref: null | HTMLButtonElement | HTMLHeadingElement;
-export default class SlotsSpread extends SvelteComponentTyped<
- SlotsSpreadProps,
+ /**
+ * @default undefined
+ */
+ ref2: null | HTMLDivElement;
+
+ /**
+ * @default false
+ */
+ propBool?: boolean;
+}
+
+export default class BindThisMultiple extends SvelteComponentTyped<
+ BindThisMultipleProps,
Record,
- { default: {}; text: {} }
+ { default: {} }
> {}
"
`;
-exports[`fixtures (TypeScript) > 'slots-spread-typed/input.svelte' 1`] = `
+exports[`fixtures (TypeScript) "typedef/input.svelte" 1`] = `
"import type { SvelteComponentTyped } from "svelte";
-export interface SlotsSpreadTypedProps {}
+export interface MyTypedef {
+ [key: string]: boolean;
+}
-export default class SlotsSpreadTyped extends SvelteComponentTyped<
- SlotsSpreadTypedProps,
+export interface TypedefProps {
+ /**
+ * @default "id-" + Math.random().toString(36)
+ */
+ id?: string;
+
+ /**
+ * @default { ["1"]: true }
+ */
+ prop1?: MyTypedef;
+}
+
+export default class Typedef extends SvelteComponentTyped<
+ TypedefProps,
Record,
- { default: { a: number }; text: { a: number } }
+ { default: { prop1: MyTypedef } }
> {}
"
`;
-exports[`fixtures (TypeScript) > 'svg-props/input.svelte' 1`] = `
+exports[`fixtures (TypeScript) "anchor-props/input.svelte" 1`] = `
"import type { SvelteComponentTyped } from "svelte";
import type { SvelteHTMLElements } from "svelte/elements";
-type RestProps = SvelteHTMLElements["svg"];
+type RestProps = SvelteHTMLElements["a"];
-export interface SvgPropsProps extends RestProps {
- [key: \`data-\${string}\`]: any;
+export interface AnchorPropsProps extends RestProps {
+ [key: \`data-${string}\`]: any;
}
-export default class SvgProps extends SvelteComponentTyped, {}> {}
+export default class AnchorProps extends SvelteComponentTyped, { default: {} }> {}
"
`;
-exports[`fixtures (TypeScript) > 'typed-props/input.svelte' 1`] = `
+exports[`fixtures (TypeScript) "component-comment-multi/input.svelte" 1`] = `
"import type { SvelteComponentTyped } from "svelte";
-export interface TypedPropsProps {
- /**
- * prop1 description 1
- * prop1 description 2
- * @default undefined
- */
- prop1: string;
-
- /**
- * prop2 description 1
- * prop2 description 2
- * @default null
- */
- prop2?: undefined;
-
- /**
- * @default 4
- */
- prop3?: 4 | "4";
-
- /**
- * @default "red"
- */
- prop4?: "red" | "blue";
-}
+export interface ComponentCommentMultiProps {}
-export default class TypedProps extends SvelteComponentTyped, {}> {}
+/**
+ * @example
+ *
+ * Component comment
+ *
+ */
+export default class ComponentCommentMulti extends SvelteComponentTyped<
+ ComponentCommentMultiProps,
+ Record,
+ { default: {} }
+> {}
"
`;
-exports[`fixtures (TypeScript) > 'typed-slots/input.svelte' 1`] = `
+exports[`fixtures (TypeScript) "slots-spread/input.svelte" 1`] = `
"import type { SvelteComponentTyped } from "svelte";
-export interface TypedSlotsProps {
- /**
- * @default 0
- */
- prop?: number;
-}
+export interface SlotsSpreadProps {}
-export default class TypedSlots extends SvelteComponentTyped<
- TypedSlotsProps,
+export default class SlotsSpread extends SvelteComponentTyped<
+ SlotsSpreadProps,
Record,
- {
- default: { prop: number; doubled: number };
- /** description */
- description: { props: { class?: string } };
- }
+ { default: {}; text: {} }
> {}
"
`;
-exports[`fixtures (TypeScript) > 'typedef/input.svelte' 1`] = `
+exports[`fixtures (TypeScript) "slots-spread-typed/input.svelte" 1`] = `
"import type { SvelteComponentTyped } from "svelte";
-export interface MyTypedef {
- [key: string]: boolean;
-}
-
-export interface TypedefProps {
- /**
- * @default "id-" + Math.random().toString(36)
- */
- id?: string;
-
- /**
- * @default { ["1"]: true }
- */
- prop1?: MyTypedef;
-}
+export interface SlotsSpreadTypedProps {}
-export default class Typedef extends SvelteComponentTyped<
- TypedefProps,
+export default class SlotsSpreadTyped extends SvelteComponentTyped<
+ SlotsSpreadTypedProps,
Record,
- { default: { prop1: MyTypedef } }
+ { default: { a: number }; text: { a: number } }
> {}
"
`;
-exports[`fixtures (TypeScript) > 'typedefs/input.svelte' 1`] = `
+exports[`fixtures (TypeScript) "typed-props/input.svelte" 1`] = `
"import type { SvelteComponentTyped } from "svelte";
-export interface MyTypedef {
- [key: string]: boolean;
-}
+export interface TypedPropsProps {
+ /**
+ * prop1 description 1
+ * prop1 description 2
+ * @default undefined
+ */
+ prop1: string;
-export type MyTypedefArray = MyTypedef[];
+ /**
+ * prop2 description 1
+ * prop2 description 2
+ * @default null
+ */
+ prop2?: undefined;
-export interface TypedefsProps {
/**
- * @default { ["1"]: true }
+ * @default 4
*/
- prop1?: MyTypedef;
+ prop3?: 4 | "4";
/**
- * @default []
+ * @default "red"
*/
- prop2?: MyTypedefArray;
+ prop4?: "red" | "blue";
}
-export default class Typedefs extends SvelteComponentTyped<
- TypedefsProps,
- Record,
- { default: { prop1: MyTypedef; prop2: MyTypedefArray } }
-> {}
+export default class TypedProps extends SvelteComponentTyped, {}> {}
"
`;
diff --git a/tests/fixtures.test.ts b/tests/fixtures.test.ts
index 54534aa..899e6f5 100644
--- a/tests/fixtures.test.ts
+++ b/tests/fixtures.test.ts
@@ -1,21 +1,16 @@
-import fg from "fast-glob";
-import fsp from "node:fs/promises";
+import { Glob } from "bun";
import path from "node:path";
import ComponentParser from "../src/ComponentParser";
import Writer from "../src/writer/Writer";
import { writeTsDefinition } from "../src/writer/writer-ts-definitions";
const folder = path.join(process.cwd(), "tests", "fixtures");
+const fixtures_map = new Map();
-const svelteFiles = fg.sync(["**/*.svelte"], { cwd: folder });
-const fixtures = await Promise.all(
- svelteFiles.map(async (file) => {
- return {
- path: file,
- source: await fsp.readFile(path.join(folder, file), "utf-8"),
- };
- })
-);
+for await (const file of new Glob("**/*.svelte").scan(folder)) {
+ const source = await Bun.file(path.join(folder, file)).text();
+ fixtures_map.set(file, source);
+}
const createMetadata = (filePath: string) => {
const { dir } = path.parse(filePath);
@@ -29,31 +24,32 @@ const createMetadata = (filePath: string) => {
const parser = new ComponentParser();
const writer = new Writer({ parser: "typescript", printWidth: 120 });
+const files = Array.from(fixtures_map.keys());
describe("fixtures (JSON)", async () => {
- test.each(fixtures)("$path", async (fixture) => {
- const { dir, ...metadata } = createMetadata(fixture.path);
- const parsed_component = parser.parseSvelteComponent(fixture.source, metadata);
+ test.each(files)("%p", async (file) => {
+ const { dir, ...metadata } = createMetadata(file);
+ const parsed_component = parser.parseSvelteComponent(fixtures_map.get(file)!, metadata);
const api_json = JSON.stringify(parsed_component, null, 2);
// Snapshot the output; if the test fails, output has changed.
expect(api_json).toMatchSnapshot();
// Still write to disk to manually assert types as needed.
- await fsp.writeFile(path.join(folder, dir, "output.json"), api_json);
+ await Bun.write(path.join(folder, dir, "output.json"), api_json);
});
});
describe("fixtures (TypeScript)", async () => {
- test.each(fixtures)("$path", async (fixture) => {
- const { dir, ...metadata } = createMetadata(fixture.path);
- const parsed_component = parser.parseSvelteComponent(fixture.source, metadata);
+ test.each(files)("%p", async (file) => {
+ const { dir, ...metadata } = createMetadata(file);
+ const parsed_component = parser.parseSvelteComponent(fixtures_map.get(file)!, metadata);
const api_ts = writer.format(writeTsDefinition({ ...metadata, ...parsed_component }));
// Snapshot the output; if the test fails, output has changed.
expect(api_ts).toMatchSnapshot();
// Still write to disk to manually assert types as needed.
- await fsp.writeFile(path.join(folder, dir, "output.d.ts"), api_ts);
+ await Bun.write(path.join(folder, dir, "output.d.ts"), api_ts);
});
});