/*--------------------------------------------------------------------------------------------- * Copyright (c) Microsoft Corporation. All rights reserved. * Licensed under the MIT License. See License.txt in the project root for license information. *--------------------------------------------------------------------------------------------*/ import { Editor } from './editor'; import { Editors } from './editors'; import { Code } from './code'; import { QuickAccess } from './quickaccess'; const SEARCH_BOX_NATIVE_EDIT_CONTEXT = '.settings-editor .suggest-input-container .monaco-editor .native-edit-context'; const SEARCH_BOX_TEXTAREA = '.settings-editor .suggest-input-container .monaco-editor textarea'; export class SettingsEditor { constructor(private code: Code, private editors: Editors, private editor: Editor, private quickaccess: QuickAccess) { } /** * Write a single setting key value pair. * * Warning: You may need to set `editor.wordWrap` to `"on"` if this is called with a really long * setting. */ async addUserSetting(setting: string, value: string): Promise { await this.openUserSettingsFile(); await this.editors.selectTab('settings.json'); await this.code.dispatchKeybinding('right', () => this.editor.waitForEditorSelection('settings.json', (s) => this._acceptEditorSelection(this.code.editContextEnabled, s))); await this.editor.waitForTypeInEditor('settings.json', `"${setting}": ${value},`); await this.editors.saveOpenedFile(); } /** * Write several settings faster than multiple calls to {@link addUserSetting}. * * Warning: You will likely also need to set `editor.wordWrap` to `"on"` if `addUserSetting` is * called after this in the test. */ async addUserSettings(settings: [key: string, value: string][]): Promise { await this.openUserSettingsFile(); await this.editors.selectTab('settings.json'); await this.code.dispatchKeybinding('right', () => this.editor.waitForEditorSelection('settings.json', (s) => this._acceptEditorSelection(this.code.editContextEnabled, s))); await this.editor.waitForTypeInEditor('settings.json', settings.map(v => `"${v[0]}": ${v[1]},`).join('')); await this.editors.saveOpenedFile(); } async clearUserSettings(): Promise { await this.openUserSettingsFile(); await this.quickaccess.runCommand('editor.action.selectAll'); await this.code.dispatchKeybinding('Delete', async () => { await this.editor.waitForEditorContents('settings.json', contents => contents === ''); }); await this.editor.waitForTypeInEditor('settings.json', `{`); // will auto close } await this.editors.saveOpenedFile(); await this.quickaccess.runCommand('workbench.action.closeActiveEditor'); } async openUserSettingsFile(): Promise { await this.quickaccess.runCommand('workbench.action.openSettingsJson'); await this.editor.waitForEditorFocus('settings.json', 1); } async openUserSettingsUI(): Promise { await this.quickaccess.runCommand('workbench.action.openSettings2'); await this.code.waitForActiveElement(this._editContextSelector()); } async searchSettingsUI(query: string): Promise { await this.openUserSettingsUI(); await this.code.waitAndClick(this._editContextSelector()); await this.code.dispatchKeybinding(process.platform === 'darwin' ? 'cmd+a' : 'ctrl+a', async () => { }); await this.code.dispatchKeybinding('Delete', async () => { await this.code.waitForElements('.settings-editor .settings-count-widget', false, results => !results || (results?.length === 1 && !results[0].textContent)); }); await this.code.waitForTypeInEditor(this._editContextSelector(), query); await this.code.waitForElements('.settings-editor .settings-count-widget', false, results => results?.length === 1 && results[0].textContent.includes('Found')); } private _editContextSelector() { return !this.code.editContextEnabled ? SEARCH_BOX_TEXTAREA : SEARCH_BOX_NATIVE_EDIT_CONTEXT; } private _acceptEditorSelection(editContextEnabled: boolean, s: { selectionStart: number; selectionEnd: number }): boolean { if (!editContextEnabled) { return true; } return s.selectionStart === 1 && s.selectionEnd === 1; } }