chore: auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci
ansible · Nov 4, 2023 · 5b8c7a9 · 5b8c7a9
1 parent 21a855d
commit 5b8c7a9
Show file tree

Hide file tree

Showing 5 changed files with 84 additions and 73 deletions.
diff --git a/package.json b/package.json
@@ -720,7 +720,10 @@
           "attach": {
             "properties": {
               "processId": {
-                "type": ["string", "number"],
+                "type": [
+                  "string",
+                  "number"
+                ],
                 "description": "The process id of the ansible-playbook process to attach to.",
                 "default": "${command:PickAnsibleProcess}"
               },

diff --git a/src/extension.ts b/src/extension.ts
@@ -225,8 +225,10 @@ export async function activate(context: ExtensionContext): Promise<void> {
   );
 
   context.subscriptions.push(
-    vscode.debug.registerDebugConfigurationProvider("ansible",
-      new AnsibleDebugConfigurationProvider())
+    vscode.debug.registerDebugConfigurationProvider(
+      "ansible",
+      new AnsibleDebugConfigurationProvider()
+    )
   );
 
   context.subscriptions.push(

diff --git a/src/features/debugger.ts b/src/features/debugger.ts
@@ -11,8 +11,7 @@ export namespace DebuggerCommands {
 }
 
 export class DebuggerManager {
-  constructor() {
-  }
+  constructor() {}
 
   /**
    * Prompt the user for a playbook filename.
@@ -22,7 +21,7 @@ export class DebuggerManager {
     return vscode.window.showInputBox({
       title: "Enter Ansible Playbook File",
       placeHolder: "Enter the name of the playbook file to debug.",
-    })
+    });
   }
 
   /**
@@ -33,9 +32,9 @@ export class DebuggerManager {
     // See get_pid_info_path() in ansibug
     const tmpDir = process.env.TMPDIR || "/tmp";
 
-    const playbookProcesses: {label: string, description: string}[] = [];
-    for (let procFile of glob.globIterateSync(`${tmpDir}/ANSIBUG-*`)) {
-      let procInfoRaw = fs.readFileSync(procFile, 'utf8');
+    const playbookProcesses: { label: string; description: string }[] = [];
+    for (const procFile of glob.globIterateSync(`${tmpDir}/ANSIBUG-*`)) {
+      const procInfoRaw = fs.readFileSync(procFile, "utf8");
       var procInfo;
       try {
         procInfo = JSON.parse(procInfoRaw);
@@ -44,47 +43,48 @@ export class DebuggerManager {
       }
 
       if (procInfo.pid && this.isAlive(procInfo.pid)) {
-        playbookProcesses.push(
-          { label: procInfo.pid.toString(), description: procInfo.playbook_file || "Unknown playbook" }
-        );
+        playbookProcesses.push({
+          label: procInfo.pid.toString(),
+          description: procInfo.playbook_file || "Unknown playbook",
+        });
       }
     }
 
     if (playbookProcesses.length == 0) {
-      return vscode.window.showInformationMessage(
-        "Cannot find an available ansible-playbook process to debug"
-      ).then(_ => {
-        return undefined; // abort
-      });
+      return vscode.window
+        .showInformationMessage(
+          "Cannot find an available ansible-playbook process to debug"
+        )
+        .then((_) => {
+          return undefined; // abort
+        });
     }
 
-    return vscode.window.showQuickPick(
-      playbookProcesses,
-      {
-        canPickMany: false
-      }
-    ).then((v) => v?.label);
+    return vscode.window
+      .showQuickPick(playbookProcesses, {
+        canPickMany: false,
+      })
+      .then((v) => v?.label);
   }
 
-  private isAlive(
-    pid: number
-  ): boolean {
-      try {
-        // Signal of 0 checks if the process exists or not.
-        return process.kill(pid, 0);
-      } catch {
-        return false;
-      }
+  private isAlive(pid: number): boolean {
+    try {
+      // Signal of 0 checks if the process exists or not.
+      return process.kill(pid, 0);
+    } catch {
+      return false;
+    }
   }
 }
 
-export class AnsibleDebugConfigurationProvider implements vscode.DebugConfigurationProvider {
-
+export class AnsibleDebugConfigurationProvider
+  implements vscode.DebugConfigurationProvider
+{
   /**
    * Massage a debug configuration just before a debug session is being
    * launched. This is used to provide the default debug launch configuration
    * that launches the current file.
-  */
+   */
   resolveDebugConfiguration(
     folder: vscode.WorkspaceFolder | undefined,
     config: vscode.DebugConfiguration,
@@ -96,13 +96,16 @@ export class AnsibleDebugConfigurationProvider implements vscode.DebugConfigurat
 
       // Both ansible and yaml is used incase the file hasn't been explicitly
       // marked as ansible and is just yaml.
-      if (editor && editor.document.languageId === 'ansible' || editor?.document.languageId === 'yaml') {
+      if (
+        (editor && editor.document.languageId === "ansible") ||
+        editor?.document.languageId === "yaml"
+      ) {
         config = {
           request: "launch",
           type: "ansible",
           name: "Ansible: Run Current Playbook File",
           playbook: "${file}",
-        }
+        };
       }
     }
 
@@ -120,26 +123,26 @@ export class AnsibleDebugConfigurationProvider implements vscode.DebugConfigurat
  * @returns The debug adapter executable.
  */
 export function createAnsibleDebugAdapter(
-    settings: ExtensionSettings
+  settings: ExtensionSettings
 ): vscode.DebugAdapterExecutable {
-    const ansibugArgs = ["dap"];
-    if (settings.debugger.logFile) {
-      ansibugArgs.push(
-        "--log-file",
-        settings.debugger.logFile,
-        "--log-level",
-        settings.debugger.logLevel,
-      );
-    }
-
-    // FUTURE: inject PYTHONPATH with embedded ansibug module
-    const [command, commandArgs, newEnv] = withPythonModule(
-        settings,
-        "ansibug",
-        ansibugArgs
+  const ansibugArgs = ["dap"];
+  if (settings.debugger.logFile) {
+    ansibugArgs.push(
+      "--log-file",
+      settings.debugger.logFile,
+      "--log-level",
+      settings.debugger.logLevel
     );
-    const dapOptions: vscode.DebugAdapterExecutableOptions = {
-        env: newEnv
-    };
-    return new vscode.DebugAdapterExecutable(command, commandArgs, dapOptions);
   }
+
+  // FUTURE: inject PYTHONPATH with embedded ansibug module
+  const [command, commandArgs, newEnv] = withPythonModule(
+    settings,
+    "ansibug",
+    ansibugArgs
+  );
+  const dapOptions: vscode.DebugAdapterExecutableOptions = {
+    env: newEnv,
+  };
+  return new vscode.DebugAdapterExecutable(command, commandArgs, dapOptions);
+}
diff --git a/src/features/utils/commandRunner.ts b/src/features/utils/commandRunner.ts
@@ -28,7 +28,11 @@ export function withInterpreter(
 
   const activationScript = settings.activationScript;
   if (activationScript) {
-    const [command, shellArgs] = wrapWithActivationScript(activationScript, runExecutable, cmdArgs);
+    const [command, shellArgs] = wrapWithActivationScript(
+      activationScript,
+      runExecutable,
+      cmdArgs
+    );
     return [`${command} ${shellArgs.join(" ")}`, undefined];
   }
 
@@ -41,7 +45,7 @@ export function withInterpreter(
 
     // emulating virtual environment activation script
     const venvVars = buildPythonVirtualEnvVars(interpreterPath);
-    for (let key in venvVars) {
+    for (const key in venvVars) {
       newEnv[key] = venvVars[key];
     }
     delete newEnv.PYTHONHOME;
@@ -60,14 +64,14 @@ export function withPythonModule(
   settings: ExtensionSettings,
   module: string,
   moduleArgs: string[]
-): [string, string[], {[key: string]: string}] {
+): [string, string[], { [key: string]: string }] {
   let command: string = "python";
 
   let commandArgs: string[] = ["-m", module];
   commandArgs.push(...moduleArgs);
 
-  const newEnv: {[key: string]: string} = {};
-  for (let e in process.env) {
+  const newEnv: { [key: string]: string } = {};
+  for (const e in process.env) {
     newEnv[e] = process.env[e] ?? "";
   }
 
@@ -79,10 +83,9 @@ export function withPythonModule(
       command,
       commandArgs.join(" ")
     );
-  }
-  else if (interpreterPath) {
+  } else if (interpreterPath) {
     const venvVars = buildPythonVirtualEnvVars(interpreterPath);
-    for (let key in venvVars) {
+    for (const key in venvVars) {
       newEnv[key] = venvVars[key];
     }
     delete newEnv.PYTHONHOME;
@@ -104,11 +107,11 @@ export function withPythonModule(
 function wrapWithActivationScript(
   activationScript: string,
   executable: string,
-  cmdArgs: string,
+  cmdArgs: string
 ): [string, string[]] {
   return [
     "bash",
-    ["-c", `source ${activationScript} && ${executable} ${cmdArgs}`]
+    ["-c", `source ${activationScript} && ${executable} ${cmdArgs}`],
   ];
 }
 
@@ -118,14 +121,14 @@ function wrapWithActivationScript(
  * @param interpreterPath The Python interpreter path.
  * @returns The env vars that need to be set to run in the venv.
  */
-function buildPythonVirtualEnvVars(
-  interpreterPath: string,
-): { [key: string]: string } {
+function buildPythonVirtualEnvVars(interpreterPath: string): {
+  [key: string]: string;
+} {
   const virtualEnv = path.resolve(interpreterPath, "../..");
   const pathEntry = path.join(virtualEnv, "bin");
 
   return {
     VIRTUAL_ENV: virtualEnv,
-    PATH: `${pathEntry}${path.delimiter}${process.env.PATH}`
+    PATH: `${pathEntry}${path.delimiter}${process.env.PATH}`,
   };
-}
+}
diff --git a/src/interfaces/extensionSettings.ts b/src/interfaces/extensionSettings.ts
@@ -35,4 +35,4 @@ export interface LightSpeedServiceSettings {
 export interface DebuggerSettings {
   logFile: string | null;
   logLevel: string;
-}
+}