Skip to content

Properly trim spaces using the new TextEditor.edit() callback #26

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

Properly trim spaces using the new TextEditor.edit() callback #26

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 31 additions & 17 deletions src/trailing-spaces/trailing-spaces.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ export class TrailingSpaces {
private languagesToIgnore: { [id: string]: boolean; };
private settings: TralingSpacesSettings;
private highlightSettings: TralingSpacesSettings;
private pendingSave: Set<vscode.Uri>;

constructor() {
this.logger = Logger.getInstance();
Expand All @@ -51,13 +52,14 @@ export class TrailingSpaces {
this.onDisk = {};
this.loadConfig();
this.decorationType = vscode.window.createTextEditorDecorationType(this.decorationOptions);
this.pendingSave = new Set(); // list of file uri's currently being saved
}

public loadConfig(settings?: string): void {
if (settings)
this.settings = JSON.parse(settings);
else
this.settings = {
this.settings = {
includeEmptyLines: this.config.get<boolean>("includeEmptyLines"),
highlightCurrentLine: this.config.get<boolean>("highlightCurrentLine"),
regexp: this.config.get<string>("regexp"),
Expand Down Expand Up @@ -109,15 +111,27 @@ export class TrailingSpaces {
});
vscode.workspace.onDidSaveTextDocument((document: vscode.TextDocument) => {
this.logger.log("onDidSaveTextDocument event called - " + document.fileName);
if(this.pendingSave.has(document.uri)) {
// this event is from our action of saving the file, ignore it
this.logger.log("file is pending to be saved; ignoring");
return;
}

vscode.window.visibleTextEditors.forEach((editor: vscode.TextEditor) => {
if (document.uri === editor.document.uri)
if (this.settings.trimOnSave) {
editor.edit((editBuilder: vscode.TextEditorEdit) => {
this.deleteTrailingSpaces(editor, editBuilder);
}).then(() => {
editor.document.save().then(() => {
this.freezeLastVersion(editor.document);
});
if(editor.document.isDirty) {
this.pendingSave.add(editor.document.uri);
editor.document.save().then(() => {
this.freezeLastVersion(editor.document);
this.pendingSave.delete(editor.document.uri);
});
} else {
this.logger.log('Document is not dirty, not triggering a save');
}
});
} else {
this.freezeLastVersion(editor.document);
Expand All @@ -141,13 +155,13 @@ export class TrailingSpaces {
}

public deleteTrailingSpaces(editor: vscode.TextEditor, editorEdit: vscode.TextEditorEdit): void {
this.deleteTrailingSpacesCore(editor.document, editor.selection, this.settings);
this.deleteTrailingSpacesCore(editor.document, editor.selection, this.settings, editorEdit);
}

public deleteTrailingSpacesModifiedLinesOnly(editor: vscode.TextEditor, editorEdit: vscode.TextEditorEdit): void {
let modifiedLinesSettings: TralingSpacesSettings = Object.assign({}, this.settings);
modifiedLinesSettings.deleteModifiedLinesOnly = true;
this.deleteTrailingSpacesCore(editor.document, editor.selection, modifiedLinesSettings);
this.deleteTrailingSpacesCore(editor.document, editor.selection, modifiedLinesSettings, editorEdit);
}

public highlightTrailingSpaces(editor: vscode.TextEditor, editorEdit: vscode.TextEditorEdit): void {
Expand All @@ -162,16 +176,10 @@ export class TrailingSpaces {
this.deleteInFolderCore(editor.document, true);
}

private deleteTrailingSpacesCore(document: vscode.TextDocument, selection: vscode.Selection, settings: TralingSpacesSettings): void {
let workspaceEdit: vscode.WorkspaceEdit = new vscode.WorkspaceEdit();
private deleteTrailingSpacesCore(document: vscode.TextDocument, selection: vscode.Selection, settings: TralingSpacesSettings, editorEdit: vscode.TextEditorEdit): void {
// let workspaceEdit: vscode.WorkspaceEdit = new vscode.WorkspaceEdit();
let end = document.validatePosition(selection.end);
this.deleteTrailingRegions(document, settings, document.lineAt(end), workspaceEdit);
if (workspaceEdit.size > 0) {
vscode.workspace.applyEdit(workspaceEdit).then(() => {
if (this.settings.saveAfterTrim && !this.settings.trimOnSave)
document.save();
});
}
this.deleteTrailingRegions(document, settings, document.lineAt(end), editorEdit);
}

private deleteInFolderCore(document: vscode.TextDocument, recursive: boolean = false): void {
Expand Down Expand Up @@ -227,7 +235,7 @@ export class TrailingSpaces {
});
}

private deleteTrailingRegions(document: vscode.TextDocument, settings: TralingSpacesSettings, currentLine: vscode.TextLine, workspaceEdit: vscode.WorkspaceEdit): number {
private deleteTrailingRegions(document: vscode.TextDocument, settings: TralingSpacesSettings, currentLine: vscode.TextLine, workspaceEdit: vscode.WorkspaceEdit | vscode.TextEditorEdit): number {
let message: string;
let edits: number = 0;
if (this.ignoreFile(document)) {
Expand All @@ -239,7 +247,13 @@ export class TrailingSpaces {
if (regions) {
regions.reverse();
regions.forEach((region: vscode.Range) => {
workspaceEdit.delete(document.uri, region);
if(workspaceEdit instanceof vscode.WorkspaceEdit) {
// vscode.WorkspaceEdit - we are triming outside of a editor hook
workspaceEdit.delete(document.uri, region);
} else {
// vscode.TextEditorEdit - we are triming inside of an editor hook
workspaceEdit.delete(region);
}
});
}

Expand Down