Skip to content

Commit 91fdb0b

Browse files
committed
fix errors
1 parent 6517125 commit 91fdb0b

File tree

3 files changed

+21
-3
lines changed

3 files changed

+21
-3
lines changed

docs_espressif/en/installation.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ After installing Visual Studio Code (VS Code), install the ESP-IDF extension for
1515

1616
- Navigate to ``View`` > ``Command Palette``.
1717

18-
- Type ``ESP-IDF: Open ESP-IDF Install Manager`` to download and run the ESP-IDF install manager to install. A loading notification will appear, followed by the execution of the installer.
18+
- Type ``ESP-IDF: Open ESP-IDF Install Manager`` to download and run the ESP-IDF install manager to install the ESP-IDF framework. A loading notification will appear, followed by the execution of the installer.
1919

2020
.. note::
2121

@@ -26,7 +26,7 @@ After installing Visual Studio Code (VS Code), install the ESP-IDF extension for
2626
- ``Espressif``: Faster speed in China using Espressif download servers.
2727
- ``Github``: Using GitHub release links.
2828

29-
3. Use the ESP-IDF Install Manager to install the ESP-IDF and tools. If necessary, here is the `ESP-IDF Install Manager Documentation <https://docs.espressif.com/projects/idf-im-ui/en/latest/general_info.html`_.
29+
3. Use the ESP-IDF Install Manager to install the ESP-IDF and tools. If necessary, here is the `ESP-IDF Install Manager Documentation <https://docs.espressif.com/projects/idf-im-ui/en/latest/general_info.html>`_.
3030

3131
4. In Visual Studio Code, navigate to ``View`` > ``Command Palette`` and type ``select current esp-idf version`` and select **ESP-IDF: Select Current ESP-IDF Version** from the list.
3232
The list of available ESP-IDF setups will be shown, select which one you want to use for the current ESP-IDF project.

src/common/prepareEnv.ts

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,25 @@ import { delimiter, dirname, join } from "path";
2323
import { getIdfTargetFromSdkconfig } from "../workspaceConfig";
2424
import { ESP } from "../config";
2525

26+
/**
27+
* Configures and prepares environment variables necessary for executing ESP-IDF tasks.
28+
*
29+
* Merges environment variables from the current process (`process.env`),
30+
* stored project configuration, and relevant VS Code settings (e.g., `idf.customExtraVars`,
31+
* `idf.gitPath`, `idf.sdkconfigFilePath`, `idf.enableIdfComponentManager`).
32+
*
33+
* Key actions include:
34+
* - Setting default `IDF_PATH` and `IDF_TOOLS_PATH` if not already defined.
35+
* - Prepending required toolchain, Python virtual environment, IDF Tools, Git
36+
* and component directories to the system `PATH`.
37+
* - Determining and setting `IDF_TARGET` based on the workspace's sdkconfig.
38+
* - Setting the `IDF_COMPONENT_MANAGER` flag and `SDKCONFIG` path based on settings.
39+
*
40+
* @async
41+
* @param {Uri} curWorkspace - The Uri of the current workspace, used to access settings and sdkconfig.
42+
* @returns {Promise<{[key: string]: string}>} A promise resolving to the configured
43+
* environment variables object, ready for use in ESP-IDF tasks.
44+
*/
2645
export async function configureEnvVariables(
2746
curWorkspace: Uri
2847
): Promise<{ [key: string]: string }> {

src/test/doctor.test.ts

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,6 @@ suite("Doctor Command tests", () => {
8686
test("Wrong version of ESP-IDF", async () => {
8787
reportObj.configurationSettings.espIdfPath = "/some/non-existing-path";
8888
await getEspIdfVersion(reportObj);
89-
console.log(reportObj.latestError);
9089
assert.equal(reportObj.espIdfVersion.result, "x.x");
9190
});
9291

0 commit comments

Comments
 (0)