VS Code Setup Guide

May 20, 2026 ยท View on GitHub

Complete Setup Documentation

Your VS Code workspace has been configured with complete build, run, and test task management for the LibMan project.


๐Ÿ“ฆ What's Configured

VS Code Configuration Files

  • tasks.json - 10+ build/run/test tasks
  • settings.json - Compiler & CMake config
  • launch.json - Debug configurations
  • extensions.json - 7 recommended extensions

Features Included

โœ… Debug & Release builds
โœ… One-click build + run
โœ… Full GDB debugging support
โœ… Test compilation & execution
โœ… Pre-configured compiler paths
โœ… Code analysis exclusions
โœ… Parallel builds (-j4)
โœ… CMake integration


๐ŸŽฏ Available Tasks

Compilation & Running LibMan (Ctrl+Shift+B)

  • Build Debug
  • Build Release
  • Run Debug
  • Run Release
  • Build & Run Debug
  • Build & Run Release

Tests (Ctrl+Shift+B)

  • Configure Tests
  • Build Tests
  • Run All Tests

CMake Configuration (Ctrl+Shift+B)

  • CMake: Configure Debug
  • CMake: Configure Release

Debugging (F5)

  • Debug LibMan (GDB)
  • Debug Tests (GDB)

โšก Quick Usage

Build & Run

  1. Press Ctrl+Shift+B
  2. Select "Build & Run Debug"
  3. Press Enter

Debug

  1. Press F5
  2. Select "Debug LibMan (GDB)"
  3. App launches with debugger

Run Tests

  1. Press Ctrl+Shift+B
  2. Select "Tests: Run All Tests"
  3. Tests execute

๐Ÿ”จ Build Configuration

Compiler Settings

  • Compiler: MinGW 8.1.0 (32-bit)
  • Path: C:/Qt/Tools/mingw810_32/bin/c++.exe
  • C++ Standard: C++17
  • Debugger: GDB

CMake Settings

  • Generator: MinGW Makefiles
  • Build Directory: build/
  • Test Build Directory: tests/build/
  • Parallel Jobs: 4 (-j4)

Excluded Directories

From explorer and search:

  • build/
  • tests/build/
  • .deps/
  • capnproto/
  • capnp-install/
  • lstream/
  • coverage.* (coverage files)

๐Ÿ“ Configuration Files

.vscode/tasks.json

Contains all build and run tasks. Edit to:

  • Add new build configurations
  • Change compiler flags
  • Modify parallel jobs
  • Customize task behavior

.vscode/settings.json

Controls VS Code behavior. Edit to:

  • Change compiler path
  • Modify CMake settings
  • Adjust code analysis
  • Change editor formatting

.vscode/launch.json

Debug configurations. Edit to:

  • Change executable paths
  • Add debug arguments
  • Modify GDB settings
  • Add more debug targets

๐ŸŽ“ Getting Started

First Time

  1. Install ZLIB (see DEPENDENCIES.md)
  2. Configure CMake: Ctrl+Shift+B โ†’ "CMake: Configure Debug"
  3. Build: Ctrl+Shift+B โ†’ "Build Debug"
  4. Run: Ctrl+Shift+B โ†’ "Run Debug"

Regular Development

  • Build: Ctrl+Shift+B (use dropdown)
  • Debug: F5 (starts with automatic build)
  • Test: Ctrl+Shift+B โ†’ "Tests: Run All Tests"

๐Ÿ”ง Customization

Increase Build Speed

Edit .vscode/tasks.json, find build tasks, change -j4 to -j8:

"args": ["--build", "build", "--config", "Debug", "-j8"]

Use Different Generator

In .vscode/tasks.json, change "MinGW Makefiles" to:

  • "Ninja" (requires Ninja installed)
  • "Visual Studio 16 2019"

Change Compiler

Edit .vscode/settings.json:

"C_Cpp.default.compilerPath": "path/to/your/compiler"


Back to: Documentation Index