fix: Correctly format config files (#2532)

streetsidesoftware · Feb 20, 2023 · fbcda3e · fbcda3e
1 parent 0840e2b
commit fbcda3e
Show file tree

Hide file tree

Showing 2 changed files with 42 additions and 17 deletions.
diff --git a/packages/client/src/settings/configRepository.ts b/packages/client/src/settings/configRepository.ts
@@ -1,13 +1,15 @@
 import { uriToName } from 'common-utils/uriHelper.js';
 import { pick } from 'common-utils/util.js';
-import { commands, ConfigurationTarget, TextDocument, TextEdit, Uri, workspace, WorkspaceEdit, WorkspaceFolder } from 'vscode';
+import { commands, ConfigurationTarget, TextEdit, Uri, window, workspace, WorkspaceEdit, WorkspaceFolder } from 'vscode';
 import { CSpellUserSettings, CustomDictionaryScope } from '../client';
 import { ConfigFields } from './configFields';
 import { ConfigFileReaderWriter, createConfigFileReaderWriter } from './configFileReadWrite';
 import { ConfigUpdater, configUpdaterForKey } from './configUpdater';
+import { findOpenDocument } from './fs';
 import { configurationTargetToDictionaryScope } from './targetAndScope';
 import { GetConfigurationScope, getSettingFromVSConfig } from './vsConfig';
 import { createVSConfigReaderWriter, VSConfigReaderWriter } from './vsConfigReaderWriter';
+import { posix } from 'path';
 
 export type ConfigKeys = keyof CSpellUserSettings;
 
@@ -103,30 +105,33 @@ export class CSpellConfigRepository extends ConfigRepositoryBase {
     async update<K extends ConfigKeys>(updater: ConfigUpdater<K>): Promise<void> {
         const formatConfig = this.formatConfig;
         const uri = this.configFileUri;
-        const configDoc = formatConfig ? findOpenDocument(uri) : undefined;
-        await configDoc?.save(); // This is necessary or the update might break things.
-        await this.configRW.update(fnUpdateFilterKeys(updater), updater.keys);
-        if (formatConfig) {
-            const edits = await commands.executeCommand<TextEdit[] | undefined>('vscode.executeFormatDocumentProvider', uri);
-            if (!edits || !edits.length) return;
-            const wsEdit = new WorkspaceEdit();
-            wsEdit.set(uri, edits);
-            await workspace.applyEdit(wsEdit);
-            const doc = configDoc || findOpenDocument(uri);
-            if (doc) {
-                await doc.save();
+        const doc = findOpenDocument(uri);
+        if (doc && doc.isDirty) {
+            const name = posix.basename(uri.path);
+            const answer = await window.showInformationMessage(`Overwrite "${name}"?`, 'Yes', 'No', 'Open');
+            if (answer === 'Open') {
+                await window.showTextDocument(doc);
+                return;
             }
+            if (answer !== 'Yes') return;
         }
+        await this.configRW.update(fnUpdateFilterKeys(updater), updater.keys);
+        formatConfig && (await formatDocument(uri));
     }
 
     static isCSpellConfigRepository(rep: ConfigRepository): rep is CSpellConfigRepository {
         return rep instanceof CSpellConfigRepository;
     }
 }
 
-function findOpenDocument(uri: Uri): TextDocument | undefined {
-    const uriStr = uri.toString(true);
-    return workspace.textDocuments.find((doc) => doc.uri.toString(true) === uriStr);
+async function formatDocument(uri: Uri) {
+    const doc = await workspace.openTextDocument(uri);
+    const edits = await commands.executeCommand<TextEdit[] | undefined>('vscode.executeFormatDocumentProvider', uri);
+    if (!edits || !edits.length) return;
+    const wsEdit = new WorkspaceEdit();
+    wsEdit.set(uri, edits);
+    await workspace.applyEdit(wsEdit);
+    await doc.save();
 }
 
 export class VSCodeRepository extends ConfigRepositoryBase {

diff --git a/packages/client/src/settings/fs.ts b/packages/client/src/settings/fs.ts
@@ -1,5 +1,5 @@
 import { isErrorCodeException } from 'common-utils/index.js';
-import { FileSystemError, Uri, workspace } from 'vscode';
+import { FileSystemError, Range, TextDocument, Uri, workspace, WorkspaceEdit } from 'vscode';
 
 const fs = workspace.fs;
 
@@ -25,6 +25,21 @@ async function createDirectory(uri: Uri): Promise<void> {
 }
 
 async function writeFile(uri: Uri, content: string, encoding = 'utf8' as const): Promise<void> {
+    const doc = findOpenDocument(uri);
+    return doc ? _writeDoc(doc, content) : _writeFile(uri, content, encoding);
+}
+
+async function _writeDoc(doc: TextDocument, content: string): Promise<void> {
+    const currentText = doc.getText();
+    if (currentText === content) return;
+    const range = new Range(doc.positionAt(0), doc.positionAt(currentText.length));
+    const edit = new WorkspaceEdit();
+    edit.replace(doc.uri, range, content);
+    await workspace.applyEdit(edit);
+    await doc.save();
+}
+
+async function _writeFile(uri: Uri, content: string, encoding: 'utf8'): Promise<void> {
     return await fs.writeFile(uri, Buffer.from(content, encoding));
 }
 
@@ -47,6 +62,11 @@ function isFileNotFoundError(e: unknown): boolean {
     return e.code in FileNotFoundErrorCodes;
 }
 
+export function findOpenDocument(uri: Uri): TextDocument | undefined {
+    const uriStr = uri.toString(true);
+    return workspace.textDocuments.find((doc) => doc.uri.toString(true) === uriStr);
+}
+
 export const vscodeFs: VSCodeFs = {
     createDirectory,
     writeFile,