Merge pull request #304 from DunetsNM/open-doc-on-hackage

add "Reopen on Hackage (beta)" hyperlink to doc window

Author: lukel97

src/docsBrowser.ts

@@ -6,6 +6,7 @@ import {
   CompletionItem,
   CompletionList,
   Disposable,
+  env,
   Hover,
   MarkdownString,
   MarkedString,
@@ -23,24 +24,48 @@ export namespace DocsBrowser {
 
   // registers the browser in VSCode infrastructure
   export function registerDocsBrowser(): Disposable {
-    return commands.registerCommand('haskell.showDocumentation', ({ title, path }: { title: string; path: string }) => {
-      const arr = path.match(/([^\/]+)\.[^.]+$/);
-      const ttl = arr !== null && arr.length === 2 ? arr[1].replace(/-/gi, '.') : title;
-      const documentationDirectory = dirname(path);
-      let panel;
-      try {
-        // Make sure to use Uri.parse here, as path will already have 'file:///' in it
-        panel = window.createWebviewPanel('haskell.showDocumentationPanel', ttl, ViewColumn.Beside, {
-          localResourceRoots: [Uri.parse(documentationDirectory)],
-          enableFindWidget: true,
-        });
-        const uri = panel.webview.asWebviewUri(Uri.parse(path));
-        panel.webview.html = `<iframe src="${uri}" frameBorder = "0" style = "background: white; width: 100%; height: 100%; position:absolute; left: 0; right: 0; bottom: 0; top: 0px;" /> `;
-      } catch (e) {
-        window.showErrorMessage(e);
+    return commands.registerCommand(
+      'haskell.showDocumentation',
+      async ({ title, localPath, hackageUri }: { title: string; localPath: string; hackageUri: string }) => {
+        const arr = localPath.match(/([^\/]+)\.[^.]+$/);
+        const ttl = arr !== null && arr.length === 2 ? arr[1].replace(/-/gi, '.') : title;
+        const documentationDirectory = dirname(localPath);
+        let panel;
+        try {
+          // Make sure to use Uri.parse here, as path will already have 'file:///' in it
+          panel = window.createWebviewPanel('haskell.showDocumentationPanel', ttl, ViewColumn.Beside, {
+            localResourceRoots: [Uri.parse(documentationDirectory)],
+            enableFindWidget: true,
+            enableCommandUris: true,
+          });
+          const uri = panel.webview.asWebviewUri(Uri.parse(localPath));
+
+          const encoded = encodeURIComponent(JSON.stringify({ hackageUri }));
+          const hackageCmd = 'command:haskell.openDocumentationOnHackage?' + encoded;
+
+          panel.webview.html = `<div><a href="${hackageCmd}">Reopen on Hackage</a></div>
+          <div><iframe src="${uri}" frameBorder = "0" style = "background: white; width: 100%; height: 100%; position:absolute; left: 0; right: 0; bottom: 0; top: 30px;"/></div>`;
+        } catch (e) {
+          await window.showErrorMessage(e);
+        }
+        return panel;
       }
-      return panel;
-    });
+    );
+  }
+
+  export function registerDocsOpenOnHackage(): Disposable {
+    return commands.registerCommand(
+      'haskell.openDocumentationOnHackage',
+      async ({ hackageUri }: { hackageUri: string }) => {
+        try {
+          // open on Hackage and close the original webview in VS code
+          await env.openExternal(Uri.parse(hackageUri));
+          await commands.executeCommand('workbench.action.closeActiveEditor');
+        } catch (e) {
+          await window.showErrorMessage(e);
+        }
+      }
+    );
   }
 
   export function hoverLinksMiddlewareHook(
@@ -85,11 +110,18 @@ export namespace DocsBrowser {
 
   function processLink(ms: MarkedString): string | MarkdownString {
     function transform(s: string): string {
-      return s.replace(/\[(.+)\]\((file:.+\/doc\/.+\.html#?.*)\)/gi, (all, title, path) => {
-        const encoded = encodeURIComponent(JSON.stringify({ title, path }));
-        const cmd = 'command:haskell.showDocumentation?' + encoded;
-        return `[${title}](${cmd})`;
-      });
+      return s.replace(
+        /\[(.+)\]\((file:.+\/doc\/(?:.*html\/libraries\/)?([^\/]+)\/(src\/)?(.+\.html#?.*))\)/gi,
+        (all, title, localPath, packageName, maybeSrcDir, fileAndAnchor) => {
+          if (!maybeSrcDir) {
+            maybeSrcDir = '';
+          }
+          const hackageUri = `https://hackage.haskell.org/package/${packageName}/docs/${maybeSrcDir}${fileAndAnchor}`;
+          const encoded = encodeURIComponent(JSON.stringify({ title, localPath, hackageUri }));
+          const cmd = 'command:haskell.showDocumentation?' + encoded;
+          return `[${title}](${cmd})`;
+        }
+      );
     }
     if (typeof ms === 'string') {
       return transform(ms as string);

src/extension.ts

@@ -65,6 +65,9 @@ export async function activate(context: ExtensionContext) {
   // Set up the documentation browser.
   const docsDisposable = DocsBrowser.registerDocsBrowser();
   context.subscriptions.push(docsDisposable);
+
+  const openOnHackageDisposable = DocsBrowser.registerDocsOpenOnHackage();
+  context.subscriptions.push(openOnHackageDisposable);
 }
 
 function findManualExecutable(uri: Uri, folder?: WorkspaceFolder): string | null {