cmake init

cmake-init缺失的CMAKE项目初始化器

cmake-init是一个自以为是的CMAKE项目初始化器，生成了准备好的CMAKE项目，这些项目已准备就绪，单独的消费者和开发人员目标，为安装规则提供适当的可重新定位的CMAKE软件包并使用现代CMAKE（3.14+）。

请参阅Wiki，例如CMAKE-INIT的输出以及为CMAKE实施的功能的其他务实示例，例如软件包管理人员，绒毛测试，超级建筑等。

使用预设的最小配置的VSCODE集成：

使用预设的最小配置与最小配置集成：

如果您想与我联系以获取与CMake有关的任何与CMAKE有关的事情，那么您可能会在C ++ Slack的#cmake频道中找到我。如果您想知道的是特定于CMAKE-INIT，那么您也可以在此存储库的讨论中提出问题。

目标

• 易于使用
  该脚本允许您只需捣碎即可为您提供一个可执行文件的正确设置项目。您想要一个仅限标题库吗？提示时选择h静态/共享库？提示时只需选择s即可。简单正确！
• 创建FetchContent准备就绪项目
  这很重要，因为在接近功能中，这可能会使Cmake可以以类似于其他语言的琐碎方式消费其他项目，例如JavaScript的情况（NPM）。
• 干净分开的开发人员和消费者目标
  这也与上一点有关，但是项目的开发人员和消费者有不同的需求，分开目标实现了这一目标。开发人员应该能够运行测试，添加警告标志，运行基准等，而消费者（例如软件包维护者）通常只想构建库或可执行文件本身，而无需在CMAKE脚本中进行修补。向您的包裹维护者展示一些爱！
• 使用现代CMAKE（3.14+）
  互联网上有太多过时的错误示例，现在该改变这一点了。
• 简化工具的使用
  代码覆盖范围（GCOV），代码覆盖和格式（clang-Format），静态分析（Clang-Tidy）和动态分析（SanItizers，Valgrind）都是指导开发人员创建更好软件的非常有用的方法，因此它们应该易于使用。

相关会议对话

• 肯尼斯·霍斯特（Kenneth Hoste） - 如何使包装管理者哭泣
• 罗伯特·舒马赫（Robert Schumacher） - 不要打包您的图书馆，写包装的图书馆！ （第1部分）
• 罗伯特·舒马赫（Robert Schumacher） - 不要打包您的图书馆，写包装的图书馆！ （第2部分）
• 克雷格·斯科特（Craig Scott） - 图书馆作者的Deep Cmake

非目标

• 涵盖所有可能的项目结构
  作为初始脚本，这样做是毫无意义的，因为人们一直在构建软件的方式太多了，如果您有特殊需求，您应该已经知道CMake，并且可以自己设置该项目。
• 生成文件并显示GitHub以外的网站的提示
  虽然我了解反对GitHub（以及代理Microsoft）的人，但它是迄今为止最常用的网站，但特定于其的文件和消息的数字很小，并且很容易适用于任何其他服务。

安装

确保安装了这些程序：

• Python 3.8或更新
• CMAKE 3.20或更新（3.21或更新的C17或更新项目）
• git
• Clang Tidy 14（可选）
• CPPCHECK（可选）
• doxygen <1.9（可选）
• LCOV（可选）
• clang-Format 14（可选）
• codespell（可选）
• 软件包经理：柯南或vcpkg（可选）

---

笔记

如果您想使用Visual Studio，则其中一些工具也可以在Windows上使用，但是必须安装这些插件：

• https://clangpowertools.com/
• https://github.com/violetgiraffe/cppcheck-vs-addin

---

该软件包可从PYPI下载。您可以使用pip安装此软件包：

pip install cmake-init

叮当声

Clang-Tidy是一种静态分析工具，可帮助您在编译之前在代码中发现逻辑错误。该脚本为您提供了在dev预设中继承clang-tidy预设的选项，从而为此工具提供了CMAKE集成。

CI始终为您运行Clang Tidy，因此在本地安装和使用它是完全可选的，但建议使用它。

对于Windows用户，如果您想使用clang-tidy，则必须安装忍者并将dev预设中的generator字段设置为Ninja 。这样做的原因是，只有Makefiles和Ninja才能与Clang-Tidy一起使用Cmake。对于其他发电机，此功能是无操作的。

CPPCHECK

Cppcheck是类似于Clang-Tidy的静态分析工具，但是它们检测到的内容的重叠是最小的，因此使用两者都是有益的。该脚本为您提供了在dev预设中继承cppcheck预设的选项，从而为此工具提供了CMAKE集成。

CI将始终为您运行Cppcheck，因此在本地安装和使用它是完全可选的，但建议使用它。

对于Windows用户，如果您想使用CPPCheck，则必须安装忍者并将dev预设中的generator字段设置为Ninja 。这样做的原因是，只有Makefiles和Ninja才能与Cppcheck一起使用Cmake。对于其他发电机，此功能是无操作的。

doxygen

doxygen是从注释源代码生成文档的工具。与此结合使用，M.CSS用于展示生成的文档。

生成的项目将在开发人员模式下具有docs目标，该目标可用于将文档构建到<binary-dir>/docs/html目录中。

安装doxygen后，请确保PATH中存在doxygen可执行文件，否则您可能会收到令人困惑的错误消息。

可以使用生成的CI工作流中的docs作业将该文档部署到GitHub页面上。按照工作中剩下的评论启用这一点。

注意：M.CSS与doxygen> = 1.9不使用。您可以安装1.8.20来使用docs目标。请参阅问题＃41和＃48。

LCOV

LCOV是处理由GCC的gcov仪器生成的覆盖范围信息的工具。此覆盖范围信息可用于查看程序的哪些部分执行。

如果启用了ENABLE_COVERAGE变量，则生成的项目将在开发人员模式下具有coverage目标。使用单独的目标而不是CTEST内置coverage步骤的原因是因为它缺乏必要的自定义。该目标应在测试后运行，默认情况下，它将在<binary-dir>/coverage.info上生成报告，并在<binary-dir>/coverage_html目录上生成一个HTML报告。

对于Windows用户，您可以使用一个称为OpenCppCoverage的类似工具，为此，生成的cmake目录中有一个示例脚本。该脚本以示例为例，因为Linux VM在GitHub Action中启动并更快地运行，因此它用于覆盖范围。

叮当声

Clang-Format是LLVM工具套件的一部分，类似于Clang-Tidy。它是代码衬里和代码格式器，可用于执行样式指南。

分别使用format-check和format-fix代码两个目标。

注意：该项目生成了根据Clang-Format 14的格式化的文件。更新或以上的版本可能以不同的方式格式化该项目。

代码

CODESPELL是主要在源代码中查找和修复拼写错误的工具。

分别使用spell-check和拼写修正目标可以在开发人员模式下检查和修复两个目标，以检查和spell-fix拼写错误。

包装经理

-p标志可用于为项目选择一个软件包管理器。标志的论点可能是：

• none ：没有包装管理器集成（默认）
• conan ：柯南整合
• vcpkg ：VCPKG集成

使用软件包管理器时，生成的项目中使用以下软件包：

• C ++，JSON-C和Hedley（仅EXE）的FMT用于C项目
• Catch2作为C ++和C项目的DEV依赖性

确保阅读生成的黑客文档，以查看需要做什么才能获得依赖。

用法

• cmake-init [--c] <path>
  此命令将在提供的位置以及提示的答案中创建一个CMAKE项目。您可以在之后通过-s ， -e或-h标志，以快速创建共享库，可执行文件或仅标题库。 --c开关将将生成的项目的类型设置为C而不是C ++。
• cmake-init --help
  显示更多标志和开关的帮助屏幕。

许可

cmake-init是免费软件：您可以按照自己的意愿使用，学习，共享和改进。具体来说，您可以根据自由软件基金会发布的GNU通用公共许可证的条款重新分配和/或对其进行修改，该版本是该许可证的第3版，或（（可根据您的选项））任何以后的版本。

目录cmake-init/templates的内容使用非执行许可证获得许可。有关更多详细信息，请参见该目录中的许可证。