extension auto configuration (#1075)

* add option to select initial setup if not configured * rm error log to channel on autoconf * rm checkIdfSetup log to channel * rm exec child process channel log * fix lint
espressif · Dec 7, 2023 · f549ded · f549ded
1 parent caac086
commit f549ded
Show file tree

Hide file tree

Showing 5 changed files with 51 additions and 23 deletions.
diff --git a/src/checkExtensionSettings.ts b/src/checkExtensionSettings.ts
@@ -23,6 +23,9 @@ import {
 import { Logger } from "./logger/logger";
 import { readParameter } from "./idfConfiguration";
 import { useIdfSetupSettings } from "./setup/setupValidation/espIdfSetup";
+import { getIdfMd5sum } from "./setup/espIdfJson";
+import { getEspIdfFromCMake } from "./utils";
+import { IdfSetup } from "./views/setup/types";
 
 export async function checkExtensionSettings(
  extensionPath: string,
@@ -52,20 +55,27 @@ export async function checkExtensionSettings(
  progress,
  workspace
  );
- if (
- setupArgs.espIdfPath &&
- setupArgs.espToolsPath &&
- setupArgs.existingIdfSetups &&
- setupArgs.existingIdfSetups.length
- ) {
+ if (setupArgs.existingIdfSetups && setupArgs.existingIdfSetups.length) {
  progress.report({
  increment: 5,
  message: "ESP-IDF and tools found, configuring the extension...",
  });
  const confTarget = readParameter(
  "idf.saveScope"
  ) as vscode.ConfigurationTarget;
- await useIdfSetupSettings(setupArgs.existingIdfSetups[0], confTarget);
+ const options = setupArgs.existingIdfSetups.map((existingSetup) => {
+ return {
+ label: `ESP-IDF ${existingSetup.version} in ${existingSetup.idfPath}`,
+ target: existingSetup,
+ };
+ });
+ const selectedSetup = await vscode.window.showQuickPick(options, {
+ placeHolder: "Select a ESP-IDF setup to use",
+ });
+ if (!selectedSetup) {
+ return;
+ }
+ await useIdfSetupSettings(selectedSetup.target, confTarget);
  } else if (
  typeof process.env.WEB_IDE === "undefined" &&
  showSetupWindow

diff --git a/src/idfToolsManager.ts b/src/idfToolsManager.ts
@@ -122,12 +122,16 @@ export class IdfToolsManager {
  });
  }
 
- public async verifyPackages(pathsToVerify: string, onReqPkgs?: string[]) {
+ public async verifyPackages(
+ pathsToVerify: string,
+ onReqPkgs?: string[],
+ logToChannel: boolean = true
+ ) {
  const pkgs = await this.getPackageList(onReqPkgs);
  const promiseArr: { [key: string]: string } = {};
  const names = pkgs.map((pkg) => pkg.name);
  const promises = pkgs.map((p) =>
- this.checkBinariesVersion(p, pathsToVerify)
+ this.checkBinariesVersion(p, pathsToVerify, logToChannel)
  );
  const versionExistsArr = await Promise.all(promises);
  names.forEach((pkgName, i) => (promiseArr[pkgName] = versionExistsArr[i]));
@@ -195,7 +199,11 @@ export class IdfToolsManager {
  return versions.length > 0 ? versions[0].name : undefined;
  }
 
- public async checkBinariesVersion(pkg: IPackage, pathsToVerify: string) {
+ public async checkBinariesVersion(
+ pkg: IPackage,
+ pathsToVerify: string,
+ logToChannel: boolean = true
+ ) {
  const pathNameInEnv: string =
  process.platform === "win32" ? "Path" : "PATH";
  let modifiedPath = process.env[pathNameInEnv];
@@ -220,7 +228,7 @@ export class IdfToolsManager {
  const binVersionResponse = await utils.execChildProcess(
  versionCmd,
  process.cwd(),
- this.toolsManagerChannel,
+ logToChannel ? this.toolsManagerChannel : undefined,
  {
  env: modifiedEnv,
  maxBuffer: 500 * 1024,
@@ -246,8 +254,10 @@ export class IdfToolsManager {
  return "No match";
  } catch (error) {
  const errMsg = `Error checking ${pkg.name} version`;
- this.toolsManagerChannel.appendLine(errMsg);
- this.toolsManagerChannel.appendLine(error);
+ if (logToChannel) {
+ this.toolsManagerChannel.appendLine(errMsg);
+ this.toolsManagerChannel.appendLine(error);
+ }
  Logger.error(errMsg, error);
  return errMsg;
  }
@@ -315,11 +325,16 @@ export class IdfToolsManager {
  public async getRequiredToolsInfo(
  basePath?: string,
  pathToVerify?: string,
- onReqPkgs?: string[]
+ onReqPkgs?: string[],
+ logToChannel: boolean = true
  ) {
  let versions: { [key: string]: string } = {};
  if (pathToVerify) {
- versions = await this.verifyPackages(pathToVerify, onReqPkgs);
+ versions = await this.verifyPackages(
+ pathToVerify,
+ onReqPkgs,
+ logToChannel
+ );
  }
  const packages = await this.getPackageList(onReqPkgs);
  const idfToolsList = packages.map((pkg) => {

diff --git a/src/setup/existingIdfSetups.ts b/src/setup/existingIdfSetups.ts
@@ -23,7 +23,7 @@ import { IdfSetup } from "../views/setup/types";
 import { getIdfMd5sum, loadEspIdfJson } from "./espIdfJson";
 import { checkIdfSetup } from "./setupValidation/espIdfSetup";
 
-export async function getPreviousIdfSetups() {
+export async function getPreviousIdfSetups(logToChannel: boolean = true) {
  const setupKeys = ESP.GlobalConfiguration.store.getIdfSetupKeys();
  const idfSetups: IdfSetup[] = [];
  for (let idfSetupKey of setupKeys) {
@@ -33,15 +33,15 @@ export async function getPreviousIdfSetups() {
  );
  if (idfSetup && idfSetup.idfPath) {
  try {
- idfSetup.isValid = await checkIdfSetup(idfSetup);
+ idfSetup.isValid = await checkIdfSetup(idfSetup, logToChannel);
  idfSetup.version = await getEspIdfFromCMake(idfSetup.idfPath);
  idfSetups.push(idfSetup);
  } catch (err) {
  const msg = err.message
  ? err.message
  : "Error checkIdfSetup in getPreviousIdfSetups";
  Logger.error(msg, err);
- ESP.GlobalConfiguration.store.clearIdfSetup(idfSetup.id)
+ ESP.GlobalConfiguration.store.clearIdfSetup(idfSetup.id);
  }
  }
  }
@@ -105,7 +105,7 @@ export async function loadIdfSetupsFromEspIdfJson(toolsPath: string) {
  isValid: false,
  } as IdfSetup;
  try {
- setupConf.isValid = await checkIdfSetup(setupConf);
+ setupConf.isValid = await checkIdfSetup(setupConf, false);
  } catch (err) {
  const msg = err.message
  ? err.message

diff --git a/src/setup/setupInit.ts b/src/setup/setupInit.ts
@@ -131,7 +131,7 @@ export async function getSetupInitialValues(
  const espIdfTagsList = await getEspIdfTags();
  progress.report({ increment: 10, message: "Getting Python versions..." });
  const pythonVersions = await getPythonList(extensionPath);
- const idfSetups = await getPreviousIdfSetups();
+ const idfSetups = await getPreviousIdfSetups(false);
  const setupInitArgs = {
  espIdfVersionsList,
  espIdfTagsList,
@@ -284,7 +284,8 @@ export async function isCurrentInstallValid(workspaceFolder: Uri) {
  const toolsInfo = await idfToolsManager.getRequiredToolsInfo(
  path.join(toolsPath, "tools"),
  extraPaths,
- extraReqPaths
+ extraReqPaths,
+ false
  );
  const failedToolsResult = toolsInfo.filter(
  (tInfo) =>

diff --git a/src/setup/setupValidation/espIdfSetup.ts b/src/setup/setupValidation/espIdfSetup.ts
@@ -57,7 +57,8 @@ export async function useIdfSetupSettings(
  );
 }
 
-export async function checkIdfSetup(setupConf: IdfSetup) {
+export async function checkIdfSetup(setupConf: IdfSetup,
+ logToChannel: boolean = true) {
  try {
  if (!setupConf.idfPath) {
  return false;
@@ -76,7 +77,8 @@ export async function checkIdfSetup(setupConf: IdfSetup) {
  const toolsInfo = await idfToolsManager.getRequiredToolsInfo(
  join(setupConf.toolsPath, "tools"),
  exportedToolsPaths,
- ["cmake", "ninja"]
+ ["cmake", "ninja"],
+ logToChannel
  );
 
  const failedToolsResult = toolsInfo.filter(