fix: deduplicate definition for rune-mode components (#2759)

Wrap it in ignore comments so they're filtered out

#2697

Author: jasonlyu123

packages/language-server/test/plugins/typescript/TypescriptPlugin.test.ts

@@ -18,6 +18,7 @@ import { ignoredBuildDirectories } from '../../../src/plugins/typescript/Snapsho
 import { pathToUrl } from '../../../src/utils';
 import { serviceWarmup } from './test-utils';
 import { internalHelpers } from 'svelte2tsx';
+import { VERSION } from 'svelte/compiler';
 
 const testDir = path.join(__dirname, 'testfiles');
 
@@ -818,4 +819,51 @@ describe('TypescriptPlugin', function () {
     after(() => {
         __resetCache();
     });
+
+    const isSvelte5Plus = Number(VERSION.split('.')[0]) >= 5;
+    if (!isSvelte5Plus) {
+        return;
+    }
+
+    it('provides definitions from svelte to rune-mode svelte doc', async () => {
+        const { plugin, document } = setup('definition/definition-rune.svelte');
+
+        const definitions = await plugin.getDefinitions(document, Position.create(4, 3));
+
+        assert.deepStrictEqual(definitions, [
+            {
+                originSelectionRange: {
+                    start: {
+                        character: 1,
+                        line: 4
+                    },
+                    end: {
+                        character: 13,
+                        line: 4
+                    }
+                },
+                targetRange: {
+                    start: {
+                        character: 1,
+                        line: 0
+                    },
+                    end: {
+                        character: 1,
+                        line: 0
+                    }
+                },
+                targetSelectionRange: {
+                    start: {
+                        character: 1,
+                        line: 0
+                    },
+                    end: {
+                        character: 1,
+                        line: 0
+                    }
+                },
+                targetUri: getUri('definition/imported-rune.svelte')
+            }
+        ]);
+    });
 });

packages/language-server/test/plugins/typescript/testfiles/definition/definition-rune.svelte

@@ -0,0 +1,5 @@
+<script lang="ts">
+    import ImportedRune from './imported-rune.svelte';
+</script>
+
+<ImportedRune></ImportedRune>

packages/language-server/test/plugins/typescript/testfiles/definition/imported-rune.svelte

@@ -0,0 +1,3 @@
+<script lang="ts">
+    let {} = $props();
+</script>

packages/svelte2tsx/src/svelte2tsx/addComponentExport.ts

@@ -260,7 +260,11 @@ declare function $$__sveltets_2_isomorphic_component<
             if (exportedNames.usesRunes() && !usesSlots && !events.hasEvents()) {
                 statement =
                     `\n${doc}const ${componentName} = __sveltets_2_fn_component(${internalHelpers.renderName}());\n` +
-                    `type ${componentName} = ReturnType<typeof ${componentName}>;\n` +
+                    // Surround the type with ignore comments so it is filtered out from go-to-definition etc,
+                    // which for some editors can cause duplicates
+                    surroundWithIgnoreComments(
+                        `type ${componentName} = ReturnType<typeof ${componentName}>;\n`
+                    ) +
                     `export default ${componentName};`;
             } else {
                 statement =

packages/svelte2tsx/test/svelte2tsx/samples/export-list-runes.v5/expectedv2.ts

@@ -22,5 +22,5 @@ async () => {  { svelteHTML.createElement("svelte:options", {"runes":true,});}
 };
 return { props: /** @type {Record<string, never>} */ ({}), exports: /** @type {{name1: typeof name1,name2: typeof name2,renamed1: typeof rename1,renamed2: typeof rename2,Foo: typeof Foo,bar: typeof bar,baz: typeof baz,RenamedFoo: typeof RenameFoo,renamedbar: typeof renamebar,renamedbaz: typeof renamebaz}} */ ({}), bindings: __sveltets_$$bindings(''), slots: {}, events: {} }}
 const Input__SvelteComponent_ = __sveltets_2_fn_component($$render());
-type Input__SvelteComponent_ = ReturnType<typeof Input__SvelteComponent_>;
-export default Input__SvelteComponent_;
+/*Ωignore_startΩ*/type Input__SvelteComponent_ = ReturnType<typeof Input__SvelteComponent_>;
+/*Ωignore_endΩ*/export default Input__SvelteComponent_;

packages/svelte2tsx/test/svelte2tsx/samples/props-variable-and-$props.id-destructured.v5/expectedv2.ts

@@ -9,5 +9,5 @@ async () => {
 id; props;};
 return { props: /** @type {$$ComponentProps} */({}), exports: {}, bindings: __sveltets_$$bindings(''), slots: {}, events: {} }}
 const Input__SvelteComponent_ = __sveltets_2_fn_component($$render());
-type Input__SvelteComponent_ = ReturnType<typeof Input__SvelteComponent_>;
-export default Input__SvelteComponent_;
+/*Ωignore_startΩ*/type Input__SvelteComponent_ = ReturnType<typeof Input__SvelteComponent_>;
+/*Ωignore_endΩ*/export default Input__SvelteComponent_;

packages/svelte2tsx/test/svelte2tsx/samples/props-variable-and-$props.id-spread.v5/expectedv2.ts

@@ -9,5 +9,5 @@ async () => {
 id; props;};
 return { props: /** @type {$$ComponentProps} */({}), exports: {}, bindings: __sveltets_$$bindings(''), slots: {}, events: {} }}
 const Input__SvelteComponent_ = __sveltets_2_fn_component($$render());
-type Input__SvelteComponent_ = ReturnType<typeof Input__SvelteComponent_>;
-export default Input__SvelteComponent_;
+/*Ωignore_startΩ*/type Input__SvelteComponent_ = ReturnType<typeof Input__SvelteComponent_>;
+/*Ωignore_endΩ*/export default Input__SvelteComponent_;

packages/svelte2tsx/test/svelte2tsx/samples/props-variable-and-$props.id.v5/expectedv2.ts

@@ -9,5 +9,5 @@ async () => {
 id; props;};
 return { props: /** @type {$$ComponentProps} */({}), exports: {}, bindings: __sveltets_$$bindings(''), slots: {}, events: {} }}
 const Input__SvelteComponent_ = __sveltets_2_fn_component($$render());
-type Input__SvelteComponent_ = ReturnType<typeof Input__SvelteComponent_>;
-export default Input__SvelteComponent_;
+/*Ωignore_startΩ*/type Input__SvelteComponent_ = ReturnType<typeof Input__SvelteComponent_>;
+/*Ωignore_endΩ*/export default Input__SvelteComponent_;

packages/svelte2tsx/test/svelte2tsx/samples/renamed-exports-runes.v5/expectedv2.ts

@@ -10,5 +10,5 @@ async () => {  { svelteHTML.createElement("svelte:options", {"runes":true,});}
 };
 return { props: /** @type {Record<string, never>} */ ({}), exports: /** @type {{name3: typeof name,name4: typeof name2}} */ ({}), bindings: __sveltets_$$bindings(''), slots: {}, events: {} }}
 const Input__SvelteComponent_ = __sveltets_2_fn_component($$render());
-type Input__SvelteComponent_ = ReturnType<typeof Input__SvelteComponent_>;
-export default Input__SvelteComponent_;
+/*Ωignore_startΩ*/type Input__SvelteComponent_ = ReturnType<typeof Input__SvelteComponent_>;
+/*Ωignore_endΩ*/export default Input__SvelteComponent_;

packages/svelte2tsx/test/svelte2tsx/samples/runes-best-effort-types.v5/expectedv2.ts

@@ -6,5 +6,5 @@
 async () => {};
 return { props: /** @type {$$ComponentProps} */({}), exports: {}, bindings: __sveltets_$$bindings('j', 'k'), slots: {}, events: {} }}
 const Input__SvelteComponent_ = __sveltets_2_fn_component($$render());
-type Input__SvelteComponent_ = ReturnType<typeof Input__SvelteComponent_>;
-export default Input__SvelteComponent_;
+/*Ωignore_startΩ*/type Input__SvelteComponent_ = ReturnType<typeof Input__SvelteComponent_>;
+/*Ωignore_endΩ*/export default Input__SvelteComponent_;