feat(vscode): allow clickable links on hover for type descriptions (#404

) * feat(vscode): allow clickable links in type descriptions * Update comment
flow · May 28, 2021 · 1a43503 · 1a43503
1 parent 10be374
commit 1a43503
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 5 deletions.
diff --git a/lib/flowLSP/FlowLanguageClient/createMiddleware.js b/lib/flowLSP/FlowLanguageClient/createMiddleware.js
@@ -12,7 +12,7 @@
 import * as vscode from 'vscode';
 import * as lsp from '../utils/LanguageClient';
 import FlowconfigCache from '../utils/FlowconfigCache';
-import formatMarkedDownString from '../utils/formatMarkedDownString';
+import formatFlowMarkDownString from '../utils/formatFlowMarkDownString';
 import checkFlowVersionSatisfies from '../utils/checkFlowVersionSatisifies';
 
 export default function createMiddleware(
@@ -207,9 +207,12 @@ function formatHoverContent(value: ?vscode.Hover): ?vscode.Hover {
 
   // format content
   value.contents = value.contents.map((content) => {
-    // NOTE: in our case, content is always MarkdownString
-    if (content instanceof vscode.MarkdownString) {
-      return formatMarkedDownString(content);
+    // NOTE: only re-format a flow specific MarkdownString so we preserve markdown in type comments
+    if (
+      content instanceof vscode.MarkdownString &&
+      content.value.includes('```flow')
+    ) {
+      return formatFlowMarkDownString(content);
     }
     return content;
   });

diff --git a/lib/flowLSP/utils/formatMarkedDownString.js → ...flowLSP/utils/formatFlowMarkDownString.js b/lib/flowLSP/utils/formatMarkedDownString.js → ...flowLSP/utils/formatFlowMarkDownString.js
@@ -2,7 +2,7 @@
 import * as vscode from 'vscode';
 import format from '../../common/format';
 
-export default function formatMarkedDownString(
+export default function formatFlowMarkDownString(
   mdStr: vscode.MarkdownString,
 ): vscode.MarkdownString {
   const code = extractCode(mdStr, 'flow');