Skip to content

Commit 773c398

Browse files
authored
api: implement extension mode api (microsoft#95926) (microsoft#97081)
1 parent 55fa934 commit 773c398

4 files changed

Lines changed: 72 additions & 2 deletions

File tree

‎src/vs/vscode.proposed.d.ts‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1742,6 +1742,43 @@ declare module 'vscode' {
17421742

17431743
//#endregion
17441744

1745+
//#region @connor4312 extension mode: https://github.com/microsoft/vscode/issues/95926
1746+
1747+
/**
1748+
* The ExtensionMode is provided on the `ExtensionContext` and indicates the
1749+
* mode the specific extension is running in.
1750+
*/
1751+
export enum ExtensionMode {
1752+
/**
1753+
* The extension is installed normally (for example, from the marketplace
1754+
* or VSIX) in VS Code.
1755+
*/
1756+
Release = 1,
1757+
1758+
/**
1759+
* The extension is running from an `--extensionDevelopmentPath` provided
1760+
* when launching VS Code.
1761+
*/
1762+
Development = 2,
1763+
1764+
/**
1765+
* The extension is running from an `--extensionDevelopmentPath` and
1766+
* the extension host is running unit tests.
1767+
*/
1768+
Test = 3,
1769+
}
1770+
1771+
export interface ExtensionContext {
1772+
/**
1773+
* The mode the extension is running in. This is specific to the current
1774+
* extension. One extension may be in `ExtensionMode.Development` while
1775+
* other extensions in the host run in `ExtensionMode.Release`.
1776+
*/
1777+
readonly extensionMode: ExtensionMode;
1778+
}
1779+
1780+
//#endregion
1781+
17451782
//#region https://github.com/microsoft/vscode/issues/39441
17461783

17471784
export interface CompletionItem {

‎src/vs/workbench/api/common/extHost.api.impl.ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -993,6 +993,7 @@ export function createApiFactoryAndRegisterActors(accessor: ServicesAccessor): I
993993
EvaluatableExpression: extHostTypes.EvaluatableExpression,
994994
EventEmitter: Emitter,
995995
ExtensionKind: extHostTypes.ExtensionKind,
996+
ExtensionMode: extHostTypes.ExtensionMode,
996997
CustomExecution: extHostTypes.CustomExecution,
997998
CustomExecution2: extHostTypes.CustomExecution,
998999
FileChangeType: extHostTypes.FileChangeType,

‎src/vs/workbench/api/common/extHostExtensionService.ts‎

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ import { ExtHostConfiguration, IExtHostConfiguration } from 'vs/workbench/api/co
1616
import { ActivatedExtension, EmptyExtension, ExtensionActivationReason, ExtensionActivationTimes, ExtensionActivationTimesBuilder, ExtensionsActivator, IExtensionAPI, IExtensionModule, HostExtension, ExtensionActivationTimesFragment } from 'vs/workbench/api/common/extHostExtensionActivator';
1717
import { ExtHostStorage, IExtHostStorage } from 'vs/workbench/api/common/extHostStorage';
1818
import { ExtHostWorkspace, IExtHostWorkspace } from 'vs/workbench/api/common/extHostWorkspace';
19-
import { ExtensionActivationError } from 'vs/workbench/services/extensions/common/extensions';
19+
import { ExtensionActivationError, checkProposedApiEnabled } from 'vs/workbench/services/extensions/common/extensions';
2020
import { ExtensionDescriptionRegistry } from 'vs/workbench/services/extensions/common/extensionDescriptionRegistry';
2121
import { CancellationTokenSource } from 'vs/base/common/cancellation';
2222
import * as errors from 'vs/base/common/errors';
@@ -25,7 +25,7 @@ import { ExtensionIdentifier, IExtensionDescription } from 'vs/platform/extensio
2525
import { Schemas } from 'vs/base/common/network';
2626
import { VSBuffer } from 'vs/base/common/buffer';
2727
import { ExtensionMemento } from 'vs/workbench/api/common/extHostMemento';
28-
import { RemoteAuthorityResolverError } from 'vs/workbench/api/common/extHostTypes';
28+
import { RemoteAuthorityResolverError, ExtensionMode } from 'vs/workbench/api/common/extHostTypes';
2929
import { ResolvedAuthority, ResolvedOptions, RemoteAuthorityResolverErrorCode } from 'vs/platform/remote/common/remoteAuthorityResolver';
3030
import { IInstantiationService, createDecorator } from 'vs/platform/instantiation/common/instantiation';
3131
import { IExtHostInitDataService } from 'vs/workbench/api/common/extHostInitDataService';
@@ -358,8 +358,12 @@ export abstract class AbstractExtHostExtensionService implements ExtHostExtensio
358358

359359
const globalState = new ExtensionMemento(extensionDescription.identifier.value, true, this._storage);
360360
const workspaceState = new ExtensionMemento(extensionDescription.identifier.value, false, this._storage);
361+
const extensionMode = extensionDescription.isUnderDevelopment
362+
? (this._initData.environment.extensionTestsLocationURI ? ExtensionMode.Test : ExtensionMode.Development)
363+
: ExtensionMode.Release;
361364

362365
this._logService.trace(`ExtensionService#loadExtensionContext ${extensionDescription.identifier.value}`);
366+
363367
return Promise.all([
364368
globalState.whenReady,
365369
workspaceState.whenReady,
@@ -376,6 +380,10 @@ export abstract class AbstractExtHostExtensionService implements ExtHostExtensio
376380
get globalStoragePath() { return that._storagePath.globalValue(extensionDescription); },
377381
asAbsolutePath(relativePath: string) { return path.join(extensionDescription.extensionLocation.fsPath, relativePath); },
378382
get logPath() { return path.join(that._initData.logsLocation.fsPath, extensionDescription.identifier.value); },
383+
get extensionMode() {
384+
checkProposedApiEnabled(extensionDescription);
385+
return extensionMode;
386+
},
379387
get environmentVariableCollection() { return that._extHostTerminalService.getEnvironmentVariableCollection(extensionDescription); }
380388
});
381389
});

‎src/vs/workbench/api/common/extHostTypes.ts‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2742,3 +2742,27 @@ export class TimelineItem implements vscode.TimelineItem {
27422742
}
27432743

27442744
//#endregion Timeline
2745+
2746+
//#region ExtensionContext
2747+
2748+
export enum ExtensionMode {
2749+
/**
2750+
* The extension is installed normally (for example, from the marketplace
2751+
* or VSIX) in VS Code.
2752+
*/
2753+
Release = 1,
2754+
2755+
/**
2756+
* The extension is running from an `--extensionDevelopmentPath` provided
2757+
* when launching VS Code.
2758+
*/
2759+
Development = 2,
2760+
2761+
/**
2762+
* The extension is running from an `--extensionDevelopmentPath` and
2763+
* the extension host is running unit tests.
2764+
*/
2765+
Test = 3,
2766+
}
2767+
2768+
//#endregion ExtensionContext

0 commit comments

Comments
 (0)