-
-
Notifications
You must be signed in to change notification settings - Fork 196
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
(feat) component events hover info (#485)
Provides hover info for events with name, type, doc, if available
- Loading branch information
1 parent
5068244
commit 137b378
Showing
11 changed files
with
313 additions
and
131 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
93 changes: 93 additions & 0 deletions
93
packages/language-server/src/plugins/typescript/features/HoverProvider.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,93 @@ | ||
| import ts from 'typescript'; | ||
| import { Hover, Position } from 'vscode-languageserver'; | ||
| import { Document, getWordAt, mapHoverToParent } from '../../../lib/documents'; | ||
| import { HoverProvider } from '../../interfaces'; | ||
| import { SvelteDocumentSnapshot, SvelteSnapshotFragment } from '../DocumentSnapshot'; | ||
| import { LSAndTSDocResolver } from '../LSAndTSDocResolver'; | ||
| import { convertRange } from '../utils'; | ||
| import { getComponentAtPosition } from './utils'; | ||
|
|
||
| export class HoverProviderImpl implements HoverProvider { | ||
| constructor(private readonly lsAndTsDocResolver: LSAndTSDocResolver) {} | ||
|
|
||
| async doHover(document: Document, position: Position): Promise<Hover | null> { | ||
| const { lang, tsDoc } = this.getLSAndTSDoc(document); | ||
| const fragment = await tsDoc.getFragment(); | ||
|
|
||
| const eventHoverInfo = this.getEventHoverInfo(lang, document, tsDoc, fragment, position); | ||
| if (eventHoverInfo) { | ||
| return eventHoverInfo; | ||
| } | ||
|
|
||
| const info = lang.getQuickInfoAtPosition( | ||
| tsDoc.filePath, | ||
| fragment.offsetAt(fragment.getGeneratedPosition(position)), | ||
| ); | ||
| if (!info) { | ||
| return null; | ||
| } | ||
|
|
||
| const declaration = ts.displayPartsToString(info.displayParts); | ||
| const documentation = | ||
| typeof info.documentation === 'string' | ||
| ? info.documentation | ||
| : ts.displayPartsToString(info.documentation); | ||
|
|
||
| // https://microsoft.github.io/language-server-protocol/specification#textDocument_hover | ||
| const contents = ['```typescript', declaration, '```'] | ||
| .concat(documentation ? ['---', documentation] : []) | ||
| .join('\n'); | ||
|
|
||
| return mapHoverToParent(fragment, { | ||
| range: convertRange(fragment, info.textSpan), | ||
| contents, | ||
| }); | ||
| } | ||
|
|
||
| private getEventHoverInfo( | ||
| lang: ts.LanguageService, | ||
| doc: Document, | ||
| tsDoc: SvelteDocumentSnapshot, | ||
| fragment: SvelteSnapshotFragment, | ||
| originalPosition: Position, | ||
| ): Hover | null { | ||
| const possibleEventName = getWordAt(doc.getText(), doc.offsetAt(originalPosition), { | ||
| left: /\S+$/, | ||
| right: /[\s=]/, | ||
| }); | ||
| if (!possibleEventName.startsWith('on:')) { | ||
| return null; | ||
| } | ||
|
|
||
| const component = getComponentAtPosition( | ||
| this.lsAndTsDocResolver, | ||
| lang, | ||
| doc, | ||
| tsDoc, | ||
| fragment, | ||
| originalPosition, | ||
| ); | ||
| if (!component) { | ||
| return null; | ||
| } | ||
|
|
||
| const eventName = possibleEventName.substr('on:'.length); | ||
| const event = component.getEvents().find((event) => event.name === eventName); | ||
| if (!event) { | ||
| return null; | ||
| } | ||
|
|
||
| return { | ||
| contents: [ | ||
| '```typescript', | ||
| `${event.name}: ${event.type}`, | ||
| '```', | ||
| event.doc || '', | ||
| ].join('\n'), | ||
| }; | ||
| } | ||
|
|
||
| private getLSAndTSDoc(document: Document) { | ||
| return this.lsAndTsDocResolver.getLSAndTSDoc(document); | ||
| } | ||
| } |
50 changes: 50 additions & 0 deletions
50
packages/language-server/src/plugins/typescript/features/utils.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,50 @@ | ||
| import ts from 'typescript'; | ||
| import { Position } from 'vscode-languageserver'; | ||
| import { Document, getNodeIfIsInComponentStartTag, isInTag } from '../../../lib/documents'; | ||
| import { SvelteDocumentSnapshot, SvelteSnapshotFragment } from '../DocumentSnapshot'; | ||
| import { LSAndTSDocResolver } from '../LSAndTSDocResolver'; | ||
|
|
||
| /** | ||
| * If the given original position is within a Svelte starting tag, | ||
| * return the snapshot of that component. | ||
| */ | ||
| export function getComponentAtPosition( | ||
| lsAndTsDocResovler: LSAndTSDocResolver, | ||
| lang: ts.LanguageService, | ||
| doc: Document, | ||
| tsDoc: SvelteDocumentSnapshot, | ||
| fragment: SvelteSnapshotFragment, | ||
| originalPosition: Position, | ||
| ): SvelteDocumentSnapshot | null { | ||
| if (tsDoc.parserError) { | ||
| return null; | ||
| } | ||
|
|
||
| if ( | ||
| isInTag(originalPosition, doc.scriptInfo) || | ||
| isInTag(originalPosition, doc.moduleScriptInfo) | ||
| ) { | ||
| // Inside script tags -> not a component | ||
| return null; | ||
| } | ||
|
|
||
| const node = getNodeIfIsInComponentStartTag(doc.html, doc.offsetAt(originalPosition)); | ||
| if (!node) { | ||
| return null; | ||
| } | ||
|
|
||
| const generatedPosition = fragment.getGeneratedPosition(doc.positionAt(node.start + 1)); | ||
| const def = lang.getDefinitionAtPosition( | ||
| tsDoc.filePath, | ||
| fragment.offsetAt(generatedPosition), | ||
| )?.[0]; | ||
| if (!def) { | ||
| return null; | ||
| } | ||
|
|
||
| const snapshot = lsAndTsDocResovler.getSnapshot(def.fileName); | ||
| if (!(snapshot instanceof SvelteDocumentSnapshot)) { | ||
| return null; | ||
| } | ||
| return snapshot; | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.