Skip to content

Commit 02e0850

Browse files
brianignacio5radurentea
brianignacio5
and
radurentea
authored
Add changelog for 1.9.0 release (#1348)
* Add changelog for 1.9.0 release * add flash monitor redirect in buildFlashMonitor command * add validation for getEnvVarsFromIdfTools * add IDF_PYTHON_ENV_PATH validation * Bugfix/walkthrough documentation (#1354) * Update post-installation step * Collapse all menus except commands * update activation init check settings remove extension settings await use showOnBoarding to show welcome page increase timeout of notifications increase notification timeout disable show info message on check extension setting fix lint rm console log * Use major + minor versions, remove patch version (#1360) * add cmd pwsh idf py autocomplete * add scripts to prettier ignore * update changelog * move scripts to root folder * add bypass execution policy for powershell windows --------- Co-authored-by: Radu <radu.rentea@gmail.com>
1 parent d6e300f commit 02e0850

9 files changed

+197
-98
lines changed

‎.prettierignore

+2-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,8 @@ espressif_icon.png
1313
get_serial_list.py
1414
.yarnrc
1515
*.vsix
16-
16+
export.ps1
17+
export.bat
1718

1819
#dirs
1920
.vscode

‎CHANGELOG.md

+38
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,44 @@
88

99
All notable changes to the "Espressif IDF" extension will be documented in this file.
1010

11+
## [1.9.0](https://github.com/espressif/vscode-esp-idf-extension/releases/tag/v1.9.0)
12+
13+
### Bug Fixes
14+
15+
- [Update to latest Espressif icon](https://github.com/espressif/vscode-esp-idf-extension/pull/1294)
16+
- [Use static monitor terminal instance](https://github.com/espressif/vscode-esp-idf-extension/pull/1289)
17+
- [Update create from project examples UI UX](https://github.com/espressif/vscode-esp-idf-extension/pull/1278)
18+
- [Fix display of monitor the device when flash fails](https://github.com/espressif/vscode-esp-idf-extension/pull/1286)
19+
- [Update recommended cp command](https://github.com/espressif/vscode-esp-idf-extension/pull/1269)
20+
- [Enhance telemetry reporting](https://github.com/espressif/vscode-esp-idf-extension/pull/1272)
21+
- [Make readme easy to follow](https://github.com/espressif/vscode-esp-idf-extension/pull/1295)
22+
- [Fix for pwsh users](https://github.com/espressif/vscode-esp-idf-extension/pull/1279)
23+
- [Fix PR comment remove build flash telemetry](https://github.com/espressif/vscode-esp-idf-extension/pull/1328)
24+
- [Fix duplicate output; Add notification for success](https://github.com/espressif/vscode-esp-idf-extension/pull/1290)
25+
- [Add validation for debug session status for monitor start with no reset flag](https://github.com/espressif/vscode-esp-idf-extension/pull/1270)
26+
- [Update dockerfile, add qemu executable options](https://github.com/espressif/vscode-esp-idf-extension/pull/1282)
27+
- [Add IDF_PATH and IDF_TOOLS_PATH to newly created project settings](https://github.com/espressif/vscode-esp-idf-extension/pull/1332)
28+
- [Fix unit tests not being refreshed](https://github.com/espressif/vscode-esp-idf-extension/pull/1338)
29+
- [Remove old documentation and update links](https://github.com/espressif/vscode-esp-idf-extension/pull/1342)
30+
- [walkthrough bugfixes](https://github.com/espressif/vscode-esp-idf-extension/pull/1354)
31+
- [Use only major minor version in espidf constraint file](https://github.com/espressif/vscode-esp-idf-extension/pull/1360)
32+
33+
### Features and enhancements
34+
35+
- [Add Espressif documentation](https://github.com/espressif/vscode-esp-idf-extension/pull/1291)
36+
- [Filter serial devices by default and allow user to disable chip id in serial port list](https://github.com/espressif/vscode-esp-idf-extension/pull/1276)
37+
- [Compute Python path from IDF_TOOLS_PATH and IDF_PATH](https://github.com/espressif/vscode-esp-idf-extension/pull/1263)
38+
- [Enable/Disable status bar icons in Commands Tree view](https://github.com/espressif/vscode-esp-idf-extension/pull/1314)
39+
- [Hoist linker (ld) errors to VS Code 'Problems' window](https://github.com/espressif/vscode-esp-idf-extension/pull/1317) Thanks @GillesZunino !
40+
- [Support for multiple sdkconfig file in Project configuration editor](https://github.com/espressif/vscode-esp-idf-extension/pull/1252)
41+
- [Disable cmds for Codespaces and redirect Flash monitor to Web extension](https://github.com/espressif/vscode-esp-idf-extension/pull/1297)
42+
- [Support new IDF Size json format](https://github.com/espressif/vscode-esp-idf-extension/pull/1330)
43+
- [Add check for missing compile_commands json](https://github.com/espressif/vscode-esp-idf-extension/pull/1271)
44+
- [Enhance flash encryption with eFuse validation and more user information](https://github.com/espressif/vscode-esp-idf-extension/pull/1247)
45+
- [Use idf_tools py export to get env variables](https://github.com/espressif/vscode-esp-idf-extension/pull/1343)
46+
- [Add chinese translation for readme](https://github.com/espressif/vscode-esp-idf-extension/pull/1335)
47+
- [Add extension walkthrough](https://github.com/espressif/vscode-esp-idf-extension/pull/1298)
48+
1149
## [1.8.1](https://github.com/espressif/vscode-esp-idf-extension/releases/tag/v1.8.1)
1250

1351
### Bug Fixes

‎export.bat

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
DOSKEY idf.py=python.exe "%IDF_PATH%\tools\idf.py" $*
2+
DOSKEY esptool.py=python.exe "%IDF_PATH%\components\esptool_py\esptool\esptool.py" $*
3+
DOSKEY espefuse.py=python.exe "%IDF_PATH%\components\esptool_py\esptool\espefuse.py" $*
4+
DOSKEY espsecure.py=python.exe "%IDF_PATH%\components\esptool_py\esptool\espsecure.py" $*
5+
DOSKEY otatool.py=python.exe "%IDF_PATH%\components\app_update\otatool.py" $*
6+
DOSKEY parttool.py=python.exe "%IDF_PATH%\components\partition_table\parttool.py" $*
7+
cls

‎export.ps1

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Define the Invoke-idfpy function
2+
function global:Invoke-idfpy {
3+
& python.exe `
4+
"$($env:IDF_PATH)\tools\idf.py" @args
5+
}
6+
7+
function global:esptool.py {
8+
& python.exe `
9+
"$($env:IDF_PATH)\components\esptool_py\esptool\esptool.py" @args
10+
}
11+
12+
function global:espefuse.py {
13+
& python.exe `
14+
"$($env:IDF_PATH)\components\esptool_py\esptool\espefuse.py" @args
15+
}
16+
17+
function global:espsecure.py {
18+
& python.exe `
19+
"$($env:IDF_PATH)\components\esptool_py\esptool\espsecure.py" @args
20+
}
21+
22+
function global:otatool.py {
23+
& python.exe `
24+
"$($env:IDF_PATH)\components\app_update\otatool.py" @args
25+
}
26+
27+
function global:parttool.py {
28+
& python.exe `
29+
"$($env:IDF_PATH)\components\partition_table\parttool.py" @args
30+
}
31+
32+
# Create an alias for the function
33+
New-Alias -Name idf.py -Value Invoke-idfpy -Force -Scope Global

‎src/checkExtensionSettings.ts

+75-81
Original file line numberDiff line numberDiff line change
@@ -16,27 +16,29 @@
1616
* limitations under the License.
1717
*/
1818
import * as vscode from "vscode";
19-
import {
20-
getSetupInitialValues,
21-
isCurrentInstallValid,
22-
} from "./setup/setupInit";
19+
import { isCurrentInstallValid } from "./setup/setupInit";
2320
import { Logger } from "./logger/logger";
24-
import { NotificationMode, readParameter } from "./idfConfiguration";
25-
import { useIdfSetupSettings } from "./setup/setupValidation/espIdfSetup";
21+
import { readParameter } from "./idfConfiguration";
22+
import {
23+
checkIdfSetup,
24+
useIdfSetupSettings,
25+
} from "./setup/setupValidation/espIdfSetup";
26+
import { getIdfMd5sum } from "./setup/espIdfJson";
27+
import { getEspIdfFromCMake } from "./utils";
28+
import { IdfSetup } from "./views/setup/types";
2629

2730
export async function checkExtensionSettings(
28-
extensionPath: string,
2931
workspace: vscode.Uri,
3032
espIdfStatusBar: vscode.StatusBarItem
3133
) {
32-
const showSetupWindow = readParameter("idf.showOnboardingOnInit") as boolean;
33-
if (!showSetupWindow) {
34-
return;
35-
}
34+
const showWelcomePage = readParameter(
35+
"idf.showOnboardingOnInit",
36+
workspace
37+
) as boolean;
3638
try {
3739
const isExtensionConfigured = await isCurrentInstallValid(workspace);
38-
if (isExtensionConfigured) {
39-
await vscode.commands.executeCommand("espIdf.welcome.start");
40+
if (showWelcomePage && isExtensionConfigured) {
41+
vscode.commands.executeCommand("espIdf.welcome.start");
4042
return;
4143
}
4244
} catch (error) {
@@ -45,73 +47,65 @@ export async function checkExtensionSettings(
4547
: "Checking if current install is valid throws an error.";
4648
Logger.error(msg, error, "checkExtensionSettings");
4749
}
48-
const notificationMode = readParameter(
49-
"idf.notificationMode",
50-
workspace
51-
) as string;
52-
const ProgressLocation =
53-
notificationMode === NotificationMode.All ||
54-
notificationMode === NotificationMode.Notifications
55-
? vscode.ProgressLocation.Notification
56-
: vscode.ProgressLocation.Window;
57-
await vscode.window.withProgress(
58-
{
59-
cancellable: false,
60-
location: ProgressLocation,
61-
title: "ESP-IDF: Loading initial configuration...",
62-
},
63-
async (
64-
progress: vscode.Progress<{ message: string; increment: number }>,
65-
cancelToken: vscode.CancellationToken
66-
) => {
67-
try {
68-
const setupArgs = await getSetupInitialValues(
69-
extensionPath,
70-
progress,
71-
workspace
72-
);
73-
setupArgs.espIdfStatusBar = espIdfStatusBar;
74-
if (setupArgs.existingIdfSetups && setupArgs.existingIdfSetups.length) {
75-
progress.report({
76-
increment: 5,
77-
message: "ESP-IDF and tools found, configuring the extension...",
78-
});
79-
const confTarget = readParameter(
80-
"idf.saveScope"
81-
) as vscode.ConfigurationTarget;
82-
const options = setupArgs.existingIdfSetups.map((existingSetup) => {
83-
return {
84-
label: `ESP-IDF ${existingSetup.version} in ${existingSetup.idfPath}`,
85-
target: existingSetup,
86-
};
87-
});
88-
const selectedSetup = await vscode.window.showQuickPick(options, {
89-
placeHolder: "Select a ESP-IDF setup to use",
90-
});
91-
if (!selectedSetup) {
92-
return;
93-
}
94-
await useIdfSetupSettings(
95-
selectedSetup.target,
96-
confTarget,
97-
workspace,
98-
espIdfStatusBar
99-
);
100-
} else if (
101-
typeof process.env.WEB_IDE === "undefined" &&
102-
showSetupWindow
103-
) {
104-
vscode.commands.executeCommand("espIdf.setup.start", setupArgs);
105-
}
106-
} catch (error) {
107-
const msg = error.message
108-
? error.message
109-
: "Error loading initial configuration.";
110-
Logger.errorNotify(msg, error, "checkExtensionSettings");
111-
if (showSetupWindow) {
112-
vscode.commands.executeCommand("espIdf.setup.start");
113-
}
114-
}
115-
}
50+
51+
if (!showWelcomePage) {
52+
return;
53+
}
54+
55+
const actionItems = [
56+
"Open Setup wizard",
57+
"Choose from existing ESP-IDF setups.",
58+
];
59+
60+
if (vscode.env.remoteName === "dev-container") {
61+
actionItems.unshift("Use docker container configuration");
62+
}
63+
64+
const action = await vscode.window.showInformationMessage(
65+
"The extension configuration is not valid. Choose an action:",
66+
...actionItems
11667
);
68+
if (!action) {
69+
return;
70+
}
71+
72+
if (action === "Use docker container configuration") {
73+
const idfPath = "/opt/esp/idf";
74+
const idfToolsPath = "/opt/esp";
75+
const gitPath = "/usr/bin/git";
76+
const idfSetupId = getIdfMd5sum(idfPath);
77+
const idfVersion = await getEspIdfFromCMake(idfPath);
78+
const containerIdfSetup: IdfSetup = {
79+
id: idfSetupId,
80+
idfPath,
81+
gitPath,
82+
toolsPath: idfToolsPath,
83+
version: idfVersion,
84+
isValid: false,
85+
};
86+
containerIdfSetup.isValid = await checkIdfSetup(containerIdfSetup);
87+
88+
if (!containerIdfSetup.isValid) {
89+
vscode.window.showInformationMessage(
90+
"The docker container configuration is not valid"
91+
);
92+
return;
93+
}
94+
95+
await useIdfSetupSettings(
96+
containerIdfSetup,
97+
vscode.ConfigurationTarget.WorkspaceFolder,
98+
workspace,
99+
espIdfStatusBar
100+
);
101+
return;
102+
}
103+
104+
if (action === "Open Setup wizard") {
105+
vscode.commands.executeCommand("espIdf.setup.start");
106+
return;
107+
} else if (action === "Choose from existing ESP-IDF setups.") {
108+
vscode.commands.executeCommand("espIdf.selectCurrentIdfVersion");
109+
return;
110+
}
117111
}

‎src/cmdTreeView/cmdStore.ts

+2-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,8 @@ export interface IDFCommandDescription {
2727

2828
export enum IDFWebCommandKeys {
2929
Flash = "espIdfWeb.flash",
30-
Monitor = "espIdfWeb.monitor"
30+
Monitor = "espIdfWeb.monitor",
31+
FlashAndMonitor = "espIdfWeb.flashAndMonitor"
3132
}
3233

3334
export enum CommandKeys {

‎src/extension.ts

+31-9
Original file line numberDiff line numberDiff line change
@@ -1789,7 +1789,9 @@ export async function activate(context: vscode.ExtensionContext) {
17891789
});
17901790
});
17911791

1792-
registerIDFCommand("espIdf.createIdfTerminal", createIdfTerminal);
1792+
registerIDFCommand("espIdf.createIdfTerminal", () =>
1793+
createIdfTerminal(context.extensionPath)
1794+
);
17931795
registerIDFCommand("espIdf.jtag_flash", () =>
17941796
flash(false, ESP.FlashType.JTAG)
17951797
);
@@ -3630,11 +3632,7 @@ export async function activate(context: vscode.ExtensionContext) {
36303632
Logger.warn(`Failed to handle URI Open, ${uri.toString()}`);
36313633
},
36323634
});
3633-
await checkExtensionSettings(
3634-
context.extensionPath,
3635-
workspaceRoot,
3636-
statusBarItems["currentIdfVersion"]
3637-
);
3635+
checkExtensionSettings(workspaceRoot, statusBarItems["currentIdfVersion"]);
36383636

36393637
// WALK-THROUGH
36403638
let disposable = vscode.commands.registerCommand(
@@ -4082,7 +4080,7 @@ function createQemuMonitor() {
40824080
}
40834081

40844082
const buildFlashAndMonitor = async (runMonitor: boolean = true) => {
4085-
PreCheck.perform([webIdeCheck, openFolderCheck], async () => {
4083+
PreCheck.perform([openFolderCheck], async () => {
40864084
const notificationMode = idfConf.readParameter(
40874085
"idf.notificationMode",
40884086
workspaceRoot
@@ -4113,6 +4111,11 @@ const buildFlashAndMonitor = async (runMonitor: boolean = true) => {
41134111
if (!canContinue) {
41144112
return;
41154113
}
4114+
// Re route to ESP-IDF Web extension if using Codespaces or Browser
4115+
if (vscode.env.uiKind === vscode.UIKind.Web) {
4116+
vscode.commands.executeCommand(IDFWebCommandKeys.FlashAndMonitor);
4117+
return;
4118+
}
41164119
progress.report({
41174120
message: "Flashing project into device...",
41184121
increment: 60,
@@ -4260,17 +4263,36 @@ async function startFlashing(
42604263
}
42614264
}
42624265

4263-
function createIdfTerminal() {
4266+
function createIdfTerminal(extensionPath: string) {
42644267
PreCheck.perform([openFolderCheck], async () => {
42654268
const modifiedEnv = await utils.appendIdfAndToolsToPath(workspaceRoot);
4269+
let shellArgs = [];
4270+
if (process.platform === "win32") {
4271+
if (
4272+
vscode.env.shell.indexOf("powershell") !== -1 ||
4273+
vscode.env.shell.indexOf("pwsh") !== -1
4274+
) {
4275+
shellArgs = ["-ExecutionPolicy", "Bypass", "-NoProfile"];
4276+
}
4277+
}
42664278
const espIdfTerminal = vscode.window.createTerminal({
42674279
name: "ESP-IDF Terminal",
42684280
env: modifiedEnv,
42694281
cwd: workspaceRoot.fsPath || modifiedEnv.IDF_PATH || process.cwd(),
42704282
strictEnv: true,
4271-
shellArgs: [],
4283+
shellArgs,
42724284
shellPath: vscode.env.shell,
42734285
});
4286+
if (process.platform === "win32") {
4287+
if (vscode.env.shell.indexOf("cmd.exe") !== -1) {
4288+
espIdfTerminal.sendText(path.join(extensionPath, "export.bat"));
4289+
} else if (
4290+
vscode.env.shell.indexOf("powershell") !== -1 ||
4291+
vscode.env.shell.indexOf("pwsh") !== -1
4292+
) {
4293+
espIdfTerminal.sendText(path.join(extensionPath, "export.ps1"));
4294+
}
4295+
}
42744296
espIdfTerminal.show();
42754297
});
42764298
}

‎src/ui-test/configure-test.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ describe("Configure extension", () => {
3131

3232
before(async function () {
3333
this.timeout(100000);
34-
await new Promise((res) => setTimeout(res, 2000));
34+
await new Promise((res) => setTimeout(res, 10000));
3535
const notifications = await new Workbench().getNotifications();
3636
for (let n of notifications) {
3737
await n.dismiss();

0 commit comments

Comments
 (0)