Update the API to reflect that the language client could be null

clangd · Nov 17, 2024 · 8615020 · 8615020
1 parent e5e25c6
commit 8615020
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 4 deletions.
diff --git a/api/README.md b/api/README.md
@@ -17,6 +17,11 @@ const provideHover = async (document: vscode.TextDocument, position: vscode.Posi
 
     if (clangdExtension) {
         const api = (await clangdExtension.activate()).getApi(CLANGD_API_VERSION);
+
+        // Extension may be disabled or have failed to initialize
+        if (!api.languageClient) {
+          return undefined;
+        }
 
         const textDocument = api.languageClient.code2ProtocolConverter.asTextDocumentIdentifier(document);
         const range = api.languageClient.code2ProtocolConverter.asRange(new vscode.Range(position, position));

diff --git a/api/vscode-clangd.d.ts b/api/vscode-clangd.d.ts
@@ -8,7 +8,7 @@ export interface ClangdApiV1 {
   // https://microsoft.github.io/language-server-protocol/specifications/specification-current
   // clangd custom requests:
   // https://clangd.llvm.org/extensions
-  languageClient: BaseLanguageClient
+  languageClient: BaseLanguageClient | undefined
 }
 
 export interface ClangdExtension {

diff --git a/src/api.ts b/src/api.ts
@@ -3,7 +3,7 @@ import {BaseLanguageClient} from 'vscode-languageclient';
 import {ClangdApiV1, ClangdExtension} from '../api/vscode-clangd';
 
 export class ClangdExtensionImpl implements ClangdExtension {
-  constructor(public client: BaseLanguageClient) {}
+  constructor(public client: BaseLanguageClient | undefined) {}
 
   public getApi(version: 1): ClangdApiV1;
   public getApi(version: number): unknown {

diff --git a/src/extension.ts b/src/extension.ts
@@ -39,7 +39,7 @@ export async function activate(context: vscode.ExtensionContext):
         if (clangdContext)
           context.subscriptions.push(clangdContext);
         if (apiInstance) {
-          apiInstance.client = clangdContext!.client;
+          apiInstance.client = clangdContext?.client;
         }
       }));
 
@@ -87,6 +87,6 @@ export async function activate(context: vscode.ExtensionContext):
     }, 5000);
   }
 
-  apiInstance = new ClangdExtensionImpl(clangdContext!.client);
+  apiInstance = new ClangdExtensionImpl(clangdContext?.client);
   return apiInstance;
 }