(fix) hover info for $store access (#909)

#901

Author: dummdidumm

packages/language-server/src/plugins/typescript/features/HoverProvider.ts

@@ -20,14 +20,28 @@ export class HoverProviderImpl implements HoverProvider {
             return eventHoverInfo;
         }
 
-        const info = lang.getQuickInfoAtPosition(
-            tsDoc.filePath,
-            fragment.offsetAt(fragment.getGeneratedPosition(position))
-        );
+        const offset = fragment.offsetAt(fragment.getGeneratedPosition(position));
+        let info = lang.getQuickInfoAtPosition(tsDoc.filePath, offset);
         if (!info) {
             return null;
         }
 
+        const textSpan = info.textSpan;
+
+        // show docs of $store instead of store if necessary
+        const is$store = fragment.text
+            .substring(0, info.textSpan.start)
+            .endsWith('(__sveltets_store_get(');
+        if (is$store) {
+            const infoFor$store = lang.getQuickInfoAtPosition(
+                tsDoc.filePath,
+                textSpan.start + textSpan.length + 3
+            );
+            if (infoFor$store) {
+                info = infoFor$store;
+            }
+        }
+
         const declaration = ts.displayPartsToString(info.displayParts);
         const documentation = getMarkdownDocumentation(info.documentation, info.tags);
 
@@ -37,7 +51,7 @@ export class HoverProviderImpl implements HoverProvider {
             .join('\n');
 
         return mapObjWithRangeToOriginal(fragment, {
-            range: convertRange(fragment, info.textSpan),
+            range: convertRange(fragment, textSpan),
             contents
         });
     }

packages/language-server/test/plugins/typescript/features/HoverProvider.test.ts

@@ -100,4 +100,90 @@ describe('HoverProvider', () => {
             }
         });
     });
+
+    it('provides hover info for $store access', async () => {
+        const { provider, document } = setup('hover-$store.svelte');
+
+        assert.deepStrictEqual(await provider.doHover(document, Position.create(3, 5)), <Hover>{
+            contents: '```typescript\nlet $b: string | {\n    a: boolean | string;\n}\n```',
+            range: {
+                end: {
+                    character: 6,
+                    line: 3
+                },
+                start: {
+                    character: 5,
+                    line: 3
+                }
+            }
+        });
+        assert.deepStrictEqual(await provider.doHover(document, Position.create(5, 9)), <Hover>{
+            contents: '```typescript\nlet $b: string\n```',
+            range: {
+                end: {
+                    character: 10,
+                    line: 5
+                },
+                start: {
+                    character: 9,
+                    line: 5
+                }
+            }
+        });
+        assert.deepStrictEqual(await provider.doHover(document, Position.create(7, 4)), <Hover>{
+            contents:
+                '```typescript\nconst b: Writable<string | {\n    a: boolean | string;\n}>\n```',
+            range: {
+                end: {
+                    character: 5,
+                    line: 7
+                },
+                start: {
+                    character: 4,
+                    line: 7
+                }
+            }
+        });
+
+        assert.deepStrictEqual(await provider.doHover(document, Position.create(10, 2)), <Hover>{
+            contents: '```typescript\nlet $b: string | {\n    a: boolean | string;\n}\n```',
+            range: {
+                end: {
+                    character: 3,
+                    line: 10
+                },
+                start: {
+                    character: 2,
+                    line: 10
+                }
+            }
+        });
+        assert.deepStrictEqual(await provider.doHover(document, Position.create(12, 6)), <Hover>{
+            contents: '```typescript\nlet $b: string\n```',
+            range: {
+                end: {
+                    character: 7,
+                    line: 12
+                },
+                start: {
+                    character: 6,
+                    line: 12
+                }
+            }
+        });
+        assert.deepStrictEqual(await provider.doHover(document, Position.create(14, 1)), <Hover>{
+            contents:
+                '```typescript\nconst b: Writable<string | {\n    a: boolean | string;\n}>\n```',
+            range: {
+                end: {
+                    character: 2,
+                    line: 14
+                },
+                start: {
+                    character: 1,
+                    line: 14
+                }
+            }
+        });
+    });
 });

packages/language-server/test/plugins/typescript/testfiles/hover/hover-$store.svelte

@@ -0,0 +1,15 @@
+<script lang="ts">
+    import { writable } from 'svelte/store';
+    const b = writable<{a: boolean | string} | string>('')
+    $b
+    if (typeof $b === 'string') {
+        $b;
+    }
+    b;
+</script>
+
+{$b}
+{#if typeof $b === 'string'}
+    {$b}
+{/if}
+{b}