Skip to content
This repository has been archived by the owner on May 22, 2020. It is now read-only.
/ svelte2tsx Public archive

Convert svelte components to TSX for type checking

License

Notifications You must be signed in to change notification settings

halfnelson/svelte2tsx

Repository files navigation

We have moved

This code has a new home in the svelte language tools monorepo https://github.com/sveltejs/language-tools/tree/master/packages

svelte2tsx

Converts Svelte component source into TSX. The TSX can be type checked using the included svelte-jsx.d.ts and svelte-shims.d.ts.

This project only converts svelte to tsx, type checking is left to consumers of this plugin such as language services

type SvelteCompiledToTsx = {
    code: string,
    map: import("magic-string").SourceMap
}

export default function svelte2tsx(svelte: string): SvelteCompiledToTsx

For example

Input.svelte

<h1>hello {world}</h1>
<script>
    export let world = "name"
</script>

will produce this ugly but type checkable TSX

<></>;function render() {

     let world = "name"
;
<><h1>hello {world}</h1>
</>
return { props: {world}, slots: {} }}

export default class {
    $$prop_def = __sveltets_partial(render().props)
    $$slot_def = render().slots
}

with a v3 SourceMap back to the original source.

For more examples of the transformations, see the test/**/samples folders

About

Convert svelte components to TSX for type checking

Resources

License

Stars

Watchers

Forks

Packages

No packages published