adding pyocd executable to PATH variable

Author: omarArm

src/desktop/add-to-path.ts

@@ -0,0 +1,43 @@
+/**
+ * Copyright 2025 Arm Limited
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+
+import * as vscode from 'vscode';
+import { BuiltinToolPath } from './builtin-tool-path';
+import * as os from 'os';
+
+const isWindows = os.platform() === 'win32';
+const PYOCD_BUILTIN_PATH = 'tools/pyocd/';
+
+export function addPyOCDtoPATH(context: vscode.ExtensionContext): void {
+    //get pyOCD path from tools folder
+    const builtinPyocd = new BuiltinToolPath(PYOCD_BUILTIN_PATH);
+    const pathPyOCD = builtinPyocd.getAbsolutePath()?.toString();
+    //get PATH variable
+    const path = process.env.PATH;
+    //slice unwanted characters from pyOCD path, take care of the Windows case
+    let slicedPyOCDpath;
+    if(isWindows) {
+        slicedPyOCDpath = pathPyOCD?.slice(7, pathPyOCD.length - 4);
+    } else {
+        slicedPyOCDpath = pathPyOCD?.slice(7);
+    }
+
+    //add pyOCD path to PATH, set at the beginning so that it gets called before pyOCD installed on the system
+    const updatepath = slicedPyOCDpath + ':' + path;
+    //add updated path to PATH variable, but only for the terminal inside of vscode
+    context.environmentVariableCollection.replace('PATH', updatepath);
+}

src/desktop/extension.ts

@@ -18,11 +18,13 @@ import * as vscode from 'vscode';
 import { GDBTargetDebugTracker } from '../debug-configuration/gdbtarget-debug-tracker';
 import { GDBTargetConfigurationProvider } from '../debug-configuration';
 import { logger } from '../logger';
+import { addPyOCDtoPATH } from './add-to-path';
 
 export const activate = async (context: vscode.ExtensionContext): Promise<void> => {
     const gdbtargetDebugTracker = new GDBTargetDebugTracker();
     const gdbtargetConfigurationProvider = new GDBTargetConfigurationProvider();
 
+    addPyOCDtoPATH(context);
     // Activate components
     gdbtargetDebugTracker.activate(context);
     gdbtargetConfigurationProvider.activate(context);