template-project-cpp

C++ 项目模板。 本项目包含一个简单的命令行计算器 tpcpp。 该计算器基于 Robert Nystrom 的 Crafting Interpreters 一书中的代码实现。 项目文档地址：hampepper.github.io/template-project-cpp

目标

• ✅ 使用 cmake 构建项目
• ✅ 使用 ctest 进行单元测试
• ✅ 使用 doxygen + dot 生成文档
• ✅ 配置 pre-commit 以在提交前确认文件格式符合要求
• ✅ 配置 Github Actions 自动化构建项目并生成文档
• ✅ 自动配置开发环境
  • ✅ 在 Linux 下使用 nix 安装依赖
  • ✅ 在 Windows 下使用 PowerShell 脚本安装依赖

使用方法

克隆项目

git clone https://github.com/HamPepper/template-project-cpp.git
cd template-project-cpp
git submodule update --init --recursive  # 初始化子模块

安装依赖

Windows

pwsh -File .\tools\install-deps.ps1

Linux

# 使用 DeterminateSystems 的 Nix 安装器。该安装器自带 flake 支持
curl --proto '=https' --tlsv1.2 -sSf -L https://install.determinate.systems/nix | sh -s -- install
 
# 打开工程根目录，然后执行以下命令
nix develop
 
# 后续流程要在 nix develop 后的 shell 中执行

构建项目

Windows

cmake --preset msvc
cmake --build --preset debug
cmake --build --preset release
 
# 构建 doxygen 文档
cmake --build --preset debug --target doc

Linux

cmake --preset debug && cmake --build build/Debug
cmake --preset release && cmake --build build/Release
 
# 构建 doxygen 文档
cmake --build build/Debug --target doc

运行测试

Windows

ctest --test-dir build -C Debug --output-on-failure

Linux

ctest --test-dir build/Debug --output-on-failure