Microsoft/vscode
1
0
Fork 0
mirror of https://github.com/microsoft/vscode.git synced 2026-08-14 09:45:55 +01:00
Code Issues Packages Projects Releases Wiki Activity

"workbench.action.compareEditor.swapSides" may create Untitled files unnecessarily (fix #204560) (#204565)

Browse Source
This commit is contained in:
Benjamin Pasero
2024-02-07 09:06:16 +01:00
committed by GitHub
parent 64cd658cac
commit fd2db10345
7 changed files with 35 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/vs/workbench/browser/parts/editor/editorCommands.ts
+2 -2
View File
@@ -475,7 +475,7 @@ function registerDiffEditorCommands(): void {
return;
}
const untypedDiffInput = diffInput.toUntyped({ preserveViewState: activeGroup.id });
const untypedDiffInput = diffInput.toUntyped({ preserveViewState: activeGroup.id, preserveResource: true });
if (!untypedDiffInput) {
return;
}
@@ -484,7 +484,7 @@ function registerDiffEditorCommands(): void {
// sure to first open the modified side if it is not
// yet opened. This ensures that the swapping is not
// bringing up a confirmation dialog to save.
if (diffInput.modified.isModified() && !editorService.isOpened({ resource: diffInput.modified.resource, typeId: diffInput.modified.typeId, editorId: diffInput.modified.editorId })) {
if (diffInput.modified.isModified() && editorService.findEditors({ resource: diffInput.modified.resource, typeId: diffInput.modified.typeId, editorId: diffInput.modified.editorId }).length === 0) {
await editorService.openEditor({
...untypedDiffInput.modified,
options: {
src/vs/workbench/common/editor/diffEditorInput.ts
+3 -3
View File
@@ -5,9 +5,9 @@
import { localize } from 'vs/nls';
import { AbstractSideBySideEditorInputSerializer, SideBySideEditorInput } from 'vs/workbench/common/editor/sideBySideEditorInput';
import { EditorInput } from 'vs/workbench/common/editor/editorInput';
import { EditorInput, IUntypedEditorOptions } from 'vs/workbench/common/editor/editorInput';
import { EditorModel } from 'vs/workbench/common/editor/editorModel';
import { TEXT_DIFF_EDITOR_ID, BINARY_DIFF_EDITOR_ID, Verbosity, IEditorDescriptor, IEditorPane, GroupIdentifier, IResourceDiffEditorInput, IUntypedEditorInput, isResourceDiffEditorInput, IDiffEditorInput, IResourceSideBySideEditorInput, EditorInputCapabilities } from 'vs/workbench/common/editor';
import { TEXT_DIFF_EDITOR_ID, BINARY_DIFF_EDITOR_ID, Verbosity, IEditorDescriptor, IEditorPane, IResourceDiffEditorInput, IUntypedEditorInput, isResourceDiffEditorInput, IDiffEditorInput, IResourceSideBySideEditorInput, EditorInputCapabilities } from 'vs/workbench/common/editor';
import { BaseTextEditorModel } from 'vs/workbench/common/editor/textEditorModel';
import { DiffEditorModel } from 'vs/workbench/common/editor/diffEditorModel';
import { TextDiffEditorModel } from 'vs/workbench/common/editor/textDiffEditorModel';
@@ -210,7 +210,7 @@ export class DiffEditorInput extends SideBySideEditorInput implements IDiffEdito
return new DiffEditorModel(isResolvedEditorModel(originalEditorModel) ? originalEditorModel : undefined, isResolvedEditorModel(modifiedEditorModel) ? modifiedEditorModel : undefined);
}
override toUntyped(options?: { preserveViewState: GroupIdentifier }): (IResourceDiffEditorInput & IResourceSideBySideEditorInput) | undefined {
override toUntyped(options?: IUntypedEditorOptions): (IResourceDiffEditorInput & IResourceSideBySideEditorInput) | undefined {
const untyped = super.toUntyped(options);
if (untyped) {
return {
src/vs/workbench/common/editor/editorInput.ts
+18 -6
View File
@@ -39,6 +39,23 @@ export interface IEditorCloseHandler {
confirm(editors: ReadonlyArray<IEditorIdentifier>): Promise<ConfirmResult>;
}
export interface IUntypedEditorOptions {
/**
* Implementations should try to preserve as much
* view state as possible from the typed input based
* on the group the editor is opened.
*/
readonly preserveViewState?: GroupIdentifier;
/**
* Implementations should preserve the original
* resource of the typed input and not alter
* it.
*/
readonly preserveResource?: boolean;
}
/**
* Editor inputs are lightweight objects that can be passed to the workbench API to open inside the editor part.
* Each editor input is mapped to an editor that is capable of opening it through the Platform facade.
@@ -310,13 +327,8 @@ export abstract class EditorInput extends AbstractEditorInput {
* editor input into a form that it can be restored.
*
* May return `undefined` if an untyped representation is not supported.
*
* @param options additional configuration for the expected return type.
* When `preserveViewState` is provided, implementations should try to
* preserve as much view state as possible from the typed input based on
* the group the editor is opened.
*/
toUntyped(options?: { preserveViewState: GroupIdentifier }): IUntypedEditorInput | undefined {
toUntyped(options?: IUntypedEditorOptions): IUntypedEditorInput | undefined {
return undefined;
}
src/vs/workbench/common/editor/sideBySideEditorInput.ts
+2 -2
View File
@@ -10,7 +10,7 @@ import { localize } from 'vs/nls';
import { IInstantiationService } from 'vs/platform/instantiation/common/instantiation';
import { Registry } from 'vs/platform/registry/common/platform';
import { EditorInputCapabilities, GroupIdentifier, ISaveOptions, IRevertOptions, EditorExtensions, IEditorFactoryRegistry, IEditorSerializer, ISideBySideEditorInput, IUntypedEditorInput, isResourceSideBySideEditorInput, isDiffEditorInput, isResourceDiffEditorInput, IResourceSideBySideEditorInput, findViewStateForEditor, IMoveResult, isEditorInput, isResourceEditorInput, Verbosity, isResourceMergeEditorInput, isResourceDiffListEditorInput } from 'vs/workbench/common/editor';
import { EditorInput } from 'vs/workbench/common/editor/editorInput';
import { EditorInput, IUntypedEditorOptions } from 'vs/workbench/common/editor/editorInput';
import { IEditorService } from 'vs/workbench/services/editor/common/editorService';
/**
@@ -271,7 +271,7 @@ export class SideBySideEditorInput extends EditorInput implements ISideBySideEdi
return this.primary.isReadonly();
}
override toUntyped(options?: { preserveViewState: GroupIdentifier }): IResourceSideBySideEditorInput | undefined {
override toUntyped(options?: IUntypedEditorOptions): IResourceSideBySideEditorInput | undefined {
const primaryResourceEditorInput = this.primary.toUntyped(options);
const secondaryResourceEditorInput = this.secondary.toUntyped(options);
src/vs/workbench/contrib/files/browser/editors/fileEditorInput.ts
+2 -2
View File
@@ -5,7 +5,7 @@
import { URI } from 'vs/base/common/uri';
import { IFileEditorInput, Verbosity, GroupIdentifier, IMoveResult, EditorInputCapabilities, IEditorDescriptor, IEditorPane, IUntypedEditorInput, DEFAULT_EDITOR_ASSOCIATION, IUntypedFileEditorInput, findViewStateForEditor, isResourceEditorInput, IFileEditorInputOptions } from 'vs/workbench/common/editor';
import { EditorInput } from 'vs/workbench/common/editor/editorInput';
import { EditorInput, IUntypedEditorOptions } from 'vs/workbench/common/editor/editorInput';
import { AbstractTextResourceEditorInput } from 'vs/workbench/common/editor/textResourceEditorInput';
import { ITextResourceEditorInput } from 'vs/platform/editor/common/editor';
import { BinaryEditorModel } from 'vs/workbench/common/editor/binaryEditorModel';
@@ -418,7 +418,7 @@ export class FileEditorInput extends AbstractTextResourceEditorInput implements
};
}
override toUntyped(options?: { preserveViewState: GroupIdentifier }): ITextResourceEditorInput {
override toUntyped(options?: IUntypedEditorOptions): ITextResourceEditorInput {
const untypedInput: IUntypedFileEditorInput = {
resource: this.preferredResource,
forceFile: true,
src/vs/workbench/services/untitled/common/untitledTextEditorInput.ts
+4 -4
View File
@@ -4,8 +4,8 @@
*--------------------------------------------------------------------------------------------*/
import { URI } from 'vs/base/common/uri';
import { DEFAULT_EDITOR_ASSOCIATION, findViewStateForEditor, GroupIdentifier, isUntitledResourceEditorInput, IUntitledTextResourceEditorInput, IUntypedEditorInput, Verbosity } from 'vs/workbench/common/editor';
import { EditorInput } from 'vs/workbench/common/editor/editorInput';
import { DEFAULT_EDITOR_ASSOCIATION, findViewStateForEditor, isUntitledResourceEditorInput, IUntitledTextResourceEditorInput, IUntypedEditorInput, Verbosity } from 'vs/workbench/common/editor';
import { EditorInput, IUntypedEditorOptions } from 'vs/workbench/common/editor/editorInput';
import { AbstractTextResourceEditorInput } from 'vs/workbench/common/editor/textResourceEditorInput';
import { IUntitledTextEditorModel } from 'vs/workbench/services/untitled/common/untitledTextEditorModel';
import { EncodingMode, IEncodingSupport, ILanguageSupport, ITextFileService } from 'vs/workbench/services/textfile/common/textfiles';
@@ -165,7 +165,7 @@ export class UntitledTextEditorInput extends AbstractTextResourceEditorInput imp
return this.model;
}
override toUntyped(options?: { preserveViewState: GroupIdentifier }): IUntitledTextResourceEditorInput {
override toUntyped(options?: IUntypedEditorOptions): IUntitledTextResourceEditorInput {
const untypedInput: IUntitledTextResourceEditorInput & { resource: URI | undefined; options: ITextEditorOptions } = {
resource: this.model.hasAssociatedFilePath ? toLocalResource(this.model.resource, this.environmentService.remoteAuthority, this.pathService.defaultUriScheme) : this.resource,
forceUntitled: true,
@@ -180,7 +180,7 @@ export class UntitledTextEditorInput extends AbstractTextResourceEditorInput imp
untypedInput.contents = this.model.isModified() ? this.model.textEditorModel?.getValue() : undefined;
untypedInput.options.viewState = findViewStateForEditor(this, options.preserveViewState, this.editorService);
if (typeof untypedInput.contents === 'string' && !this.model.hasAssociatedFilePath) {
if (typeof untypedInput.contents === 'string' && !this.model.hasAssociatedFilePath && !options.preserveResource) {
// Given how generic untitled resources in the system are, we
// need to be careful not to set our resource into the untyped
// editor if we want to transport contents too, because of
src/vs/workbench/services/untitled/test/browser/untitledTextEditor.test.ts
+4
View File
@@ -111,6 +111,10 @@ suite('Untitled text editors', () => {
assert.strictEqual(dirtyUntypedInput.contents, 'foo bar');
assert.strictEqual(dirtyUntypedInput.resource, undefined);
const dirtyUntypedInputWithResource = input2.toUntyped({ preserveViewState: 0, preserveResource: true });
assert.strictEqual(dirtyUntypedInputWithResource.contents, 'foo bar');
assert.strictEqual(dirtyUntypedInputWithResource?.resource?.toString(), input2.resource.toString());
const dirtyUntypedInputWithoutContent = input2.toUntyped();
assert.strictEqual(dirtyUntypedInputWithoutContent.resource?.toString(), input2.resource.toString());
assert.strictEqual(dirtyUntypedInputWithoutContent.contents, undefined);