Add openTextDocument endpoint

streetsidesoftware · Oct 7, 2023 · 05b6d1d · 05b6d1d
1 parent 9785bb9
commit 05b6d1d
Show file tree

Hide file tree

Showing 6 changed files with 23 additions and 2 deletions.
diff --git a/packages/client/src/webview/api/api.ts b/packages/client/src/webview/api/api.ts
@@ -1,6 +1,6 @@
 import { createDisposableList, type DisposableLike, disposeOf, injectDisposable, makeDisposable } from 'utils-disposables';
 import { createLogger, LogLevel } from 'utils-logger';
-import { window } from 'vscode';
+import { Uri, window } from 'vscode';
 import { type MessageConnection } from 'vscode-jsonrpc/node';
 import type { RequestResult, SetValueRequest, SetValueResult, WatchFieldList, WatchFields } from 'webview-api';
 import { createServerSideSpellInfoWebviewApi } from 'webview-api';
@@ -49,6 +49,12 @@ export function bindApiAndStore(connection: MessageConnection, store: Storage):
             async showInformationMessage(message) {
                 await window.showInformationMessage('Show Message: ' + message);
             },
+            async openTextDocument(url) {
+                if (!url) return;
+                const uri = Uri.parse(url);
+                // console.error('Open %o, %o', url, uri.toJSON());
+                await window.showTextDocument(uri);
+            },
         },
         clientRequests: {},
         clientNotifications: { onStateChange: true },

diff --git a/packages/webview-api/src/__snapshots__/api.test.ts.snap b/packages/webview-api/src/__snapshots__/api.test.ts.snap
@@ -3,6 +3,7 @@
 exports[`api > Creating a Server API 1`] = `
 [
   "clientNotification.onStateChange",
+  "serverNotification.openTextDocument",
   "serverNotification.showInformationMessage",
   "serverRequest.getCurrentDocument",
   "serverRequest.getDocSettings",
@@ -28,6 +29,7 @@ exports[`api > Creating a Server API 2`] = `
   "function",
   "function",
   "function",
+  "function",
   "object",
 ]
 `;

diff --git a/packages/webview-api/src/api.test.ts b/packages/webview-api/src/api.test.ts
@@ -19,6 +19,7 @@ describe('api', () => {
             clientRequests: {},
             serverNotifications: {
                 showInformationMessage: true,
+                openTextDocument: true,
             },
             serverRequests: {
                 getCurrentDocument: true,

diff --git a/packages/webview-api/src/api.ts b/packages/webview-api/src/api.ts
@@ -29,6 +29,7 @@ export interface ServerRequestsAPI {
 /** Notifications that can be sent to the extension */
 export interface ServerNotificationsAPI {
     showInformationMessage(message: string): void;
+    openTextDocument(url: string): void;
 }
 
 /**

diff --git a/packages/webview-ui/src/api.ts b/packages/webview-ui/src/api.ts
@@ -43,6 +43,7 @@ function createApi(): API {
         {
             serverNotifications: {
                 showInformationMessage: true,
+                openTextDocument: true,
             },
             serverRequests: {
                 getCurrentDocument: true,

diff --git a/packages/webview-ui/src/views/CSpellInfo.svelte b/packages/webview-ui/src/views/CSpellInfo.svelte
@@ -41,7 +41,17 @@
             <dt>{dictionary.name} <sup>{dictionary.locales.join(', ')}</sup></dt>
             <dd>{dictionary.description || ''}</dd>
             {#if dictionary.uriName}
-              <dd><a href={dictionary.uri}>{dictionary.uriName}</a></dd>
+              <dd>
+                {#if dictionary.uri}
+                  <a
+                    href={dictionary.uri}
+                    on:click={() => dictionary.uri && getClientApi().serverNotification.openTextDocument(dictionary.uri)}
+                    >{dictionary.uriName}</a
+                  >
+                {:else}
+                  {dictionary.uriName}
+                {/if}
+              </dd>
             {/if}
           </dl>
         </li>