[VSC-1576] Add .gitignore when creating projects

src/newProject/newProjectPanel.ts

@@ -17,7 +17,7 @@ import { Logger } from "../logger/logger";
 import { OutputChannel } from "../logger/outputChannel";
 import { INewProjectArgs } from "./newProjectInit";
 import { IComponent } from "../espIdf/idfComponent/IdfComponent";
-import { copy, ensureDir, readFile, writeJSON } from "fs-extra";
+import { copy, ensureDir, readFile, writeFile, writeJSON } from "fs-extra";
 import * as utils from "../utils";
 import { IExample } from "../examples/Example";
 import { setCurrentSettingsInTemplate } from "./utils";

src/utils.ts

@@ -260,6 +260,15 @@ export async function createVscodeFolder(curWorkspaceFsPath: vscode.Uri) {
   await setCCppPropertiesJsonCompilerPath(curWorkspaceFsPath);
 }
 
+export async function createGitignoreFile(destinationDir: vscode.Uri) {
+  const gitignoreSrcPath = path.join(templateDir, ".gitignore");
+  const gitignoreDestPath = path.join(destinationDir.fsPath, ".gitignore");
+  const gitignoreExists = await pathExists(gitignoreSrcPath);
+  if (gitignoreExists) {
+    await copy(gitignoreSrcPath, gitignoreDestPath);
+  }
+}
+
 export async function setCCppPropertiesJsonCompilerPath(
   curWorkspaceFsPath: vscode.Uri
 ) {
@@ -408,6 +417,7 @@ export async function copyFromSrcProject(
   await copy(srcDirPath, destinationDir.fsPath);
   await createVscodeFolder(destinationDir);
   await createDevContainer(destinationDir.fsPath);
+  await createGitignoreFile(destinationDir);
 }
 
 export function getVariableFromCMakeLists(workspacePath: string, key: string) {

templates/.gitignore

@@ -0,0 +1,78 @@
+# macOS
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Directory metadata
+.directory
+
+# Temporary files
+*~
+*.swp
+*.swo
+*.bak
+*.tmp
+
+# Log files
+*.log
+
+# Build artifacts and directories
+**/build/
+build/
+*.o
+*.a
+*.out
+*.exe # For any host-side utilities compiled on Windows
+
+# ESP-IDF specific build outputs
+*.bin
+*.elf
+*.map
+flasher_args.json # Generated in build directory
+sdkconfig.old
+sdkconfig
+
+# ESP-IDF dependencies
+# For older versions or manual component management
+/components/.idf/
+**/components/.idf/
+# For modern ESP-IDF component manager
+managed_components/
+# If ESP-IDF tools are installed/referenced locally to the project
+.espressif/
+
+# CMake generated files
+CMakeCache.txt
+CMakeFiles/
+cmake_install.cmake
+install_manifest.txt
+CTestTestfile.cmake
+
+# Python environment files
+*.pyc
+*.pyo
+*.pyd
+__pycache__/
+*.egg-info/
+dist/
+
+# Virtual environment folders
+venv/
+.venv/
+env/
+
+# Language Servers
+.clangd/
+.ccls-cache/
+compile_commands.json
+
+# Windows specific
+Thumbs.db
+ehthumbs.db
+Desktop.ini
+
+# User-specific configuration files
+*.user
+*.workspace # General workspace files, can be from various tools
+*.suo       # Visual Studio Solution User Options
+*.sln.docstates # Visual Studio