fix: Use VS Code file watcher for config file changes. (#1579)

Related to #1572

packages/client/package.json

@@ -46,7 +46,6 @@
     "jest-when": "^3.4.2",
     "kefir": "^3.8.8",
     "lorem-ipsum": "^2.0.4",
-    "node-watch": "^0.7.2",
     "rfdc": "^1.3.0",
     "rimraf": "^3.0.2",
     "server": "^2.0.0-alpha.1",

packages/client/src/extension.ts

@@ -39,12 +39,21 @@ export async function activate(context: ExtensionContext): Promise<ExtensionApi>
         setTimeout(() => silenceErrors(client.triggerSettingsRefresh(), 'triggerGetSettings'), delayInMs);
     }
 
+    function triggerConfigChange() {
+        triggerGetSettings();
+    }
+
     initStatusBar(context, client);
 
+    const configWatcher = vscode.workspace.createFileSystemWatcher(settings.configFileLocationGlob);
+
     // Push the disposable to the context's subscriptions so that the
     // client can be deactivated on extension deactivation
     context.subscriptions.push(
-        settings.watchSettingsFiles(triggerGetSettings),
+        configWatcher,
+        configWatcher.onDidChange(triggerConfigChange),
+        configWatcher.onDidCreate(triggerConfigChange),
+        configWatcher.onDidDelete(triggerConfigChange),
         vscode.workspace.onDidSaveTextDocument(handleOnDidSaveTextDocument),
         vscode.workspace.onDidRenameFiles(handleRenameFile),
         vscode.workspace.onDidDeleteFiles(handleDeleteFile),

packages/client/src/settings/CSpellSettings.ts

@@ -34,6 +34,8 @@ export const configFileLocations = [
     'cspell.config.cjs',
 ] as const;
 
+export const configFileLocationGlob = `**/{${configFileLocations.join(',')}}`;
+
 type ConfigFileNames = typeof configFileLocations[number];
 
 export const nestedConfigLocations = ['package.json'];

packages/client/src/settings/index.ts

@@ -1,5 +1,5 @@
 export { ConfigFields } from './configFields';
-export { configFilesToWatch, CSpellSettings } from './CSpellSettings';
+export { configFileLocationGlob, configFilesToWatch, CSpellSettings } from './CSpellSettings';
 export {
     addIgnoreWordsToSettings,
     ConfigTargetLegacy,
@@ -11,7 +11,6 @@ export {
     setEnableSpellChecking,
     TargetsAndScopes,
     toggleEnableSpellChecker,
-    watchSettingsFiles,
 } from './settings';
 export {
     ConfigurationTarget,

packages/client/src/settings/settings.ts

@@ -1,48 +1,21 @@
 import { CSpellSettings } from '@cspell/cspell-types';
-import * as fs from 'fs-extra';
-import * as path from 'path';
 import * as vscode from 'vscode';
 import { Uri, workspace } from 'vscode';
 import { CSpellUserSettings } from '../client';
-import { isDefined, unique } from '../util';
-import * as watcher from '../util/watcher';
+import { unique } from '../util';
 import { ClientConfigTarget } from './clientConfigTarget';
 import { readConfigFile, writeConfigFile } from './configFileReadWrite';
-import { configFileLocations, isUpdateSupportedForConfigFileFormat, normalizeWords, preferredConfigFiles } from './CSpellSettings';
+import { normalizeWords, preferredConfigFiles } from './CSpellSettings';
 import { setConfigFieldQuickPick } from './settings.base';
 
 export { setEnableSpellChecking, toggleEnableSpellChecker } from './settings.enable';
 export { enableLocaleForTarget } from './settings.locale';
+export type { TargetsAndScopes } from './settings.types';
 export { ConfigTargetLegacy, InspectScope, Scope } from './vsConfig';
 export interface SettingsInfo {
     path: Uri;
     settings: CSpellUserSettings;
 }
-export type { TargetsAndScopes } from './settings.types';
-
-export function watchSettingsFiles(callback: () => void): vscode.Disposable {
-    // Every 10 seconds see if we have new files to watch.
-    let busy = false;
-    const intervalObj = setInterval(async () => {
-        if (busy) {
-            return;
-        }
-        busy = true;
-        const settingsFiles = await findSettingsFiles();
-        settingsFiles
-            .map((uri) => uri.fsPath)
-            .filter((file) => !watcher.isWatching(file))
-            .forEach((file) => watcher.add(file, callback));
-        busy = false;
-    }, 10000);
-
-    return vscode.Disposable.from({
-        dispose: () => {
-            watcher.dispose();
-            clearInterval(intervalObj);
-        },
-    });
-}
 
 function getDefaultWorkspaceConfigLocation(docUri?: Uri): vscode.WorkspaceFolder | undefined {
     const defaultFolderUri = docUri && vscode.workspace.getWorkspaceFolder(docUri);
@@ -53,34 +26,6 @@ export function hasWorkspaceLocation(): boolean {
     return !!workspace.workspaceFile || !!workspace.workspaceFolders?.[0];
 }
 
-/**
- * Returns a list of files in the order of Best to Worst Match.
- * @param docUri
- */
-function findSettingsFiles(docUri?: Uri, isUpdatable?: boolean): Promise<Uri[]> {
-    const { workspaceFolders } = workspace;
-    if (!workspaceFolders || !hasWorkspaceLocation()) {
-        return Promise.resolve([]);
-    }
-
-    const folders = docUri ? [workspace.getWorkspaceFolder(docUri)].filter(isDefined).concat(workspaceFolders) : workspaceFolders;
-
-    const possibleLocations = folders
-        .map((folder) => folder.uri.fsPath)
-        .map((root) => configFileLocations.map((rel) => path.join(root, rel)))
-        .reduce((a, b) => a.concat(b), []);
-
-    const found = possibleLocations.map(async (filename) => ({ filename, exists: await fs.pathExists(filename) }));
-
-    return Promise.all(found).then((found) =>
-        found
-            .filter((found) => found.exists)
-            .map((found) => found.filename)
-            .map((filename) => Uri.file(filename))
-            .filter((uri) => !isUpdatable || isUpdateSupportedForConfigFileFormat(uri))
-    );
-}
-
 /**
  * @description Enable a programming language
  * @param target - which level of setting to set