Factorize handling of environment variables

Author: eliericha

integration/vscode/ada/src/extension.ts

@@ -15,6 +15,7 @@
 -- of the license.                                                          --
 ----------------------------------------------------------------------------*/
 
+import * as process from 'process';
 import * as vscode from 'vscode';
 import {
     Disposable,
@@ -25,14 +26,10 @@ import {
     ServerOptions,
     SymbolKind,
 } from 'vscode-languageclient/node';
-import { platform } from 'os';
-import * as process from 'process';
-import GnatTaskProvider from './gnatTaskProvider';
-import GprTaskProvider from './gprTaskProvider';
-import { getEnclosingSymbol } from './gnatTaskProvider';
 import { alsCommandExecutor } from './alsExecuteCommand';
-import { ALSClientFeatures } from './alsClientFeatures';
-import { substituteVariables } from './helpers';
+import GnatTaskProvider, { getEnclosingSymbol } from './gnatTaskProvider';
+import GprTaskProvider from './gprTaskProvider';
+import { getEvaluatedCustomEnv } from './helpers';
 
 export let contextClients: ContextClients;
 export let mainLogChannel: vscode.OutputChannel;
@@ -181,29 +178,11 @@ function createClient(
     // Retrieve the user's custom environment variables if specified in their
     // settings/workspace: we'll then launch any child process with this custom
     // environment
-    const user_platform = platform();
-    let env_config_name = 'terminal.integrated.env.linux';
-
-    switch (user_platform) {
-        case 'darwin':
-            env_config_name = 'terminal.integrated.env.osx';
-            break;
-        case 'win32':
-            env_config_name = 'terminal.integrated.env.windows';
-            break;
-        default:
-            env_config_name = 'terminal.integrated.env.linux';
-    }
-
-    const custom_env = vscode.workspace.getConfiguration().get<[string]>(env_config_name);
+    const custom_env = getEvaluatedCustomEnv();
 
     if (custom_env) {
         for (const var_name in custom_env) {
-            let var_value: string = custom_env[var_name];
-
-            // Substitute VS Code variable references that might be present
-            // in the JSON settings configuration (e.g: "PATH": "${workspaceFolder}/obj")
-            var_value = var_value.replace(/(\$\{.*\})/, substituteVariables);
+            const var_value: string = custom_env[var_name];
             process.env[var_name] = var_value;
         }
     }
@@ -243,42 +222,44 @@ function createClient(
 async function addSupbrogramBox() {
     const activeEditor = vscode.window.activeTextEditor;
 
-    await getEnclosingSymbol(
-        activeEditor, [SymbolKind.Function, SymbolKind.Module]).then(async (symbol) => {
-        if (symbol !== null) {
-            const name: string = symbol.name ?? '';
-            const insertPos = new vscode.Position(symbol.range.start.line, 0);
-            const indentationRange = new vscode.Range(insertPos, symbol.range.start);
-            const indentation: string = activeEditor?.document.getText(indentationRange) ?? '';
-            const eol: string = activeEditor?.document.eol == vscode.EndOfLine.CRLF ? '\r\n' : '\n';
-
-            // Generate the subprogram box after retrieving the indentation of the line of
-            // the subprogram's body declaration.
-            const text: string =
-                indentation +
-                '---' +
-                '-'.repeat(name.length) +
-                '---' +
-                eol +
-                indentation +
-                '-- ' +
-                name +
-                ' --' +
-                eol +
-                indentation +
-                '---' +
-                '-'.repeat(name.length) +
-                '---' +
-                eol +
-                eol;
-
-            if (activeEditor) {
-                await activeEditor.edit((editBuilder) => {
-                    editBuilder.insert(insertPos, text);
-                });
+    await getEnclosingSymbol(activeEditor, [SymbolKind.Function, SymbolKind.Module]).then(
+        async (symbol) => {
+            if (symbol !== null) {
+                const name: string = symbol.name ?? '';
+                const insertPos = new vscode.Position(symbol.range.start.line, 0);
+                const indentationRange = new vscode.Range(insertPos, symbol.range.start);
+                const indentation: string = activeEditor?.document.getText(indentationRange) ?? '';
+                const eol: string =
+                    activeEditor?.document.eol == vscode.EndOfLine.CRLF ? '\r\n' : '\n';
+
+                // Generate the subprogram box after retrieving the indentation of the line of
+                // the subprogram's body declaration.
+                const text: string =
+                    indentation +
+                    '---' +
+                    '-'.repeat(name.length) +
+                    '---' +
+                    eol +
+                    indentation +
+                    '-- ' +
+                    name +
+                    ' --' +
+                    eol +
+                    indentation +
+                    '---' +
+                    '-'.repeat(name.length) +
+                    '---' +
+                    eol +
+                    eol;
+
+                if (activeEditor) {
+                    await activeEditor.edit((editBuilder) => {
+                        editBuilder.insert(insertPos, text);
+                    });
+                }
             }
         }
-    });
+    );
 }
 
 type ALSSourceDirDescription = {

integration/vscode/ada/src/helpers.ts

@@ -14,18 +14,21 @@
 -- COPYING3.  If not, go to http://www.gnu.org/licenses for a complete copy --
 -- of the license.                                                          --
 ----------------------------------------------------------------------------*/
-import * as vscode from 'vscode';
+import { platform } from 'os';
 import * as path from 'path';
+import * as vscode from 'vscode';
 
 /**
  * Substitue any variable reference present in the given string. VS Code
  * variable references are listed here:
  * https://code.visualstudio.com/docs/editor/variables-reference
- * @param str
- * @param recursive
- * @returns
+ * @param str - string to perform substitution on
+ * @param recursive - whether to perform substitution recursively on the result
+ * of each substitution until there are no variables to substitute.
+ *
+ * @returns string after applying substitutions
  */
-export function substituteVariables(str: string, recursive = false) {
+export function substituteVariables(str: string, recursive = false): string {
     const workspaces = vscode.workspace.workspaceFolders ?? [];
     const workspace = workspaces.length ? workspaces[0] : null;
     const activeEditor = vscode.window.activeTextEditor;
@@ -81,20 +84,59 @@ export function substituteVariables(str: string, recursive = false) {
     }
 
     str = str.replace(/\${env:(.*?)}/g, function (variable) {
+        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
         return process.env[variable.match(/\${env:(.*?)}/)![1]] || '';
     });
 
     str = str.replace(/\${config:(.*?)}/g, function (variable) {
+        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
         return vscode.workspace.getConfiguration().get(variable.match(/\${config:(.*?)}/)![1], '');
     });
 
     if (
         recursive &&
         str.match(
+            // eslint-disable-next-line max-len
             /\${(workspaceFolder|workspaceFolderBasename|fileWorkspaceFolder|relativeFile|fileBasename|fileBasenameNoExtension|fileExtname|fileDirname|cwd|pathSeparator|lineNumber|selectedText|env:(.*?)|config:(.*?))}/
         )
     ) {
         str = substituteVariables(str, recursive);
     }
     return str;
 }
+
+export function getCustomEnv() {
+    const user_platform = platform();
+    let env_config_name = 'terminal.integrated.env';
+
+    switch (user_platform) {
+        case 'darwin':
+            env_config_name += '.osx';
+            break;
+        case 'win32':
+            env_config_name += '.windows';
+            break;
+        default:
+            env_config_name += '.linux';
+    }
+
+    const custom_env = vscode.workspace.getConfiguration().get<[string]>(env_config_name);
+
+    return custom_env;
+}
+
+export function getEvaluatedCustomEnv() {
+    const custom_env = getCustomEnv();
+
+    if (custom_env) {
+        for (const var_name in custom_env) {
+            // Substitute VS Code variable references that might be present
+            // in the JSON settings configuration (e.g: "PATH": "${workspaceFolder}/obj")
+            custom_env[var_name] = custom_env[var_name].replace(/(\$\{.*\})/, (substring) =>
+                substituteVariables(substring, false)
+            );
+        }
+    }
+
+    return custom_env;
+}