Version: 1.1.1

教程：在 vscode 中集成

教程指导用户完成通过 CMake 和 Visual Studio Code 安装和使用包的过程。

本教程向您展示如何创建一个使用 C++“Hello World”程序包含 CMake、kmpkg 和 Visual Studio Code 的“fmt”库。你将安装依赖项、配置、构建和运行一个简单的应用程序。

先决条件

vscode
C++ compiler
Windows 7或者更高版本或者 ubuntu桌面或者 macos桌面
安装 kmpkg

1 - 安装`vscode`扩展

导航到扩展视图，然后安装 C++扩展。这将启用 C++ IntelliSense 和代码提示。

安装CMake工具扩展。这将在 Visual Studio Code 中启用 CMake 支持。

2 - Setup kmpkg

mkdir helloworld && cd helloworld

生成清单文件并添加依赖项

运行以下命令创建 kmpkg 清单文件 (kmpkg.json)：

kmpkg new --application

kmpkg new 命令添加一个 kmpkg.json 文件和一个项目目录中的 kmpkg-configuration.json 文件。

添加 fmt 包作为依赖项：

kmpkg add port fmt

您的 kmpkg.json 现在应该包含：

{
  "dependencies": [
    "fmt"
  ]
}

这是您的清单文件。 kmpkg 读取清单文件来了解什么安装依赖项并与 MSBuild 集成以提供依赖项您的项目需要。

生成的 kmpkg-configuration.json 文件引入了一个基线将最低版本限制放在项目的依赖关系。修改此文件超出了本教程的范围。尽管不适用于本教程，最好保留源代码控制下的 kmpkg-configuration.json 文件以确保版本不同开发环境之间的一致性。

warning

kmpkg 从 GITHUB 逐步迁移至 GITEE,在迁移过程中，kmpkg-configuration.json基线版本的基线存在仓库迁移带来的不可能安装问题，直接删除kmpkg-configuration.json即可

3 - 设置项目文件

创建包含以下内容的CMakeLists.txt文件：

    cmake_minimum_required(VERSION 3.10)

    project(HelloWorld)

    find_package(fmt CONFIG REQUIRED)

    add_executable(HelloWorld main.cpp)

    target_link_libraries(HelloWorld PRIVATE fmt::fmt)

现在，让我们分解一下 CMakeLists.txt 文件中每一行的作用：

cmake_minimum_required(VERSION 3.10)：指定构建项目所需的最低 CMake 版本为 3.10。如果系统上安装的 CMake 版本低于此版本，则会生成错误。
project(HelloWorld)：将项目名称设置为“HelloWorld”。
find_package(fmt CONFIG REQUIRED)：使用其 CMake 配置文件查找 fmt 库。 REQUIRED 关键字确保在找不到包时生成错误。
add_executable(HelloWorld main.cpp)：添加一个名为“HelloWorld”的可执行目标，该目标是从源文件“main.cpp”构建的。
target_link_libraries(HelloWorld PRIVATE fmt::fmt)：指定 HelloWorld 可执行文件应链接到 fmt 库。 “PRIVATE”关键字表示“fmt”仅用于构建“HelloWorld”，不应传播到其他依赖项目。

创建包含以下内容的“main.cpp”文件：

#include <fmt/core.h>

int main() {
    fmt::print("Hello World!\n");
    return 0;
}

在此main.cpp文件中，包含<fmt/core.h>头文件以使用“fmt”库。然后 main() 函数调用 fmt::print() 来输出“Hello World!”消息到控制台。

为了让 CMake 项目系统能够识别 kmpkg 提供的 C++ 库，您需要提供 kmpkg.cmake 工具链文件。为了自动化此操作，在 helloworld 目录中创建一个 CMakePresets.json 文件以下内容

{
  "version": 2,
  "configurePresets": [
    {
      "name": "kmpkg",
      "generator": "Ninja",
      "binaryDir": "${sourceDir}/build",
      "cacheVariables": {
        "CMAKE_TOOLCHAIN_FILE": "$env{KMPKG_CMAKE}"
      }
    }
  ]
}

在 helloworld 目录中创建 CMakeUserPresets.json 文件以下内容：

{
  "version": 2,
  "configurePresets": [
    {
      "name": "default",
      "inherits": "kmpkg",
      "environment": {
        "KMPKG_ROOT": "<path to kmpkg>"
      }
    }
  ]
}

这个 CMakePresets.json 文件包含一个用于 CMake 的 kmpkg 预设设置 CMAKE_TOOLCHAIN_FILE 变量。 CMAKE_TOOLCHAIN_FILE 允许 CMake 项目系统可识别 kmpkg 提供的 C++ 库。仅有的 CMakePresets.json 的目的是检查到源代码管理，同时 CMakeUserPresets.json 将在本地使用。

4 - 构建并运行项目

通过导航到 View > Command Palette 中的 Command Palette，运行项目的“CMake: Build”命令

选择“默认”CMake 预设。这将启用 kmpkg 工具链。

启动项目

您应该看到输出：

Hello World!

后续步骤

要了解有关 kmpkg.json 的更多信息，请参阅我们的参考文档：

先决条件​

1 - 安装vscode扩展​

2 - Setup kmpkg​

3 - 设置项目文件​

后续步骤​

先决条件

1 - 安装`vscode`扩展

2 - Setup kmpkg

3 - 设置项目文件

后续步骤