[VSC-1640] profiles env should merge customExtraVars with profile env (#1498)

* profiles env should merge customExtraVars with profile env

* add idfTarget to new project wizard

* add idfTarget to project conf editor

* setTarget update current profile idfTarget, notification mismatch idftarget sdkconfig setting

* fix saveProjectConfFile reference

Author: brianignacio5

l10n/bundle.l10n.es.json

@@ -209,5 +209,7 @@
   "Warning: Could not fully remove setting {0}: {1}": "Advertencia: No se pudo eliminar completamente la configuración {0}: {1}",
   "ESP-IDF settings removed successfully.": "Configuraciones de ESP-IDF eliminadas exitosamente.",
   "Failed to remove settings: {0}": "Error al eliminar las configuraciones: {0}",
-  "Error: {0}": "Error: {0}"
+  "Error: {0}": "Error: {0}",
+  "IDF_TARGET mismatch: SDKConfig value is \"{0}\" but settings value is \"{1}\".": "Desajuste de IDF_TARGET: el valor de SDKConfig es \"{0}\" pero el valor de configuración es \"{1}\".",
+  "Set IDF_TARGET": "Establecer IDF_TARGET"
 }

l10n/bundle.l10n.pt.json

@@ -209,5 +209,7 @@
   "Warning: Could not fully remove setting {0}: {1}": "Aviso: Não foi possível remover completamente a configuração {0}: {1}",
   "ESP-IDF settings removed successfully.": "Configurações ESP-IDF removidas com sucesso.",
   "Failed to remove settings: {0}": "Falha ao remover configurações: {0}",
-  "Error: {0}": "Erro: {0}"
+  "Error: {0}": "Erro: {0}",
+  "IDF_TARGET mismatch: SDKConfig value is \"{0}\" but settings value is \"{1}\".": "Incompatibilidade de IDF_TARGET: o valor de SDKConfig é \"{0}\" mas o valor das configurações é \"{1}\".",
+  "Set IDF_TARGET": "Definir IDF_TARGET"
 }

l10n/bundle.l10n.ru.json

@@ -209,5 +209,7 @@
   "Warning: Could not fully remove setting {0}: {1}": "Предупреждение: Не удалось полностью удалить настройку {0}: {1}",
   "ESP-IDF settings removed successfully.": "Настройки ESP-IDF успешно удалены.",
   "Failed to remove settings: {0}": "Не удалось удалить настройки: {0}",
-  "Error: {0}": "Ошибка: {0}"
+  "Error: {0}": "Ошибка: {0}",
+  "IDF_TARGET mismatch: SDKConfig value is \"{0}\" but settings value is \"{1}\".": "Несоответствие IDF_TARGET: значение SDKConfig \"{0}\", но значение настроек \"{1}\".",
+  "Set IDF_TARGET": "Установить IDF_TARGET"
 }

l10n/bundle.l10n.zh-CN.json

@@ -209,5 +209,7 @@
   "Warning: Could not fully remove setting {0}: {1}": "警告：无法完全删除设置 {0}：{1}",
   "ESP-IDF settings removed successfully.": "ESP-IDF设置已成功删除。",
   "Failed to remove settings: {0}": "删除设置失败：{0}",
-  "Error: {0}": "错误：{0}"
+  "Error: {0}": "错误：{0}",
+  "IDF_TARGET mismatch: SDKConfig value is \"{0}\" but settings value is \"{1}\".": "IDF_TARGET 不匹配：SDKConfig 值为 \"{0}\"，但设置值为 \"{1}\"。",
+  "Set IDF_TARGET": "设置 IDF_TARGET"
 }

src/espIdf/setTarget/getTargets.ts

@@ -28,8 +28,13 @@ export interface IdfTarget {
   target: string;
 }
 
-export async function getTargetsFromEspIdf(workspaceFolder: Uri) {
-  const idfPathDir = readParameter("idf.espIdfPath", workspaceFolder);
+export async function getTargetsFromEspIdf(
+  workspaceFolder: Uri,
+  givenIdfPathDir?: string
+) {
+  const idfPathDir = givenIdfPathDir
+    ? givenIdfPathDir
+    : readParameter("idf.espIdfPath", workspaceFolder);
   const idfPyPath = join(idfPathDir, "tools", "idf.py");
   const modifiedEnv = await appendIdfAndToolsToPath(workspaceFolder);
   const pythonBinPath = await getVirtualEnvPythonPath(workspaceFolder);

src/espIdf/setTarget/index.ts

@@ -34,6 +34,7 @@ import { OutputChannel } from "../../logger/outputChannel";
 import { getBoards, getOpenOcdScripts } from "../openOcd/boardConfiguration";
 import { getTargetsFromEspIdf } from "./getTargets";
 import { setTargetInIDF } from "./setTargetInIdf";
+import { updateCurrentProfileIdfTarget } from "../../project-conf";
 
 export async function setIdfTarget(
   placeHolderMsg: string,
@@ -77,6 +78,7 @@ export async function setIdfTarget(
           configurationTarget,
           workspaceFolder.uri
         );
+        await updateCurrentProfileIdfTarget(selectedTarget.target, workspaceFolder.uri);
         const openOcdScriptsPath = await getOpenOcdScripts(workspaceFolder.uri);
         const boards = await getBoards(
           openOcdScriptsPath,

src/extension.ts

@@ -171,6 +171,7 @@ import { IdfSetup } from "./views/setup/types";
 import { asyncRemoveEspIdfSettings } from "./uninstall";
 import { ProjectConfigurationManager } from "./project-conf/ProjectConfigurationManager";
 import { readPartition } from "./espIdf/partition-table/partitionReader";
+import { getTargetsFromEspIdf } from "./espIdf/setTarget/getTargets";
 
 // Global variables shared by commands
 let workspaceRoot: vscode.Uri;
@@ -477,8 +478,6 @@ export async function activate(context: vscode.ExtensionContext) {
     })
   );
 
-  context.subscriptions.push(projectConfigManager);
-
   vscode.debug.onDidTerminateDebugSession((e) => {
     if (isOpenOCDLaunchedByDebug && !isDebugRestarted) {
       isOpenOCDLaunchedByDebug = false;
@@ -1151,9 +1150,11 @@ export async function activate(context: vscode.ExtensionContext) {
             progress: vscode.Progress<{ message: string; increment: number }>
           ) => {
             try {
+              const targetsFromIdf = await getTargetsFromEspIdf(workspaceRoot);
               projectConfigurationPanel.createOrShow(
                 context.extensionPath,
-                workspaceRoot
+                workspaceRoot,
+                targetsFromIdf
               );
             } catch (error) {
               Logger.errorNotify(
@@ -3737,24 +3738,19 @@ export async function activate(context: vscode.ExtensionContext) {
     context,
     statusBarItems
   );
+  context.subscriptions.push(projectConfigManager);
 
-  const projectConfCommandDisposable = vscode.commands.registerCommand(
-    "espIdf.projectConf",
-    async () => {
-      PreCheck.perform([openFolderCheck], async () => {
-        if (projectConfigManager) {
-          await projectConfigManager.selectProjectConfiguration();
-        } else {
-          vscode.window.showErrorMessage(
-            "Project Configuration Manager not initialized."
-          );
-        }
-      });
-    }
-  );
-
-  // Add the disposable to context subscriptions
-  context.subscriptions.push(projectConfCommandDisposable);
+  registerIDFCommand("espIdf.projectConf", () => {
+    PreCheck.perform([openFolderCheck], async () => {
+      if (projectConfigManager) {
+        await projectConfigManager.selectProjectConfiguration();
+      } else {
+        vscode.window.showErrorMessage(
+          "Project Configuration Manager not initialized."
+        );
+      }
+    });
+  });
 }
 
 function checkAndNotifyMissingCompileCommands() {

src/idfConfiguration.ts

@@ -34,7 +34,10 @@ export function addWinIfRequired(param: string) {
   return param;
 }
 
-export function parameterToProjectConfigMap(param: string) {
+export function parameterToProjectConfigMap(
+  param: string,
+  scope?: vscode.ConfigurationScope
+) {
   if (!ESP.ProjectConfiguration.store) {
     return "";
   }
@@ -66,7 +69,22 @@ export function parameterToProjectConfigMap(param: string) {
         ? currentProjectConf.build.sdkconfigDefaults
         : "";
     case "idf.customExtraVars":
-      return currentProjectConf.env;
+      const paramUpdated = addWinIfRequired(param);
+      let settingsVars = vscode.workspace
+        .getConfiguration("", scope)
+        .get(paramUpdated) as { [key: string]: any };
+      let resultVars = {};
+      for (const envKey of Object.keys(settingsVars)) {
+        resultVars[envKey] = settingsVars[envKey];
+      }
+      for (const projectConfEnvKey of Object.keys(currentProjectConf.env)) {
+        resultVars[projectConfEnvKey] =
+          currentProjectConf.env[projectConfEnvKey];
+      }
+      if (currentProjectConf.idfTarget) {
+        resultVars["IDF_TARGET"] = currentProjectConf.idfTarget;
+      }
+      return resultVars;
     case "idf.flashBaudRate":
       return currentProjectConf.flashBaudRate;
     case "idf.monitorBaudRate":

src/newProject/newProjectInit.ts

@@ -28,6 +28,7 @@ import {
   loadIdfSetupsFromEspIdfJson,
 } from "../setup/existingIdfSetups";
 import { IdfSetup } from "../views/setup/types";
+import { getTargetsFromEspIdf, IdfTarget } from "../espIdf/setTarget/getTargets";
 
 export interface INewProjectArgs {
   espIdfSetup: IdfSetup;
@@ -36,6 +37,7 @@ export interface INewProjectArgs {
   espMatterPath: string;
   espHomeKitSdkPath: string;
   espRainmakerPath: string;
+  idfTargets: IdfTarget[];
   boards: IdfBoard[];
   components: IComponent[];
   serialPortList: string[];
@@ -163,13 +165,17 @@ export async function getNewProjectArgs(
     const homeKitSdkTemplates = getExamplesList(espHomeKitSdkPath);
     templates["ESP-HOMEKIT-SDK"] = homeKitSdkTemplates;
   }
+
+  const targetsFromIdf = await getTargetsFromEspIdf(workspace, idfSetup.idfPath);
+  
   progress.report({ increment: 50, message: "Initializing wizard..." });
   return {
     boards: espBoards,
     components,
     espIdfSetup: idfSetup,
     espAdfPath: adfExists ? espAdfPath : undefined,
     espMdfPath: mdfExists ? espMdfPath : undefined,
+    idfTargets: targetsFromIdf,
     espMatterPath: matterExists ? espMatterPath : undefined,
     espHomeKitSdkPath: homekitSdkExists ? espHomeKitSdkPath : undefined,
     espRainmakerPath: rainmakerExists ? espRainmakerPath : undefined,

src/newProject/newProjectPanel.ts

@@ -124,7 +124,8 @@ export class NewProjectPanel {
             message.port &&
             message.projectName &&
             message.openOcdConfigFiles &&
-            message.template
+            message.template &&
+            message.selectedIdfTarget
           ) {
             this.createProject(
               newProjectArgs.espIdfSetup,
@@ -134,7 +135,8 @@ export class NewProjectPanel {
               message.projectName,
               JSON.parse(message.template),
               message.openOcdConfigFiles,
-              newProjectArgs.workspaceFolder
+              newProjectArgs.workspaceFolder,
+              message.selectedIdfTarget
             );
           }
           break;
@@ -183,6 +185,7 @@ export class NewProjectPanel {
               command: "initialLoad",
               containerDirectory: containerPath,
               projectName: "project-name",
+              idfTargets: newProjectArgs.idfTargets,
               serialPortList: newProjectArgs.serialPortList,
               openOcdConfigFiles: defConfigFiles,
               templates: newProjectArgs.templates,
@@ -211,7 +214,8 @@ export class NewProjectPanel {
     projectName: string,
     template: IExample,
     openOcdConfigs?: string,
-    workspaceFolder?: vscode.Uri
+    workspaceFolder?: vscode.Uri,
+    selectedIdfTarget?: string
   ) {
     const newProjectPath = path.join(projectDirectory, projectName);
     let isSkipped = false;
@@ -293,6 +297,7 @@ export class NewProjectPanel {
             settingsJsonPath,
             idfSetup,
             port,
+            selectedIdfTarget,
             openOcdConfigs,
             workspaceFolder
           );