Bugfix/create project (#1698)

brianignacio5 · web-flow · commit 9c8d86ced5f8 · 2025-11-03T12:01:16.000+08:00
* add create project command

* add command to docs

* update docs and cmd name

* update cmd name and fix progress end before open msg

* update progress title and status

* add clang config
diff --git a/README.md b/README.md
@@ -227,12 +227,18 @@ Press <kbd>F1</kbd> or click menu `View` -> `Command Palette...` to show Visual
             <td><kbd>Ctrl</kbd> <kbd>E</kbd> <kbd>D</kbd></td>
         </tr>
         <tr>
-            <td rowspan=4 align="center">Project creation</td>
+            <td rowspan=5 align="center">Project creation</td>
             <td>Create New ESP-IDF Component</td>
             <td>Create a new component in the current directory based on ESP-IDF component template.</td>
             <td></td>
             <td></td>
         </tr>
+        <tr>
+            <td>Create New Empty Project</td>
+            <td>Ask for the new project name, choose the directory to create the project, and show a notification to open the newly created project.</td>
+            <td></td>
+            <td></td>
+        </tr>
         <tr>
             <td>Import ESP-IDF Project</td>
             <td>Import an existing ESP-IDF project, add .vscode and .devcontainer files to a new location, and optionally rename the project.</td>
diff --git a/README_CN.md b/README_CN.md
@@ -227,12 +227,18 @@ ESP-IDF 扩展在 VS Code 底部蓝色窗口的状态栏中提供了一系列命
             <td><kbd>Ctrl</kbd> <kbd>E</kbd> <kbd>D</kbd></td>
         </tr>
         <tr>
-            <td rowspan=4 align="center">创建项目</td>
+            <td rowspan=5 align="center">创建项目</td>
             <td>基于模板创建新项目</td>
             <td>使用扩展中的项目模板来创建一个新的 ESP-IDF 项目。</td>
             <td><kbd>⌘</kbd> <kbd>I</kbd> <kbd>C</kbd></td>
             <td><kbd>Ctrl</kbd> <kbd>E</kbd> <kbd>C</kbd></td>
         </tr>
+        <tr>
+            <td>创建新的空项目</td>
+            <td>询问新项目名称，选择创建项目的目录，并显示通知以打开新创建的项目。</td>
+            <td></td>
+            <td></td>
+        </tr>
         <tr>
             <td>创建新 ESP-IDF 组件</td>
             <td>在当前目录下，基于 ESP-IDF 组件模板创建新组件。</td>
diff --git a/docs_espressif/en/commands.rst b/docs_espressif/en/commands.rst
@@ -36,6 +36,8 @@ All commands start with ``ESP-IDF:``.
      - Configure the current ESP-IDF project to use esp-clang as toolchain to use and configure LLVM Clang extension in settings.json.
    * - Create New ESP-IDF Component
      - Create a new component in the current directory based on ESP-IDF component template.
+   * - Create New Empty Project
+     - Ask for the new project name, choose the directory to create the project, and show a notification to open the newly created project.
    * - Dispose of Current SDK Configuration Editor Server Process
      - If you already executed the SDK Configuration editor, a cache process will remain in the background for faster reopening. This command will dispose of such cache process.
    * - Doctor Command
diff --git a/docs_espressif/zh_CN/commands.rst b/docs_espressif/zh_CN/commands.rst
@@ -34,6 +34,8 @@
      - 在项目的 SDKConfig 文件中设置必要的值，启用代码覆盖率分析。
    * - 创建新 ESP-IDF 组件
      - 在当前目录下，基于 ESP-IDF 组件模板创建新组件。
+   * - 创建新的空项目
+     - 询问新项目名称，选择创建项目的目录，并显示通知以打开新创建的项目。
    * - 清理当前 SDK 配置编辑器服务器进程
      - 若先前执行过 ``SDK 配置编辑器`` 命令，则后台将保留缓存进程，以便下次更快打开编辑器。此命令将清理此类缓存进程。
    * - 诊断命令
diff --git a/l10n/bundle.l10n.es.json b/l10n/bundle.l10n.es.json
@@ -43,6 +43,7 @@
   "ESP-IDF container files have been added to the project.": "Se han agregado archivos contenedores ESP-IDF al proyecto.",
   "Enter ESP-IDF component name": "Ingrese el nombre del componente ESP-IDF",
   "The ESP-IDF component {componentName} has been created": "Se ha creado el componente ESP-IDF {componentName}",
+  "ESP-IDF project {name} has been created": "Se ha creado el proyecto ESP-IDF {name}",
   "The current directory is not an ESP-IDF project.": "El directorio actual no es un proyecto ESP-IDF.",
   "ESP-IDF: SDK Configuration Editor": "ESP-IDF: Editor de configuración del SDK",
   "ESP-IDF: Save Default Configuration (save-defconfig)": "ESP-IDF: Guardar configuración predeterminada (save-defconfig)",
diff --git a/l10n/bundle.l10n.pt.json b/l10n/bundle.l10n.pt.json
@@ -43,6 +43,7 @@
   "ESP-IDF container files have been added to the project.": "Arquivos contêiner ESP-IDF foram adicionados ao projeto.",
   "Enter ESP-IDF component name": "Insira o nome do componente ESP-IDF",
   "The ESP-IDF component {componentName} has been created": "O componente ESP-IDF {componentName} foi criado",
+  "ESP-IDF project {name} has been created": "O projeto ESP-IDF {name} foi criado",
   "The current directory is not an ESP-IDF project.": "O diretório atual não é um projeto ESP-IDF.",
   "ESP-IDF: SDK Configuration Editor": "ESP-IDF: Editor de configuração do SDK",
   "ESP-IDF: Save Default Configuration (save-defconfig)": "ESP-IDF: Salvar configuração padrão (save-defconfig)",
diff --git a/l10n/bundle.l10n.ru.json b/l10n/bundle.l10n.ru.json
@@ -43,6 +43,7 @@
   "ESP-IDF container files have been added to the project.": "В проект добавлены файлы-контейнеры ESP-IDF.",
   "Enter ESP-IDF component name": "Введите имя компонента ESP-IDF",
   "The ESP-IDF component {componentName} has been created": "Компонент ESP-IDF {comComponentName} создан",
+  "ESP-IDF project {name} has been created": "Проект ESP-IDF {name} создан",
   "The current directory is not an ESP-IDF project.": "Текущий каталог не является проектом ESP-IDF.",
   "ESP-IDF: SDK Configuration Editor": "ESP-IDF: Редактор конфигурации SDK",
   "ESP-IDF: Save Default Configuration (save-defconfig)": "ESP-IDF: сохранить конфигурацию по умолчанию (save-defconfig)",
diff --git a/l10n/bundle.l10n.zh-CN.json b/l10n/bundle.l10n.zh-CN.json
@@ -43,6 +43,7 @@
   "ESP-IDF container files have been added to the project.": "ESP-IDF 容器文件已添加到项目中。",
   "Enter ESP-IDF component name": "输入 ESP-IDF 组件名称",
   "The ESP-IDF component {componentName} has been created": "已创建 ESP-IDF 组件 {componentName}",
+  "ESP-IDF project {name} has been created": "已创建 ESP-IDF 项目 {name}",
   "The current directory is not an ESP-IDF project.": "当前目录并非 ESP-IDF 项目。",
   "ESP-IDF: SDK Configuration Editor": "ESP-IDF：SDK 配置编辑器",
   "ESP-IDF: Save Default Configuration (save-defconfig)": "ESP-IDF：保存默认配置 (save-defconfig)",
diff --git a/package.json b/package.json
@@ -1698,6 +1698,11 @@
         "title": "%espIdf.newProject.start.title%",
         "category": "ESP-IDF"
       },
+      {
+        "command": "espIdf.createNewProject",
+        "title": "%espIdf.createNewProject.title%",
+        "category": "ESP-IDF"
+      },
       {
         "command": "espIdf.eraseFlash",
         "title": "%espIdf.eraseFlash.title%",
diff --git a/package.nls.es.json b/package.nls.es.json
@@ -66,6 +66,7 @@
 	"espIdf.monitorDevice.title": "Monitorear Dispositivo",
 	"espIdf.monitorQemu.title": "Monitorear Dispositivo QEMU",
 	"espIdf.newProject.start.title": "Nuevo Proyecto",
+	"espIdf.createNewProject.title": "Crear Nuevo Proyecto Vacío",
 	"espIdf.ninja.summary.title": "Mostrar Resumen de Compilación Ninja",
 	"espIdf.openDocUrl.title": "Abrir Documentación ESP-IDF...",
 	"espIdf.openOCDCommand.title": "Administrador de OpenOCD",
diff --git a/package.nls.json b/package.nls.json
@@ -66,6 +66,7 @@
   "espIdf.monitorDevice.title": "Monitor Device",
   "espIdf.monitorQemu.title": "Monitor QEMU Device",
   "espIdf.newProject.start.title": "New Project",
+	"espIdf.createNewProject.title": "Create New Empty Project",
   "espIdf.ninja.summary.title": "Show Ninja Build Summary",
   "espIdf.openDocUrl.title": "Open ESP-IDF Documentation...",
   "espIdf.openOCDCommand.title": "OpenOCD Manager",
diff --git a/package.nls.pt.json b/package.nls.pt.json
@@ -66,6 +66,7 @@
 	"espIdf.monitorDevice.title": "Monitore dispositivo",
 	"espIdf.monitorQemu.title": "Monitorar dispositivo QEMU",
 	"espIdf.newProject.start.title": "Novo projeto",
+	"espIdf.createNewProject.title": "Criar Novo Projeto Vazio",
 	"espIdf.ninja.summary.title": "Mostrar resumo da versão Ninja",
 	"espIdf.openDocUrl.title": "Abra a documentação do ESP-IDF...",
 	"espIdf.openOCDCommand.title": "Gerenciador OpenOCD",
diff --git a/package.nls.ru.json b/package.nls.ru.json
@@ -66,6 +66,7 @@
 	"espIdf.monitorDevice.title": "Монитор IDF",
 	"espIdf.monitorQemu.title": "Монитор QEMU IDF",
 	"espIdf.newProject.start.title": "Новый проект",
+	"espIdf.createNewProject.title": "Создать Новый Пустой Проект",
 	"espIdf.ninja.summary.title": "Показать сводку сборки Ninja",
 	"espIdf.openDocUrl.title": "Открыть документацию ESP-IDF...",
 	"espIdf.openOCDCommand.title": "Менеджер OpenOCD",
diff --git a/package.nls.zh-CN.json b/package.nls.zh-CN.json
@@ -66,6 +66,7 @@
 	"espIdf.monitorDevice.title": "监视设备",
 	"espIdf.monitorQemu.title": "监视 QEMU 设备",
 	"espIdf.newProject.start.title": "新建项目",
+	"espIdf.createNewProject.title": "创建新的空项目",
 	"espIdf.ninja.summary.title": "显示 Ninja 构建摘要",
 	"espIdf.openDocUrl.title": "打开 ESP-IDF 文档…",
 	"espIdf.openOCDCommand.title": "OpenOCD 管理器",
diff --git a/src/extension.ts b/src/extension.ts
@@ -2001,6 +2001,86 @@ export async function activate(context: vscode.ExtensionContext) {
     });
   });
 
+  registerIDFCommand("espIdf.createNewProject", async () => {
+    const notificationMode = idfConf.readParameter(
+      "idf.notificationMode",
+      workspaceRoot
+    ) as string;
+    const ProgressLocation =
+      notificationMode === idfConf.NotificationMode.All ||
+      notificationMode === idfConf.NotificationMode.Notifications
+        ? vscode.ProgressLocation.Notification
+        : vscode.ProgressLocation.Window;
+    let projectName: string;
+    let selectedFolder: vscode.Uri[] | undefined;
+    await vscode.window.withProgress(
+      {
+        cancellable: false,
+        location: ProgressLocation,
+        title: vscode.l10n.t("New Project"),
+      },
+      async (
+        progress: vscode.Progress<{ increment: number; message: string }>,
+        cancelToken: vscode.CancellationToken
+      ) => {
+        try {
+          progress.report({
+            message: "Waiting for project name",
+            increment: 10,
+          });
+          projectName = await vscode.window.showInputBox({
+            placeHolder: vscode.l10n.t("Enter ESP-IDF project name"),
+            value: "",
+          });
+          if (!projectName) {
+            return;
+          }
+          progress.report({
+            message: "Waiting for folder selection",
+            increment: 20,
+          });
+          selectedFolder = await vscode.window.showOpenDialog({
+            canSelectFolders: true,
+            canSelectFiles: false,
+            canSelectMany: false,
+          });
+          if (!selectedFolder) {
+            return;
+          }
+          progress.report({
+            message: "Creating ESP-IDF project...",
+            increment: 30,
+          });
+          await utils.createNewProject(projectName, selectedFolder[0]);
+        } catch (error) {
+          const errMsg = error.message || "Error creating ESP-IDF project";
+          return Logger.errorNotify(
+            errMsg,
+            error,
+            "extension createNewProject"
+          );
+        }
+      }
+    );
+
+    if (projectName && selectedFolder && selectedFolder[0]) {
+      const openItem = vscode.l10n.t(`Open {0}`, projectName);
+      const opt = await vscode.window.showInformationMessage(
+        vscode.l10n.t("ESP-IDF project {name} has been created", {
+          name: projectName,
+        }),
+        openItem
+      );
+      if (opt === openItem) {
+        vscode.commands.executeCommand(
+          "vscode.openFolder",
+          vscode.Uri.joinPath(selectedFolder[0], projectName),
+          true
+        );
+      }
+    }
+  });
+
   registerIDFCommand("espIdf.createNewComponent", async () => {
     PreCheck.perform([openFolderCheck], async () => {
       try {
diff --git a/src/newProject/newProjectPanel.ts b/src/newProject/newProjectPanel.ts
@@ -283,7 +283,7 @@ export class NewProjectPanel {
             const boilerplatePath = path.join(
               this.extensionPath,
               "templates",
-              "boilerplate"
+              "template-app"
             );
             await utils.copyFromSrcProject(
               boilerplatePath,
diff --git a/src/utils.ts b/src/utils.ts
@@ -47,6 +47,7 @@ import {
 } from "./pythonManager";
 import { IdfToolsManager } from "./idfToolsManager";
 import { isFlashEncryptionEnabled } from "./flash/verifyFlashEncryption";
+import { configureClangSettings } from "./clang";
 
 const currentFolderMsg = vscode.l10n.t("ESP-IDF: Current Project");
 
@@ -1403,6 +1404,32 @@ export function getWebViewFavicon(extensionPath: string): vscode.Uri {
   );
 }
 
+/**
+ * Create a new ESP-IDF project in the current workspace.
+ * @param {string} name - Name of the new project to create.
+ * @param {string} targetDirectory - The directory where the project will be created.
+ * @returns {Promise<vscode.Uri>} - The URI of the created project directory.
+ */
+export async function createNewProject(
+  name: string,
+  targetDirectory: vscode.Uri
+) {
+  const destinationDir = vscode.Uri.joinPath(targetDirectory, name);
+  await mkdirp(destinationDir.fsPath);
+  await copyFromSrcProject(
+    path.join(extensionContext.extensionPath, "templates", "template-app"),
+    destinationDir
+  );
+  await updateProjectNameInCMakeLists(destinationDir.fsPath, name);
+  await configureClangSettings(destinationDir, false);
+  return destinationDir;
+}
+
+/**
+ * Create a new ESP-IDF component in the current workspace.
+ * @param {string} name - Name of the new component to create.
+ * @param {string} currentDirectory - The current directory where the component will be created.
+ */
 export async function createNewComponent(
   name: string,
   currentDirectory: string
diff --git a/templates/template-app/.gitignore b/templates/template-app/.gitignore
diff --git a/templates/template-app/CMakeLists.txt b/templates/template-app/CMakeLists.txt
@@ -2,7 +2,7 @@
 # https://docs.espressif.com/projects/esp-idf/en/latest/api-guides/build-system.html
 # The following five lines of boilerplate have to be in your project's
 # CMakeLists in this exact order for cmake to work correctly
-cmake_minimum_required(VERSION 3.5)
+cmake_minimum_required(VERSION 3.16)
 
 include($ENV{IDF_PATH}/tools/cmake/project.cmake)
 project(template-app)
diff --git a/templates/template-app/README.md b/templates/template-app/README.md
