fix: bug Modified to trigger runServer when .black configuration file is updated #569

src/common/utilities.ts

@@ -3,10 +3,11 @@
 
 import * as fs from 'fs-extra';
 import * as path from 'path';
-import { ConfigurationScope, env, LogLevel, Uri, WorkspaceFolder } from 'vscode';
+import { ConfigurationScope, env, LogLevel, Uri, WorkspaceFolder, Disposable, RelativePattern,FileSystemWatcher, workspace } from 'vscode';
 import { Trace, TraceValues } from 'vscode-jsonrpc/node';
 import { getConfiguration, getWorkspaceFolders, isVirtualWorkspace } from './vscodeapi';
 import { DocumentSelector } from 'vscode-languageclient';
+import { traceLog, traceInfo } from './logging';
 
 function logLevelToTrace(logLevel: LogLevel): Trace {
     switch (logLevel) {
@@ -82,3 +83,38 @@ export function getInterpreterFromSetting(namespace: string, scope?: Configurati
     const config = getConfiguration(namespace, scope);
     return config.get<string[]>('interpreter');
 }
+
+export function createConfigFileWatcher(onConfigChanged: () => Promise<void>): Disposable {
+    const watchers: FileSystemWatcher[] = [];
+
+    const homeDir = process.env.HOME || process.env.USERPROFILE;
+    if (homeDir) {
+        watchConfigFile(path.join(homeDir, '.black'));
+    }
+
+    function watchConfigFile(filePath: string): void {
+        if (fs.existsSync(filePath)) {
+            const pattern = new RelativePattern(
+                path.dirname(filePath),
+                path.basename(filePath)
+            );
+
+            const watcher = workspace.createFileSystemWatcher(pattern);
+
+            watcher.onDidChange(async () => {
+                traceInfo(`Config file changed: ${filePath}`);
+                await onConfigChanged();
+            });
+
+            watchers.push(watcher);
+        }
+    }
+
+    return {
+        dispose: () => {
+            for (const watcher of watchers) {
+                watcher.dispose();
+            }
+        }
+    };
+}

src/extension.ts

@@ -15,13 +15,15 @@ import {
     logLegacySettings,
 } from './common/settings';
 import { loadServerDefaults } from './common/setup';
-import { getInterpreterFromSetting, getProjectRoot } from './common/utilities';
+import { getInterpreterFromSetting, getProjectRoot, createConfigFileWatcher } from './common/utilities';
 import { createOutputChannel, onDidChangeConfiguration, registerCommand } from './common/vscodeapi';
 import { registerEmptyFormatter } from './common/nullFormatter';
 import { registerLanguageStatusItem, updateStatus } from './common/status';
 import { LS_SERVER_RESTART_DELAY, PYTHON_VERSION } from './common/constants';
 
 let lsClient: LanguageClient | undefined;
+let configWatcherDisposable: vscode.Disposable | undefined;
+
 export async function activate(context: vscode.ExtensionContext): Promise<void> {
     // This is required to get server name and module. This should be
     // the first thing that we do in this extension.
@@ -69,7 +71,10 @@ export async function activate(context: vscode.ExtensionContext): Promise<void>
         }
     };
 
+    configWatcherDisposable = createConfigFileWatcher(runServer);
+
     context.subscriptions.push(
+        configWatcherDisposable,
         onDidChangePythonInterpreter(async () => {
             await runServer();
         }),
@@ -116,6 +121,9 @@ export async function activate(context: vscode.ExtensionContext): Promise<void>
 }
 
 export async function deactivate(): Promise<void> {
+    if (configWatcherDisposable) {
+        configWatcherDisposable.dispose();
+    }
     if (lsClient) {
         await lsClient.stop();
     }