vscode/src/vs/workbench/contrib/preferences/browser/preferencesRenderers.ts
2021-11-23 13:49:22 -08:00

729 lines
31 KiB
TypeScript

/*---------------------------------------------------------------------------------------------
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for license information.
*--------------------------------------------------------------------------------------------*/
import { EventHelper, getDomNodePagePosition } from 'vs/base/browser/dom';
import { IAction, SubmenuAction } from 'vs/base/common/actions';
import { Delayer } from 'vs/base/common/async';
import { CancellationToken } from 'vs/base/common/cancellation';
import { Emitter, Event } from 'vs/base/common/event';
import { IJSONSchema } from 'vs/base/common/jsonSchema';
import { Disposable, IDisposable } from 'vs/base/common/lifecycle';
import { ResourceMap } from 'vs/base/common/map';
import { ICodeEditor, IEditorMouseEvent, MouseTargetType } from 'vs/editor/browser/editorBrowser';
import { EditorOption } from 'vs/editor/common/config/editorOptions';
import { ICursorPositionChangedEvent } from 'vs/editor/common/controller/cursorEvents';
import { Position } from 'vs/editor/common/core/position';
import { IRange, Range } from 'vs/editor/common/core/range';
import { Selection } from 'vs/editor/common/core/selection';
import * as editorCommon from 'vs/editor/common/editorCommon';
import { IModelDeltaDecoration, ITextModel, TrackedRangeStickiness } from 'vs/editor/common/model';
import { ModelDecorationOptions } from 'vs/editor/common/model/textModel';
import * as modes from 'vs/editor/common/modes';
import { CodeActionKind } from 'vs/editor/contrib/codeAction/types';
import * as nls from 'vs/nls';
import { ConfigurationTarget, IConfigurationService } from 'vs/platform/configuration/common/configuration';
import { ConfigurationScope, Extensions as ConfigurationExtensions, IConfigurationPropertySchema, IConfigurationRegistry, overrideIdentifiersFromKey, OVERRIDE_PROPERTY_REGEX } from 'vs/platform/configuration/common/configurationRegistry';
import { IContextMenuService } from 'vs/platform/contextview/browser/contextView';
import { IInstantiationService } from 'vs/platform/instantiation/common/instantiation';
import { IMarkerData, IMarkerService, MarkerSeverity, MarkerTag } from 'vs/platform/markers/common/markers';
import { Registry } from 'vs/platform/registry/common/platform';
import { ThemeIcon } from 'vs/platform/theme/common/themeService';
import { IWorkspaceContextService, WorkbenchState } from 'vs/platform/workspace/common/workspace';
import { IWorkspaceTrustManagementService } from 'vs/platform/workspace/common/workspaceTrust';
import { RangeHighlightDecorations } from 'vs/workbench/browser/codeeditor';
import { settingsEditIcon } from 'vs/workbench/contrib/preferences/browser/preferencesIcons';
import { EditPreferenceWidget } from 'vs/workbench/contrib/preferences/browser/preferencesWidgets';
import { IWorkbenchEnvironmentService } from 'vs/workbench/services/environment/common/environmentService';
import { IPreferencesEditorModel, IPreferencesService, ISetting, ISettingsEditorModel, ISettingsGroup } from 'vs/workbench/services/preferences/common/preferences';
import { DefaultSettingsEditorModel, SettingsEditorModel, WorkspaceConfigurationEditorModel } from 'vs/workbench/services/preferences/common/preferencesModels';
import { IUriIdentityService } from 'vs/platform/uriIdentity/common/uriIdentity';
export interface IPreferencesRenderer extends IDisposable {
render(): void;
updatePreference(key: string, value: any, source: ISetting): void;
focusPreference(setting: ISetting): void;
clearFocus(setting: ISetting): void;
editPreference(setting: ISetting): boolean;
}
export class UserSettingsRenderer extends Disposable implements IPreferencesRenderer {
private settingHighlighter: SettingHighlighter;
private editSettingActionRenderer: EditSettingRenderer;
private modelChangeDelayer: Delayer<void> = new Delayer<void>(200);
private associatedPreferencesModel!: IPreferencesEditorModel<ISetting>;
private unsupportedSettingsRenderer: UnsupportedSettingsRenderer;
constructor(protected editor: ICodeEditor, readonly preferencesModel: SettingsEditorModel,
@IPreferencesService protected preferencesService: IPreferencesService,
@IConfigurationService private readonly configurationService: IConfigurationService,
@IInstantiationService protected instantiationService: IInstantiationService
) {
super();
this.settingHighlighter = this._register(instantiationService.createInstance(SettingHighlighter, editor));
this.editSettingActionRenderer = this._register(this.instantiationService.createInstance(EditSettingRenderer, this.editor, this.preferencesModel, this.settingHighlighter));
this._register(this.editSettingActionRenderer.onUpdateSetting(({ key, value, source }) => this.updatePreference(key, value, source)));
this._register(this.editor.getModel()!.onDidChangeContent(() => this.modelChangeDelayer.trigger(() => this.onModelChanged())));
this.unsupportedSettingsRenderer = this._register(instantiationService.createInstance(UnsupportedSettingsRenderer, editor, preferencesModel));
}
render(): void {
this.editSettingActionRenderer.render(this.preferencesModel.settingsGroups, this.associatedPreferencesModel);
this.unsupportedSettingsRenderer.render();
}
updatePreference(key: string, value: any, source: IIndexedSetting): void {
const overrideIdentifiers = source.overrideOf ? overrideIdentifiersFromKey(source.overrideOf.key) : null;
const resource = this.preferencesModel.uri;
this.configurationService.updateValue(key, value, { overrideIdentifiers, resource }, this.preferencesModel.configurationTarget)
.then(() => this.onSettingUpdated(source));
}
private onModelChanged(): void {
if (!this.editor.hasModel()) {
// model could have been disposed during the delay
return;
}
this.render();
}
private onSettingUpdated(setting: ISetting) {
this.editor.focus();
setting = this.getSetting(setting)!;
if (setting) {
// TODO:@sandy Selection range should be template range
this.editor.setSelection(setting.valueRange);
this.settingHighlighter.highlight(setting, true);
}
}
private getSetting(setting: ISetting): ISetting | undefined {
const { key, overrideOf } = setting;
if (overrideOf) {
const setting = this.getSetting(overrideOf);
for (const override of setting!.overrides!) {
if (override.key === key) {
return override;
}
}
return undefined;
}
return this.preferencesModel.getPreference(key);
}
focusPreference(setting: ISetting): void {
const s = this.getSetting(setting);
if (s) {
this.settingHighlighter.highlight(s, true);
this.editor.setPosition({ lineNumber: s.keyRange.startLineNumber, column: s.keyRange.startColumn });
} else {
this.settingHighlighter.clear(true);
}
}
clearFocus(setting: ISetting): void {
this.settingHighlighter.clear(true);
}
editPreference(setting: ISetting): boolean {
const editableSetting = this.getSetting(setting);
return !!(editableSetting && this.editSettingActionRenderer.activateOnSetting(editableSetting));
}
public override dispose(): void {
this.preferencesModel.dispose();
}
}
export class WorkspaceSettingsRenderer extends UserSettingsRenderer implements IPreferencesRenderer {
private workspaceConfigurationRenderer: WorkspaceConfigurationRenderer;
constructor(editor: ICodeEditor, preferencesModel: SettingsEditorModel,
@IPreferencesService preferencesService: IPreferencesService,
@IConfigurationService configurationService: IConfigurationService,
@IInstantiationService instantiationService: IInstantiationService
) {
super(editor, preferencesModel, preferencesService, configurationService, instantiationService);
this.workspaceConfigurationRenderer = this._register(instantiationService.createInstance(WorkspaceConfigurationRenderer, editor, preferencesModel));
}
override render(): void {
super.render();
this.workspaceConfigurationRenderer.render();
}
}
export interface IIndexedSetting extends ISetting {
index: number;
groupId: string;
}
class EditSettingRenderer extends Disposable {
private editPreferenceWidgetForCursorPosition: EditPreferenceWidget<IIndexedSetting>;
private editPreferenceWidgetForMouseMove: EditPreferenceWidget<IIndexedSetting>;
private settingsGroups: ISettingsGroup[] = [];
associatedPreferencesModel!: IPreferencesEditorModel<ISetting>;
private toggleEditPreferencesForMouseMoveDelayer: Delayer<void>;
private readonly _onUpdateSetting: Emitter<{ key: string, value: any, source: IIndexedSetting }> = new Emitter<{ key: string, value: any, source: IIndexedSetting }>();
readonly onUpdateSetting: Event<{ key: string, value: any, source: IIndexedSetting }> = this._onUpdateSetting.event;
constructor(private editor: ICodeEditor, private primarySettingsModel: ISettingsEditorModel,
private settingHighlighter: SettingHighlighter,
@IInstantiationService private readonly instantiationService: IInstantiationService,
@IContextMenuService private readonly contextMenuService: IContextMenuService
) {
super();
this.editPreferenceWidgetForCursorPosition = <EditPreferenceWidget<IIndexedSetting>>this._register(this.instantiationService.createInstance(EditPreferenceWidget, editor));
this.editPreferenceWidgetForMouseMove = <EditPreferenceWidget<IIndexedSetting>>this._register(this.instantiationService.createInstance(EditPreferenceWidget, editor));
this.toggleEditPreferencesForMouseMoveDelayer = new Delayer<void>(75);
this._register(this.editPreferenceWidgetForCursorPosition.onClick(e => this.onEditSettingClicked(this.editPreferenceWidgetForCursorPosition, e)));
this._register(this.editPreferenceWidgetForMouseMove.onClick(e => this.onEditSettingClicked(this.editPreferenceWidgetForMouseMove, e)));
this._register(this.editor.onDidChangeCursorPosition(positionChangeEvent => this.onPositionChanged(positionChangeEvent)));
this._register(this.editor.onMouseMove(mouseMoveEvent => this.onMouseMoved(mouseMoveEvent)));
this._register(this.editor.onDidChangeConfiguration(() => this.onConfigurationChanged()));
}
render(settingsGroups: ISettingsGroup[], associatedPreferencesModel: IPreferencesEditorModel<ISetting>): void {
this.editPreferenceWidgetForCursorPosition.hide();
this.editPreferenceWidgetForMouseMove.hide();
this.settingsGroups = settingsGroups;
this.associatedPreferencesModel = associatedPreferencesModel;
const settings = this.getSettings(this.editor.getPosition()!.lineNumber);
if (settings.length) {
this.showEditPreferencesWidget(this.editPreferenceWidgetForCursorPosition, settings);
}
}
private isDefaultSettings(): boolean {
return this.primarySettingsModel instanceof DefaultSettingsEditorModel;
}
private onConfigurationChanged(): void {
if (!this.editor.getOption(EditorOption.glyphMargin)) {
this.editPreferenceWidgetForCursorPosition.hide();
this.editPreferenceWidgetForMouseMove.hide();
}
}
private onPositionChanged(positionChangeEvent: ICursorPositionChangedEvent) {
this.editPreferenceWidgetForMouseMove.hide();
const settings = this.getSettings(positionChangeEvent.position.lineNumber);
if (settings.length) {
this.showEditPreferencesWidget(this.editPreferenceWidgetForCursorPosition, settings);
} else {
this.editPreferenceWidgetForCursorPosition.hide();
}
}
private onMouseMoved(mouseMoveEvent: IEditorMouseEvent): void {
const editPreferenceWidget = this.getEditPreferenceWidgetUnderMouse(mouseMoveEvent);
if (editPreferenceWidget) {
this.onMouseOver(editPreferenceWidget);
return;
}
this.settingHighlighter.clear();
this.toggleEditPreferencesForMouseMoveDelayer.trigger(() => this.toggleEditPreferenceWidgetForMouseMove(mouseMoveEvent));
}
private getEditPreferenceWidgetUnderMouse(mouseMoveEvent: IEditorMouseEvent): EditPreferenceWidget<ISetting> | undefined {
if (mouseMoveEvent.target.type === MouseTargetType.GUTTER_GLYPH_MARGIN) {
const line = mouseMoveEvent.target.position!.lineNumber;
if (this.editPreferenceWidgetForMouseMove.getLine() === line && this.editPreferenceWidgetForMouseMove.isVisible()) {
return this.editPreferenceWidgetForMouseMove;
}
if (this.editPreferenceWidgetForCursorPosition.getLine() === line && this.editPreferenceWidgetForCursorPosition.isVisible()) {
return this.editPreferenceWidgetForCursorPosition;
}
}
return undefined;
}
private toggleEditPreferenceWidgetForMouseMove(mouseMoveEvent: IEditorMouseEvent): void {
const settings = mouseMoveEvent.target.position ? this.getSettings(mouseMoveEvent.target.position.lineNumber) : null;
if (settings && settings.length) {
this.showEditPreferencesWidget(this.editPreferenceWidgetForMouseMove, settings);
} else {
this.editPreferenceWidgetForMouseMove.hide();
}
}
private showEditPreferencesWidget(editPreferencesWidget: EditPreferenceWidget<ISetting>, settings: IIndexedSetting[]) {
const line = settings[0].valueRange.startLineNumber;
if (this.editor.getOption(EditorOption.glyphMargin) && this.marginFreeFromOtherDecorations(line)) {
editPreferencesWidget.show(line, nls.localize('editTtile', "Edit"), settings);
const editPreferenceWidgetToHide = editPreferencesWidget === this.editPreferenceWidgetForCursorPosition ? this.editPreferenceWidgetForMouseMove : this.editPreferenceWidgetForCursorPosition;
editPreferenceWidgetToHide.hide();
}
}
private marginFreeFromOtherDecorations(line: number): boolean {
const decorations = this.editor.getLineDecorations(line);
if (decorations) {
for (const { options } of decorations) {
if (options.glyphMarginClassName && options.glyphMarginClassName.indexOf(ThemeIcon.asClassName(settingsEditIcon)) === -1) {
return false;
}
}
}
return true;
}
private getSettings(lineNumber: number): IIndexedSetting[] {
const configurationMap = this.getConfigurationsMap();
return this.getSettingsAtLineNumber(lineNumber).filter(setting => {
const configurationNode = configurationMap[setting.key];
if (configurationNode) {
if (this.isDefaultSettings()) {
if (setting.key === 'launch') {
// Do not show because of https://github.com/microsoft/vscode/issues/32593
return false;
}
return true;
}
if (configurationNode.type === 'boolean' || configurationNode.enum) {
if ((<SettingsEditorModel>this.primarySettingsModel).configurationTarget !== ConfigurationTarget.WORKSPACE_FOLDER) {
return true;
}
if (configurationNode.scope === ConfigurationScope.RESOURCE || configurationNode.scope === ConfigurationScope.LANGUAGE_OVERRIDABLE) {
return true;
}
}
}
return false;
});
}
private getSettingsAtLineNumber(lineNumber: number): IIndexedSetting[] {
// index of setting, across all groups/sections
let index = 0;
const settings: IIndexedSetting[] = [];
for (const group of this.settingsGroups) {
if (group.range.startLineNumber > lineNumber) {
break;
}
if (lineNumber >= group.range.startLineNumber && lineNumber <= group.range.endLineNumber) {
for (const section of group.sections) {
for (const setting of section.settings) {
if (setting.range.startLineNumber > lineNumber) {
break;
}
if (lineNumber >= setting.range.startLineNumber && lineNumber <= setting.range.endLineNumber) {
if (!this.isDefaultSettings() && setting.overrides!.length) {
// Only one level because override settings cannot have override settings
for (const overrideSetting of setting.overrides!) {
if (lineNumber >= overrideSetting.range.startLineNumber && lineNumber <= overrideSetting.range.endLineNumber) {
settings.push({ ...overrideSetting, index, groupId: group.id });
}
}
} else {
settings.push({ ...setting, index, groupId: group.id });
}
}
index++;
}
}
}
}
return settings;
}
private onMouseOver(editPreferenceWidget: EditPreferenceWidget<ISetting>): void {
this.settingHighlighter.highlight(editPreferenceWidget.preferences[0]);
}
private onEditSettingClicked(editPreferenceWidget: EditPreferenceWidget<IIndexedSetting>, e: IEditorMouseEvent): void {
EventHelper.stop(e.event, true);
const anchor = { x: e.event.posx, y: e.event.posy };
const actions = this.getSettings(editPreferenceWidget.getLine()).length === 1 ? this.getActions(editPreferenceWidget.preferences[0], this.getConfigurationsMap()[editPreferenceWidget.preferences[0].key])
: editPreferenceWidget.preferences.map(setting => new SubmenuAction(`preferences.submenu.${setting.key}`, setting.key, this.getActions(setting, this.getConfigurationsMap()[setting.key])));
this.contextMenuService.showContextMenu({
getAnchor: () => anchor,
getActions: () => actions
});
}
activateOnSetting(setting: ISetting): boolean {
const startLine = setting.keyRange.startLineNumber;
const settings = this.getSettings(startLine);
if (!settings.length) {
return false;
}
this.editPreferenceWidgetForMouseMove.show(startLine, '', settings);
const actions = this.getActions(this.editPreferenceWidgetForMouseMove.preferences[0], this.getConfigurationsMap()[this.editPreferenceWidgetForMouseMove.preferences[0].key]);
this.contextMenuService.showContextMenu({
getAnchor: () => this.toAbsoluteCoords(new Position(startLine, 1)),
getActions: () => actions
});
return true;
}
private toAbsoluteCoords(position: Position): { x: number, y: number } {
const positionCoords = this.editor.getScrolledVisiblePosition(position);
const editorCoords = getDomNodePagePosition(this.editor.getDomNode()!);
const x = editorCoords.left + positionCoords!.left;
const y = editorCoords.top + positionCoords!.top + positionCoords!.height;
return { x, y: y + 10 };
}
private getConfigurationsMap(): { [qualifiedKey: string]: IConfigurationPropertySchema } {
return Registry.as<IConfigurationRegistry>(ConfigurationExtensions.Configuration).getConfigurationProperties();
}
private getActions(setting: IIndexedSetting, jsonSchema: IJSONSchema): IAction[] {
if (jsonSchema.type === 'boolean') {
return [<IAction>{
id: 'truthyValue',
label: 'true',
enabled: true,
run: () => this.updateSetting(setting.key, true, setting)
}, <IAction>{
id: 'falsyValue',
label: 'false',
enabled: true,
run: () => this.updateSetting(setting.key, false, setting)
}];
}
if (jsonSchema.enum) {
return jsonSchema.enum.map(value => {
return <IAction>{
id: value,
label: JSON.stringify(value),
enabled: true,
run: () => this.updateSetting(setting.key, value, setting)
};
});
}
return this.getDefaultActions(setting);
}
private getDefaultActions(setting: IIndexedSetting): IAction[] {
if (this.isDefaultSettings()) {
const settingInOtherModel = this.associatedPreferencesModel.getPreference(setting.key);
return [<IAction>{
id: 'setDefaultValue',
label: settingInOtherModel ? nls.localize('replaceDefaultValue', "Replace in Settings") : nls.localize('copyDefaultValue', "Copy to Settings"),
enabled: true,
run: () => this.updateSetting(setting.key, setting.value, setting)
}];
}
return [];
}
private updateSetting(key: string, value: any, source: IIndexedSetting): void {
this._onUpdateSetting.fire({ key, value, source });
}
}
class SettingHighlighter extends Disposable {
private fixedHighlighter: RangeHighlightDecorations;
private volatileHighlighter: RangeHighlightDecorations;
constructor(private editor: ICodeEditor, @IInstantiationService instantiationService: IInstantiationService) {
super();
this.fixedHighlighter = this._register(instantiationService.createInstance(RangeHighlightDecorations));
this.volatileHighlighter = this._register(instantiationService.createInstance(RangeHighlightDecorations));
}
highlight(setting: ISetting, fix: boolean = false) {
this.volatileHighlighter.removeHighlightRange();
this.fixedHighlighter.removeHighlightRange();
const highlighter = fix ? this.fixedHighlighter : this.volatileHighlighter;
highlighter.highlightRange({
range: setting.valueRange,
resource: this.editor.getModel()!.uri
}, this.editor);
this.editor.revealLineInCenterIfOutsideViewport(setting.valueRange.startLineNumber, editorCommon.ScrollType.Smooth);
}
clear(fix: boolean = false): void {
this.volatileHighlighter.removeHighlightRange();
if (fix) {
this.fixedHighlighter.removeHighlightRange();
}
}
}
class UnsupportedSettingsRenderer extends Disposable implements modes.CodeActionProvider {
private renderingDelayer: Delayer<void> = new Delayer<void>(200);
private readonly codeActions = new ResourceMap<[Range, modes.CodeAction[]][]>(uri => this.uriIdentityService.extUri.getComparisonKey(uri));
constructor(
private readonly editor: ICodeEditor,
private readonly settingsEditorModel: SettingsEditorModel,
@IMarkerService private readonly markerService: IMarkerService,
@IWorkbenchEnvironmentService private readonly environmentService: IWorkbenchEnvironmentService,
@IConfigurationService private readonly configurationService: IConfigurationService,
@IWorkspaceTrustManagementService private readonly workspaceTrustManagementService: IWorkspaceTrustManagementService,
@IUriIdentityService private readonly uriIdentityService: IUriIdentityService,
) {
super();
this._register(this.editor.getModel()!.onDidChangeContent(() => this.delayedRender()));
this._register(Event.filter(this.configurationService.onDidChangeConfiguration, e => e.source === ConfigurationTarget.DEFAULT)(() => this.delayedRender()));
this._register(modes.CodeActionProviderRegistry.register({ pattern: settingsEditorModel.uri.path }, this));
}
private delayedRender(): void {
this.renderingDelayer.trigger(() => this.render());
}
public render(): void {
this.codeActions.clear();
const markerData: IMarkerData[] = this.generateMarkerData();
if (markerData.length) {
this.markerService.changeOne('UnsupportedSettingsRenderer', this.settingsEditorModel.uri, markerData);
} else {
this.markerService.remove('UnsupportedSettingsRenderer', [this.settingsEditorModel.uri]);
}
}
async provideCodeActions(model: ITextModel, range: Range | Selection, context: modes.CodeActionContext, token: CancellationToken): Promise<modes.CodeActionList> {
const actions: modes.CodeAction[] = [];
const codeActionsByRange = this.codeActions.get(model.uri);
if (codeActionsByRange) {
for (const [codeActionsRange, codeActions] of codeActionsByRange) {
if (codeActionsRange.containsRange(range)) {
actions.push(...codeActions);
}
}
}
return {
actions,
dispose: () => { }
};
}
private generateMarkerData(): IMarkerData[] {
const markerData: IMarkerData[] = [];
const configurationRegistry = Registry.as<IConfigurationRegistry>(ConfigurationExtensions.Configuration).getConfigurationProperties();
for (const settingsGroup of this.settingsEditorModel.settingsGroups) {
for (const section of settingsGroup.sections) {
for (const setting of section.settings) {
const configuration = configurationRegistry[setting.key];
if (configuration) {
switch (this.settingsEditorModel.configurationTarget) {
case ConfigurationTarget.USER_LOCAL:
this.handleLocalUserConfiguration(setting, configuration, markerData);
break;
case ConfigurationTarget.USER_REMOTE:
this.handleRemoteUserConfiguration(setting, configuration, markerData);
break;
case ConfigurationTarget.WORKSPACE:
this.handleWorkspaceConfiguration(setting, configuration, markerData);
break;
case ConfigurationTarget.WORKSPACE_FOLDER:
this.handleWorkspaceFolderConfiguration(setting, configuration, markerData);
break;
}
} else if (!OVERRIDE_PROPERTY_REGEX.test(setting.key)) { // Ignore override settings (language specific settings)
markerData.push({
severity: MarkerSeverity.Hint,
tags: [MarkerTag.Unnecessary],
...setting.range,
message: nls.localize('unknown configuration setting', "Unknown Configuration Setting")
});
}
}
}
}
return markerData;
}
private handleLocalUserConfiguration(setting: ISetting, configuration: IConfigurationPropertySchema, markerData: IMarkerData[]): void {
if (this.environmentService.remoteAuthority && (configuration.scope === ConfigurationScope.MACHINE || configuration.scope === ConfigurationScope.MACHINE_OVERRIDABLE)) {
markerData.push({
severity: MarkerSeverity.Hint,
tags: [MarkerTag.Unnecessary],
...setting.range,
message: nls.localize('unsupportedRemoteMachineSetting', "This setting cannot be applied in this window. It will be applied when you open a local window.")
});
}
}
private handleRemoteUserConfiguration(setting: ISetting, configuration: IConfigurationPropertySchema, markerData: IMarkerData[]): void {
if (configuration.scope === ConfigurationScope.APPLICATION) {
markerData.push(this.generateUnsupportedApplicationSettingMarker(setting));
}
}
private handleWorkspaceConfiguration(setting: ISetting, configuration: IConfigurationPropertySchema, markerData: IMarkerData[]): void {
if (configuration.scope === ConfigurationScope.APPLICATION) {
markerData.push(this.generateUnsupportedApplicationSettingMarker(setting));
}
if (configuration.scope === ConfigurationScope.MACHINE) {
markerData.push(this.generateUnsupportedMachineSettingMarker(setting));
}
if (!this.workspaceTrustManagementService.isWorkspaceTrusted() && configuration.restricted) {
const marker = this.generateUntrustedSettingMarker(setting);
markerData.push(marker);
const codeActions = this.generateUntrustedSettingCodeActions([marker]);
this.addCodeActions(marker, codeActions);
}
}
private handleWorkspaceFolderConfiguration(setting: ISetting, configuration: IConfigurationPropertySchema, markerData: IMarkerData[]): void {
if (configuration.scope === ConfigurationScope.APPLICATION) {
markerData.push(this.generateUnsupportedApplicationSettingMarker(setting));
}
if (configuration.scope === ConfigurationScope.MACHINE) {
markerData.push(this.generateUnsupportedMachineSettingMarker(setting));
}
if (configuration.scope === ConfigurationScope.WINDOW) {
markerData.push({
severity: MarkerSeverity.Hint,
tags: [MarkerTag.Unnecessary],
...setting.range,
message: nls.localize('unsupportedWindowSetting', "This setting cannot be applied in this workspace. It will be applied when you open the containing workspace folder directly.")
});
}
if (!this.workspaceTrustManagementService.isWorkspaceTrusted() && configuration.restricted) {
const marker = this.generateUntrustedSettingMarker(setting);
markerData.push(marker);
const codeActions = this.generateUntrustedSettingCodeActions([marker]);
this.addCodeActions(marker, codeActions);
}
}
private generateUnsupportedApplicationSettingMarker(setting: ISetting): IMarkerData {
return {
severity: MarkerSeverity.Hint,
tags: [MarkerTag.Unnecessary],
...setting.range,
message: nls.localize('unsupportedApplicationSetting', "This setting can be applied only in application user settings")
};
}
private generateUnsupportedMachineSettingMarker(setting: ISetting): IMarkerData {
return {
severity: MarkerSeverity.Hint,
tags: [MarkerTag.Unnecessary],
...setting.range,
message: nls.localize('unsupportedMachineSetting', "This setting can only be applied in user settings in local window or in remote settings in remote window.")
};
}
private generateUntrustedSettingMarker(setting: ISetting): IMarkerData {
return {
severity: MarkerSeverity.Warning,
...setting.range,
message: nls.localize('untrustedSetting', "This setting can only be applied in a trusted workspace.")
};
}
private generateUntrustedSettingCodeActions(diagnostics: IMarkerData[]): modes.CodeAction[] {
return [{
title: nls.localize('manage workspace trust', "Manage Workspace Trust"),
command: {
id: 'workbench.trust.manage',
title: nls.localize('manage workspace trust', "Manage Workspace Trust")
},
diagnostics,
kind: CodeActionKind.QuickFix.value
}];
}
private addCodeActions(range: IRange, codeActions: modes.CodeAction[]): void {
let actions = this.codeActions.get(this.settingsEditorModel.uri);
if (!actions) {
actions = [];
this.codeActions.set(this.settingsEditorModel.uri, actions);
}
actions.push([Range.lift(range), codeActions]);
}
public override dispose(): void {
this.markerService.remove('UnsupportedSettingsRenderer', [this.settingsEditorModel.uri]);
this.codeActions.clear();
super.dispose();
}
}
class WorkspaceConfigurationRenderer extends Disposable {
private static readonly supportedKeys = ['folders', 'tasks', 'launch', 'extensions', 'settings', 'remoteAuthority', 'transient'];
private decorationIds: string[] = [];
private renderingDelayer: Delayer<void> = new Delayer<void>(200);
constructor(private editor: ICodeEditor, private workspaceSettingsEditorModel: SettingsEditorModel,
@IWorkspaceContextService private readonly workspaceContextService: IWorkspaceContextService,
@IMarkerService private readonly markerService: IMarkerService
) {
super();
this._register(this.editor.getModel()!.onDidChangeContent(() => this.renderingDelayer.trigger(() => this.render())));
}
render(): void {
const markerData: IMarkerData[] = [];
if (this.workspaceContextService.getWorkbenchState() === WorkbenchState.WORKSPACE && this.workspaceSettingsEditorModel instanceof WorkspaceConfigurationEditorModel) {
const ranges: IRange[] = [];
for (const settingsGroup of this.workspaceSettingsEditorModel.configurationGroups) {
for (const section of settingsGroup.sections) {
for (const setting of section.settings) {
if (!WorkspaceConfigurationRenderer.supportedKeys.includes(setting.key)) {
markerData.push({
severity: MarkerSeverity.Hint,
tags: [MarkerTag.Unnecessary],
...setting.range,
message: nls.localize('unsupportedProperty', "Unsupported Property")
});
}
}
}
}
this.decorationIds = this.editor.deltaDecorations(this.decorationIds, ranges.map(range => this.createDecoration(range)));
}
if (markerData.length) {
this.markerService.changeOne('WorkspaceConfigurationRenderer', this.workspaceSettingsEditorModel.uri, markerData);
} else {
this.markerService.remove('WorkspaceConfigurationRenderer', [this.workspaceSettingsEditorModel.uri]);
}
}
private static readonly _DIM_CONFIGURATION_ = ModelDecorationOptions.register({
description: 'dim-configuration',
stickiness: TrackedRangeStickiness.NeverGrowsWhenTypingAtEdges,
inlineClassName: 'dim-configuration'
});
private createDecoration(range: IRange): IModelDeltaDecoration {
return {
range,
options: WorkspaceConfigurationRenderer._DIM_CONFIGURATION_
};
}
override dispose(): void {
this.markerService.remove('WorkspaceConfigurationRenderer', [this.workspaceSettingsEditorModel.uri]);
this.decorationIds = this.editor.deltaDecorations(this.decorationIds, []);
super.dispose();
}
}