0e48ef9867
* Update the already available settings to use in presets. Turns out, we already have configure, build, buildTool, and test args/envs that can override. I modified the code to use these in presets. Also, I added a small sentence to the settings descriptions to notify users that when using CMake Presets, they are designed for overrides, not general configuration. * pending further discussion, use general environment for all * add temporary override string for presets to environment setting description * don't remove configureSettings * add text to specify that configureSettings isn't for presets scenario * Add tentative treeview UI and output message for configure Still need to do build/test/etc, and likely improve the strings themselves. * add output lines, improvement on the string to come, testing for location * don't output message when we're using cache * add handlers that update the nodes when a test or build setting is modified * slight refactor and add * to status bar * add button that only appears when overrides present that allows opening those settings * share some code * fix localize calls * update tsconfig.json * update eslint * slightly reword the settings * fix buildTool args * avoid duplication * ensure we only return -3 when testPreset isn't defined * fix imports * changelog and docs * refactor to avoid circular dependency * missed one * fix imports |
||
|---|---|---|
| .. | ||
| images | ||
| README.md | ||
| build.md | ||
| cmake-options-configuration.md | ||
| cmake-presets.md | ||
| cmake-settings.md | ||
| configure.md | ||
| debug-launch.md | ||
| debug.md | ||
| faq.md | ||
| how-to.md | ||
| kits.md | ||
| pull_request_template.md | ||
| tasks.md | ||
| troubleshoot.md | ||
| variants.md | ||
README.md
CMake Tools for Visual Studio Code documentation
CMake Tools is an extension designed to make it easy to work with CMake-based projects.
If you are new, try the CMake Tools quick start and see the frequently asked questions.
- Create a new project
- Configure a project
- Build a project
- Debug a project
- Pass command-line arguments to the debugger
- Set up include paths for C++ IntelliSense
- CMake configuration process overview
- The CMake tools configure step
- The configure step outside of CMake Tools
- Clean configure
- Variant YAML example
- Variant schema
- Variant settings
- Variant options
- How variants are applied
- Large variant file example
- Select a launch target
- Quick debugging
- Debug using a launch.json file
- Run without debugging
- Debugging CMake
Configure CMake Tools settings
- Configure and build with CMake Presets
- Supported CMake and CMakePresets.json versions
- Enable CMakePresets.json in the CMake Tools extension
- Configure and build
- CMake: Configure
- CMake: Select Build Preset
- CMake: Build
- Test
- CMake: Select Test Preset
- CMake: Run Tests
- Add new presets
- Add new Configure Presets
- Add new Build Presets
- Edit presets
- Select your generator
- Set and reference environment variables
- Vcpkg integration
- Command substitution in launch.json and settings.json
- Ignored settings
- Unsupported commands
- Troubleshooting
- Run CMake from the command line or a Continuous Integration (CI) pipeline
- Sourcing the environment when building with command line generators on Windows
- Example CMakePresets.json file
- Common issues and resolutions
- CMake Tools is unable to provide IntelliSense configuration
- Green squiggles beneath #include directives
- Debugging ignores launch.json
- Reset CMake Tools extension state
- Increase the logging level
- Check the log file
- Get help