maxmustermann/vscode
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Close #122570

Browse source
This commit is contained in:
Jackson Kearl 2021-05-24 13:48:03 -07:00
parent 79762396a0
commit d7ead317dc
No known key found for this signature in database
GPG key ID: DA09A59C409FC400
2 changed files with 42 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
src/vs/workbench/contrib/welcome/gettingStarted/browser/gettingStartedExtensionPoint.ts
View file

@ -138,6 +138,21 @@ export const walkthroughsExtensionPoint = ExtensionsRegistry.registerExtensionPo
description: localize('walkthroughs.steps.completionEvents.onLink', 'Check off step when a given link is opened via a Getting Started step.'),
body: 'onLink:${2:linkId}'
},
{
label: 'onView',
description: localize('walkthroughs.steps.completionEvents.onView', 'Check off step when a given view is opened'),
body: 'onView:${2:viewId}'
},
{
label: 'onSettingChanged',
description: localize('walkthroughs.steps.completionEvents.onSettingChanged', 'Check off step when a given setting is changed'),
body: 'onSettingChanged:${2:settingName}'
},
{
label: 'onContextKeyDefined',
description: localize('walkthroughs.steps.completionEvents.onContextKeyDefined', 'Check off step when a context key is defined to a truthy value. Note: this only accepts single context keys, not full context key expressions'),
body: 'onContextKeyDefined:${2:key}'
},
{
label: 'extensionInstalled',
description: localize('walkthroughs.steps.completionEvents.extensionInstalled', 'Check off step when an extension with the given id is installed. If the extension is already installed, the step will start off checked.'),

34
src/vs/workbench/contrib/welcome/gettingStarted/browser/gettingStartedService.ts
View file

@ -29,6 +29,7 @@ import { walkthroughsExtensionPoint } from 'vs/workbench/contrib/welcome/getting
import { registerSingleton } from 'vs/platform/instantiation/common/extensions';
import { dirname } from 'vs/base/common/path';
import { coalesce, flatten } from 'vs/base/common/arrays';
import { IViewsService } from 'vs/workbench/common/views';
export const IGettingStartedService = createDecorator<IGettingStartedService>('gettingStartedService');
@ -164,7 +165,8 @@ export class GettingStartedService extends Disposable implements IGettingStarted
private tasExperimentService?: ITASExperimentService;
private sessionInstalledExtensions = new Set<string>();
private trackedContextKeys = new Set<string>();
private categoryVisibilityContextKeys = new Set<string>();
private stepCompletionContextKeys = new Set<string>();
private triggerInstalledExtensionsRegistered!: () => void;
installedExtensionsRegistered: Promise<void>;
@ -178,6 +180,7 @@ export class GettingStartedService extends Disposable implements IGettingStarted
@IConfigurationService private readonly configurationService: IConfigurationService,
@IExtensionManagementService private readonly extensionManagementService: IExtensionManagementService,
@IHostService private readonly hostService: IHostService,
@IViewsService private readonly viewsService: IViewsService,
@optional(ITASExperimentService) tasExperimentService: ITASExperimentService,
) {
super();
@ -206,7 +209,22 @@ export class GettingStartedService extends Disposable implements IGettingStarted
}));
this._register(this.contextService.onDidChangeContext(event => {
if (event.affectsSome(this.trackedContextKeys)) { this._onDidAddCategory.fire(); }
if (event.affectsSome(this.categoryVisibilityContextKeys)) { this._onDidAddCategory.fire(); }
if (event.affectsSome(this.stepCompletionContextKeys)) {
this.stepCompletionContextKeys.forEach(key => {
if (event.affectsSome(new Set([key])) && this.contextService.getContextKeyValue(key)) {
this.progressByEvent(`onContextKeyDefined:` + key);
}
});
}
}));
this._register(this.viewsService.onDidChangeViewVisibility(e => {
if (e.visible) { this.progressByEvent('onView:' + e.id); }
}));
this._register(this.configurationService.onDidChangeConfiguration(e => {
e.affectedKeys.forEach(key => { this.progressByEvent('onSettingChanged:' + key); });
}));
if (userDataAutoSyncEnablementService.isEnabled()) { this.progressByEvent('onEvent:sync-enabled'); }
@ -493,7 +511,8 @@ export class GettingStartedService extends Disposable implements IGettingStarted
}
switch (eventType) {
case 'onLink': case 'onEvent': break;
case 'onLink': case 'onEvent': case 'onView': case 'onContextKeyDefined': case 'onSettingChanged':
break;
case 'stepSelected':
event = eventType + ':' + step.id;
break;
@ -590,6 +609,8 @@ export class GettingStartedService extends Disposable implements IGettingStarted
}
progressByEvent(event: string): void {
if (this.sessionEvents.has(event)) { return; }
this.sessionEvents.add(event);
this.completionListeners.get(event)?.forEach(id => this.progressStep(id));
}
@ -620,7 +641,7 @@ export class GettingStartedService extends Disposable implements IGettingStarted
if (this.steps.has(step.id)) { throw Error('Attempting to register step with id ' + step.id + ' twice. Second is dropped.'); }
this.steps.set(step.id, step);
this.registerDoneListeners(step);
this.trackedContextKeys.add(step.when.serialize());
step.when.keys().forEach(key => this.categoryVisibilityContextKeys.add(key));
});
if (this.contextService.contextMatchesRules(category.when)) {
@ -631,7 +652,7 @@ export class GettingStartedService extends Disposable implements IGettingStarted
if (override) {
const old = category.when;
const gnu = ContextKeyExpr.deserialize(override) ?? old;
this.trackedContextKeys.add(override);
this.categoryVisibilityContextKeys.add(override);
category.when = gnu;
if (this.contextService.contextMatchesRules(old) && !this.contextService.contextMatchesRules(gnu)) {
@ -641,8 +662,7 @@ export class GettingStartedService extends Disposable implements IGettingStarted
}
}
});
this.trackedContextKeys.add(category.when.serialize());
category.when.keys().forEach(key => this.categoryVisibilityContextKeys.add(key));
}
private getStep(id: string): IGettingStartedStep {