Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Extension API for VS Code v1 #1144

Open
wants to merge 1 commit into
base: preview
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 3 additions & 1 deletion extensions/vscode/src/activation/activate.ts
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ function showRefactorMigrationMessage(
}
}

export async function activateExtension(context: vscode.ExtensionContext) {
export async function activateExtension(context: vscode.ExtensionContext): Promise<VsCodeExtension> {
// Add necessary files
getTsConfigPath();

Expand All @@ -67,4 +67,6 @@ export async function activateExtension(context: vscode.ExtensionContext) {
extensionVersion: getExtensionVersion(),
});
}

return vscodeExtension;
}
11 changes: 7 additions & 4 deletions extensions/vscode/src/extension.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,14 @@

import { Telemetry } from "core/util/posthog";
import * as vscode from "vscode";
import { IVsCodeExtensionAPI } from "./extension/api";
import { getExtensionVersion } from "./util/util";

async function dynamicImportAndActivate(context: vscode.ExtensionContext) {
async function dynamicImportAndActivate(context: vscode.ExtensionContext): Promise<IVsCodeExtensionAPI | null> {
const { activateExtension } = await import("./activation/activate");
try {
await activateExtension(context);
const instance = await activateExtension(context);
return { instance };
} catch (e) {
console.log("Error activating extension: ", e);
vscode.window
Expand All @@ -26,11 +28,12 @@ async function dynamicImportAndActivate(context: vscode.ExtensionContext) {
vscode.commands.executeCommand("workbench.action.reloadWindow");
}
});
return null;
}
}

export function activate(context: vscode.ExtensionContext) {
dynamicImportAndActivate(context);
export async function activate(context: vscode.ExtensionContext): Promise<IVsCodeExtensionAPI | null> {
return dynamicImportAndActivate(context);
}

export function deactivate() {
Expand Down
8 changes: 8 additions & 0 deletions extensions/vscode/src/extension/api.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
import { VsCodeExtension } from "./vscodeExtension";

export interface IVsCodeExtensionAPI {
// For now, the internal VsCodeExtension will be exposed, enabling full access to the internal data.
// Once it's clear, which functionality is most useful, we should design a proper API with limited access
// and remove the instance here.
instance: VsCodeExtension;
}