Skip to content
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

Fix typescript module declaration #612

Merged
merged 3 commits into from
Aug 14, 2024
Merged
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
5 changes: 5 additions & 0 deletions .changeset/strong-toes-smile.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'mdsvex': patch
---

Fix typescript module declaration to resolve errors when importing markdown files as components
18 changes: 8 additions & 10 deletions packages/mdsvex/globals.d.ts
Original file line number Diff line number Diff line change
@@ -1,17 +1,15 @@
declare module '*.svx' {
import type { SvelteComponentDev } from 'svelte/internal';
import type { SvelteComponent } from 'svelte';

export default class Comp extends SvelteComponentDev {
$$prop_def: {};
}
export const metadata: Record<string, any>;
export default class Comp extends SvelteComponent {}

export const metadata: Record<string, unknown>;
}

declare module '*.svelte.md' {
import type { SvelteComponentDev } from 'svelte/internal';
import type { SvelteComponent } from 'svelte';

export default class Comp extends SvelteComponent {}

export default class Comp extends SvelteComponentDev {
$$prop_def: {};
}
export const metadata: Record<string, any>;
export const metadata: Record<string, unknown>;
}
11 changes: 11 additions & 0 deletions packages/site/src/routes/_docs.svtext
Original file line number Diff line number Diff line change
Expand Up @@ -189,6 +189,17 @@ export default {
}
```

If you use TypeScript, you should also declare an ambient module:
```ts
declare module '*.md' {
import type { SvelteComponent } from 'svelte'

export default class Comp extends SvelteComponent{}

export const metadata: Record<string, unknown>
}
```

Then you can do:

```svx
Expand Down