Allow alterations to the $PATH in an environmentSetupScript to take effect before searching for the CMake executable

[bobbrow]

Discussed in #2299

Currently the extension searches for the CMake executable before environmentSetupScript is evaluated. In the event that the setup script alters the $PATH, those changes won't be in effect when looking for the CMake binary.

[wKavey]

+1 for this feature -- I use a python virtual environment to install my desired cmake version, and I'd either need to activate that virtual environment (preferred) or modify the path to point cmake-tools at the correct binary.

[EmilVogt]

+1, There's unfortunately no documentation on environmentSetupScript and I expected it to run before the first call to cmake.

[jfchenier]

I would not call this a clean solution, but this work for me on both Windows and Linux : I created a single script that can act both as batch and bash script. This script activate my virtual environment then call CMake.

.vsode/settings.json

  "cmake.cmakePath": "${workspaceFolder}/.vscode/run-cmake.cmd",

.vscode/run-cmake.cmd

:<<BATCH
    @echo off
    set SOURCE=%~dp0
    call %SOURCE%..\activate.bat
    @echo on
    call cmake %*
    @echo off
    exit /b
BATCH

SOURCE=$( realpath $( dirname -- "${BASH_SOURCE[0]}"; ); )
source $SOURCE/../activate.sh
cmake "$@"

[alan-wr]

@jfchenier
Thanks for you workaround.
But I still get problem.

Now
I create .vscode/run-cmake.cmd, just same as you and

linux-64 - ssh /buildarea/ashi/tmp_ws/z_cmake_failed_prj1/.vscode> /buildarea/ashi/tmp_ws/z_cmake_failed_prj1/.vscode/run-cmake.cmd
Usage

cmake [options]
cmake [options]
cmake [options] -S -B

Specify a source directory to (re-)generate a build system for it in the
current working directory. Specify an existing build directory to
re-generate its build system.

Run 'cmake --help' for more information.

linux-64 - ssh /buildarea/ashi/tmp_ws/z_cmake_failed_prj1/.vscode> ./run-cmake.cmd -version
cmake version 3.23.1

CMake suite maintained and supported by Kitware (kitware.com/cmake).

Seems fine now,
But still get error like

Bad CMake executable: "/buildarea/ashi/tmp_ws/z_cmake_failed_prj1/.vscode/run_cmake.cmd". Check to make sure it is installed or the value of the "cmake.cmakePath" setting contains the correct path

[alan-wr]

+1, It is better to support environmentSetupScript and then call to cmake.

[jfchenier]

@alan-wr

On some Linux distro, I had to add #!/bin/bash At the top of the run-cmake.cmd script. This cause an error message on Windows, but it can be ignored. Adding this might solve your issue.

[alan-wr]

@jfchenier

Typo error

run_cmake.cmd from ".vscode/setting.json"

And run-cmake.cmd from ".vscode/run-cmake.cmd" file.

"_" and "-".

Anyway, fine now.

Many Thanks.

[Pesc0]

Sorry @bobbrow, can I ask if there's currently any plan to support this feature?

[adrianinsaval]

From what I'm seeing I think this has to be modified to run environmentSetup script first:

vscode-cmake-tools/src/paths.ts

Line 228 in aa21395

async getCMakePath(wsc: DirectoryContext, overWriteCMakePathSetting?: string): Promise<string | null> {

for reference here's how it's done for the kits:

vscode-cmake-tools/src/kit.ts

Line 646 in aa21395

export async function getShellScriptEnvironment(kit: Kit, opts?: expand.ExpansionOptions): Promise<Environment | undefined> {

I don't know basically anything about typescript so I can't make a PR myself

[gcampbell-msft]

@Pesc0 @adrianinsaval and others, thanks for all of your comments. I am placing this on our backlog and we will work to prioritize this issue among our other bugs and requests. Thank you!

In the meantime, please up-vote this issue to let us know that it is important to you.

[Pesc0]

Thank you!