fix: Do not try to update unsupported config file formats (#893)

fixtures/workspaces/js-config/README.md

@@ -6,3 +6,4 @@ WORKSPACEWORD - a word only in the workspace.
 
 Terms:
 customterm - Added to Custom Terms.
+ignoreterm - A term that is ignored.

fixtures/workspaces/js-config/js-config.code-workspace

@@ -4,14 +4,5 @@
             "path": "."
         }
     ],
-    "settings": {
-        "cSpell.customWorkspaceDictionaries": [
-            {
-                "addWords": true,
-                "description": "Alternate dictionary 2",
-                "name": "alt-terms",
-                "path": "${workspaceFolder}/alt-words.txt"
-            }
-        ]
-    }
+    "settings": {}
 }

fixtures/workspaces/js-config/packages/nested/README.md

@@ -0,0 +1,5 @@
+# Nested folder
+
+This is a nested folder with its own `cspell.config.js` file.
+
+customterm - Added to Custom Terms.

fixtures/workspaces/js-config/packages/nested/cspell.config.js

@@ -0,0 +1,8 @@
+'use strict';
+
+/** @type { import("@cspell/cspell-types").CSpellUserSettings } */
+const cspell = {
+    description: 'nested js-config example',
+};
+
+module.exports = cspell;

fixtures/workspaces/js-config/packages/pkg/README.md

@@ -0,0 +1,5 @@
+# Config in `package.json` folder
+
+This is a nested folder with `cspell` config stored in the `package.json` file.
+
+customterm - A custom word.

fixtures/workspaces/js-config/packages/pkg/package.json

@@ -0,0 +1,16 @@
+{
+    "name": "pkg",
+    "version": "1.0.0",
+    "description": "Sample Package",
+    "main": "index.js",
+    "scripts": {
+        "test": "echo test"
+    },
+    "cspell": {
+        "words": [
+            "customterm"
+        ]
+    },
+    "author": "",
+    "license": "MIT"
+}

packages/client/src/commands.ts

@@ -75,11 +75,19 @@ export function addWordToUserDictionary(word: string): Thenable<void> {
 }
 
 function addWordToTarget(word: string, target: Settings.Target, docUri: string | null | Uri | undefined) {
+    return handleErrors(_addWordToTarget(word, target, docUri));
+}
+
+function _addWordToTarget(word: string, target: Settings.Target, docUri: string | null | Uri | undefined) {
     docUri = parseOptionalUri(docUri);
     return di.dependencies.dictionaryHelper.addWordToTarget(word, target, docUri);
 }
 
-export async function addIgnoreWordToTarget(word: string, target: Settings.Target, uri: string | null | Uri | undefined): Promise<void> {
+export function addIgnoreWordToTarget(word: string, target: Settings.Target, uri: string | null | Uri | undefined): Promise<void> {
+    return handleErrors(_addIgnoreWordToTarget(word, target, uri));
+}
+
+async function _addIgnoreWordToTarget(word: string, target: Settings.Target, uri: string | null | Uri | undefined): Promise<void> {
     uri = parseOptionalUri(uri);
     const actualTarget = resolveTarget(target, uri);
     await Settings.addIgnoreWordToSettings(actualTarget, word);
@@ -99,7 +107,11 @@ export function removeWordFromUserDictionary(word: string): Thenable<void> {
     return removeWordFromTarget(word, Settings.Target.Global, undefined);
 }
 
-async function removeWordFromTarget(word: string, target: Settings.Target, uri: string | null | Uri | undefined) {
+function removeWordFromTarget(word: string, target: Settings.Target, uri: string | null | Uri | undefined) {
+    return handleErrors(_removeWordFromTarget(word, target, uri));
+}
+
+async function _removeWordFromTarget(word: string, target: Settings.Target, uri: string | null | Uri | undefined) {
     uri = parseOptionalUri(uri);
     const actualTarget = resolveTarget(target, uri);
     await Settings.removeWordFromSettings(actualTarget, word);
@@ -109,12 +121,12 @@ async function removeWordFromTarget(word: string, target: Settings.Target, uri:
 
 export function enableLanguageId(languageId: string, uri?: string | Uri): Promise<void> {
     uri = parseOptionalUri(uri);
-    return Settings.enableLanguageIdForClosestTarget(languageId, true, uri);
+    return handleErrors(Settings.enableLanguageIdForClosestTarget(languageId, true, uri));
 }
 
 export function disableLanguageId(languageId: string, uri?: string | Uri): Promise<void> {
     uri = parseOptionalUri(uri);
-    return Settings.enableLanguageIdForClosestTarget(languageId, false, uri);
+    return handleErrors(Settings.enableLanguageIdForClosestTarget(languageId, false, uri));
 }
 
 export function userCommandOnCurrentSelectionOrPrompt(
@@ -134,6 +146,23 @@ export function userCommandOnCurrentSelectionOrPrompt(
     };
 }
 
+function isError(e: unknown): e is Error {
+    if (!e) return false;
+    const err = <Error>e;
+    return err.message !== undefined && err.name !== undefined;
+}
+
+function onError(reason: unknown): Promise<void> {
+    if (isError(reason)) {
+        window.showErrorMessage(reason.message);
+    }
+    return Promise.resolve();
+}
+
+function handleErrors(p: Promise<void>): Promise<void> {
+    return p.catch(onError);
+}
+
 function parseOptionalUri(uri: string | Uri): Uri;
 function parseOptionalUri(uri: null | undefined): Uri | undefined;
 function parseOptionalUri(uri: string | Uri | null | undefined): Uri | undefined;

packages/client/src/settings/CSpellSettings.ts

@@ -37,6 +37,7 @@ export const configFileLocations = [
 export const nestedConfigLocations = ['package.json'];
 
 const regIsJson = /\.jsonc?$/;
+const regIsPackageJson = /package\.json$/i;
 
 export const possibleConfigFiles = new Set(configFileLocations.concat(nestedConfigLocations));
 /**
@@ -167,7 +168,8 @@ export function normalizeWord(word: string): string[] {
 
 export function isUpdateSupportedForConfigFileFormat(uri: Uri): boolean {
     const u = uri.with({ fragment: '', query: '' });
-    return regIsJson.test(u.toString());
+    const s = u.toString();
+    return regIsJson.test(s) && !regIsPackageJson.test(s);
 }
 
 export class FailedToUpdateConfigFile extends Error {

packages/client/src/settings/settings.ts

@@ -8,6 +8,7 @@ import {
     readSettings,
     filterOutWords,
     readSettingsFileAndApplyUpdate,
+    isUpdateSupportedForConfigFileFormat,
 } from './CSpellSettings';
 import { workspace, ConfigurationTarget } from 'vscode';
 performance.mark('settings.ts imports 1');
@@ -69,7 +70,7 @@ export function hasWorkspaceLocation(): boolean {
  * Returns a list of files in the order of Best to Worst Match.
  * @param uri
  */
-export function findSettingsFiles(uri?: Uri): Promise<Uri[]> {
+export function findSettingsFiles(uri?: Uri, isUpdatable?: boolean): Promise<Uri[]> {
     const { workspaceFolders } = workspace;
     if (!workspaceFolders || !hasWorkspaceLocation()) {
         return Promise.resolve([]);
@@ -89,15 +90,16 @@ export function findSettingsFiles(uri?: Uri): Promise<Uri[]> {
             .filter((found) => found.exists)
             .map((found) => found.filename)
             .map((filename) => Uri.file(filename))
+            .filter((uri) => !isUpdatable || isUpdateSupportedForConfigFileFormat(uri))
     );
 }
 
-export function findExistingSettingsFileLocation(uri?: Uri): Promise<Uri | undefined> {
-    return findSettingsFiles(uri).then((paths) => paths[0]);
+export function findExistingSettingsFileLocation(uri?: Uri, isUpdatable?: boolean): Promise<Uri | undefined> {
+    return findSettingsFiles(uri, isUpdatable).then((paths) => paths[0]);
 }
 
-export function findSettingsFileLocation(): Promise<Uri | undefined> {
-    return findExistingSettingsFileLocation().then((path) => path || getDefaultWorkspaceConfigLocation());
+export function findSettingsFileLocation(isUpdatable?: boolean): Promise<Uri | undefined> {
+    return findExistingSettingsFileLocation(undefined, isUpdatable).then((path) => path || getDefaultWorkspaceConfigLocation());
 }
 
 export function loadTheSettingsFile(): Promise<SettingsInfo | undefined> {
@@ -330,7 +332,7 @@ export async function updateSettingInConfig<K extends keyof CSpellUserSettings>(
     const orig = config.findScopedSettingFromVSConfig(section, scope);
     const uri = (config.isConfigTargetWithOptionalResource(target) && target.uri) || undefined;
     const settingsFilename =
-        (updateCSpell && !config.isGlobalLevelTarget(target) && (await findExistingSettingsFileLocation(uri))) || undefined;
+        (updateCSpell && !config.isGlobalLevelTarget(target) && (await findExistingSettingsFileLocation(uri, true))) || undefined;
 
     async function updateConfig(): Promise<false | Result> {
         if (create || (orig.value !== undefined && orig.scope === config.extractScope(scope))) {
@@ -381,7 +383,7 @@ export async function determineSettingsPaths(target: config.ConfigTarget, docUri
     }
 
     if (config.isWorkspaceLevelTarget(target)) {
-        const files = await findSettingsFiles();
+        const files = await findSettingsFiles(undefined, true);
         const cfgFileSet = new Set(docConfigFiles?.map((u) => u.toString()) || []);
         const filtered = cfgFileSet.size ? files.filter((u) => cfgFileSet.has(u.toString())) : files;
         const found = filtered.length ? filtered : docConfigFiles?.slice(0, 1) || [];
@@ -393,7 +395,7 @@ export async function determineSettingsPaths(target: config.ConfigTarget, docUri
     }
 
     const useUri = docUri || undefined;
-    const path = await findExistingSettingsFileLocation(useUri);
+    const path = await findExistingSettingsFileLocation(useUri, true);
     return path ? [path] : [];
 }