CMake Tools

Enhancing CMake development in VS Code.

Introduction

CMake Tools provides the native developer a full-featured, convenient, and powerful workflow for CMake-based projects in Visual Studio Code. It simplifies advanced configurations with support for CMake presets and enhances the development experience by supporting rich IntelliSense features, a built-in debugger for CMake scripts, and configurable CMake tasks. Its customizable interface allows for efficient tailored control of projects, while CTest integration ensures straightforward test execution and monitoring.

Features

 

 

 

 

Setup and Installation

Ensure CMake is available on your system. A couple of options are:

• Download CMake.
• Utilize the CMake that is bundled with a Visual Studio installation.

Install the CMake Tools extension from the Extensions pane within VS Code or from the VS Code Marketplace.

Ensure that either you've added your CMake executable to your PATH, or you've adjusted the cmake.cmakePath setting to point to your CMake executable.

Resources

• Docs for comprehensive documentation.
• Quick Start to get up and running fast.
• Github for source code, issues, and contributing.

Contributing

We encourage an open and collaborative development environment and welcome all contributions. Whether you're fixing bugs, proposing new features, or improving our documentation - we invite you to join the CMake Tools community. Please review our contribution guidelines and adhere to our code of conduct.

You can file issues with us using one of our templates:

Bug Report: If you see an error message or encounter an issue while using the CMake Tools extension.

Feature Request: If you have a suggestion or need a feature that would enhance development.

Documentation Request: Requesting changes or additions to the CMake Tools documentation.

Microsoft Open Source Code of Conduct

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.

Data/Telemetry

This extension collects usage data and sends it to Microsoft to help improve our products and services. Collection of telemetry is controlled via the same setting provided by Visual Studio Code: "telemetry.enableTelemetry". Read our privacy statement to learn more.

Credits

This project was started by @vector-of-bool and is now currently maintained by Microsoft.

Contributors