Drop legacy settings support (#339)

Author: karthiknadig

src/common/settings.ts

@@ -43,34 +43,6 @@ function resolveVariables(value: string[], workspace?: WorkspaceFolder): string[
     });
 }
 
-function getArgs(namespace: string, workspace: WorkspaceFolder): string[] {
-    const config = getConfiguration(namespace, workspace.uri);
-    const args = config.get<string[]>('args', []);
-
-    if (args.length > 0) {
-        return args;
-    }
-
-    const legacyConfig = getConfiguration('python', workspace.uri);
-    return legacyConfig.get<string[]>('formatting.blackArgs', []);
-}
-
-function getPath(namespace: string, workspace: WorkspaceFolder): string[] {
-    const config = getConfiguration(namespace, workspace.uri);
-    const path = config.get<string[]>('path', []);
-
-    if (path.length > 0) {
-        return path;
-    }
-
-    const legacyConfig = getConfiguration('python', workspace.uri);
-    const legacyPath = legacyConfig.get<string>('formatting.blackPath', '');
-    if (legacyPath.length > 0 && legacyPath !== 'black') {
-        return [legacyPath];
-    }
-    return [];
-}
-
 export function getInterpreterFromSetting(namespace: string, scope?: ConfigurationScope) {
     const config = getConfiguration(namespace, scope);
     return config.get<string[]>('interpreter');
@@ -105,13 +77,11 @@ export async function getWorkspaceSettings(
         }
     }
 
-    const args = getArgs(namespace, workspace);
-    const path = getPath(namespace, workspace);
     const workspaceSetting = {
         cwd: workspace.uri.fsPath,
         workspace: workspace.uri.toString(),
-        args: resolveVariables(args, workspace),
-        path: resolveVariables(path, workspace),
+        args: resolveVariables(config.get<string[]>('args', []), workspace),
+        path: resolveVariables(config.get<string[]>('path', []), workspace),
         interpreter: resolveVariables(interpreter, workspace),
         importStrategy: config.get<string>('importStrategy', 'fromEnvironment'),
         showNotifications: config.get<string>('showNotifications', 'off'),
@@ -177,3 +147,26 @@ export function logDefaultFormatter(): void {
         }
     });
 }
+
+export function logLegacySettings(): void {
+    getWorkspaceFolders().forEach((workspace) => {
+        try {
+            const legacyConfig = getConfiguration('python', workspace.uri);
+            const legacyArgs = legacyConfig.get<string[]>('formatting.blackArgs', []);
+            const legacyPath = legacyConfig.get<string>('formatting.blackPath', '');
+            if (legacyArgs.length > 0) {
+                traceWarn(`"python.formatting.blackArgs" is deprecated. Use "black-formatter.args" instead.`);
+                traceWarn(`"python.formatting.blackArgs" for workspace ${workspace.uri.fsPath}:`);
+                traceWarn(`\n${JSON.stringify(legacyArgs, null, 4)}`);
+            }
+
+            if (legacyPath.length > 0 && legacyPath !== 'black') {
+                traceWarn(`"python.formatting.blackPath" is deprecated. Use "black-formatter.path" instead.`);
+                traceWarn(`"python.formatting.blackPath" for workspace ${workspace.uri.fsPath}:`);
+                traceWarn(`\n${JSON.stringify(legacyPath, null, 4)}`);
+            }
+        } catch (err) {
+            traceWarn(`Error while logging legacy settings: ${err}`);
+        }
+    });
+}

src/extension.ts

@@ -13,6 +13,7 @@ import {
     getWorkspaceSettings,
     ISettings,
     logDefaultFormatter,
+    logLegacySettings,
 } from './common/settings';
 import { loadServerDefaults } from './common/setup';
 import { getProjectRoot } from './common/utilities';
@@ -72,10 +73,22 @@ export async function activate(context: vscode.ExtensionContext): Promise<void>
         registerLanguageStatusItem(serverId, serverName, `${serverId}.showLogs`),
     );
 
+    // This is needed to ensure that the formatter is registered before the
+    // language server is started. If the language server takes too long to start,
+    // and user triggers formatting, they can see a weird message that formatting
+    // although registered by extension it is not supported.
     registerEmptyFormatter();
 
+    // This is needed to inform users that they might have not set this extension
+    // as the formatter. Instructions are printed in the output channel on how to
+    // set it.
     logDefaultFormatter();
 
+    // This is needed to inform users that they might have some legacy settings that
+    // are no longer supported. Instructions are printed in the output channel on how
+    // to update them.
+    logLegacySettings();
+
     setImmediate(async () => {
         const interpreter = getInterpreterFromSetting(serverId);
         if (interpreter === undefined || interpreter.length === 0) {