fix: Enable creating config files on remote servers (#3102)

streetsidesoftware · Mar 9, 2024 · 715ad29 · 715ad29
1 parent 76e1583
commit 715ad29
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 9 deletions.
diff --git a/packages/client/src/settings/configFileReadWrite.ts b/packages/client/src/settings/configFileReadWrite.ts
@@ -54,7 +54,7 @@ export async function readConfigFile(uri: Uri, defaultValueIfNotFound?: CSpellSe
     }
 }
 
-export function writeConfigFile(uri: Uri, cfg: CSpellSettings): Promise<void> {
+export function writeConfigFile(uri: Uri, cfg: Readonly<CSpellSettings>): Promise<void> {
     const rw = createConfigFileReaderWriter(uri);
     return rw.write(cfg);
 }

diff --git a/packages/client/src/settings/configReaderWriter.ts b/packages/client/src/settings/configReaderWriter.ts
@@ -10,7 +10,7 @@ type ConfigKeys = keyof CSpellUserSettings;
 
 export interface ConfigReaderWriter {
     read<K extends ConfigKeys>(keys: readonly K[]): Promise<Pick<CSpellUserSettings, K>>;
-    write(settings: CSpellUserSettings): Promise<void>;
+    write(settings: Readonly<CSpellUserSettings>): Promise<void>;
     update<K extends ConfigKeys>(fn: ConfigUpdateFn, keys: readonly K[]): Promise<void>;
 }
 

diff --git a/packages/client/src/settings/settings.ts b/packages/client/src/settings/settings.ts
@@ -5,9 +5,8 @@ import { Uri, workspace } from 'vscode';
 import type { CSpellUserSettings } from '../client';
 import { unique } from '../util';
 import type { ClientConfigTarget } from './clientConfigTarget';
-import { writeConfigFile } from './configFileReadWrite';
+import { readConfigFile, writeConfigFile } from './configFileReadWrite';
 import { normalizeWords, preferredConfigFiles } from './CSpellSettings';
-import { vscodeFs as fs } from './fs';
 import { setConfigFieldQuickPick } from './settings.base';
 
 export { setEnableSpellChecking, toggleEnableSpellChecker } from './settings.enable';
@@ -92,11 +91,19 @@ const settingsFileTemplate: CSpellSettings = {
 };
 
 export async function createConfigFile(fileUri: Uri, overwrite?: boolean): Promise<Uri | undefined> {
-    if (!overwrite && (await fs.fileExists(fileUri))) {
+    const existing = await readConfigFile(fileUri);
+    if (!overwrite && existing && Object.keys(existing).length > 1) {
         const overwrite = 'Overwrite';
-        const choice = await vscode.window.showWarningMessage('Configuration file already exists.', { modal: true }, overwrite);
-        if (choice !== overwrite) {
-            return undefined;
+        const open = 'Open';
+        const choice = await vscode.window.showWarningMessage('Configuration file already exists.', { modal: true }, overwrite, open);
+        switch (choice) {
+            case overwrite:
+                break;
+            case open:
+                await vscode.window.showTextDocument(fileUri);
+                return undefined;
+            default:
+                return undefined;
         }
     }
 
@@ -125,7 +132,6 @@ export async function createConfigFileRelativeToDocumentUri(referenceDocUri?: Ur
     const folder = getDefaultWorkspaceConfigLocation(referenceDocUri);
 
     if (!folder) throw new Error(msgNoPossibleConfigLocation);
-    if (folder.uri.scheme !== 'file') throw new Error(`Unsupported scheme: ${folder.uri.scheme}`);
 
     const optionalFiles = new Set(preferredConfigFiles);