🎨 style(markdown): format all markdown files with prettier
- 使用 prettier 格式化所有 markdown 文件 - prose-wrap: always, print-width: 80 - 保持代码块和表格格式 - 提升可读性和一致性 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
This commit is contained in:
Claude Sonnet 4.5
+9
-4
@@ -1,6 +1,7 @@
|
||||
# clangd 补全配置（`.clangd`）
|
||||
|
||||
本章节提供 `clangd` 的推荐配置模板与落地要点（参考 `tsl-devkit/lsp-server/.clangd`）。
|
||||
本章节提供 `clangd` 的推荐配置模板与落地要点（参考
|
||||
`tsl-devkit/lsp-server/.clangd`）。
|
||||
|
||||
## 1. 目标
|
||||
|
||||
@@ -9,15 +10,19 @@
|
||||
|
||||
## 2. 必要前提：生成 `compile_commands.json`
|
||||
|
||||
- CMake：建议开启 `CMAKE_EXPORT_COMPILE_COMMANDS=ON`（本 Playbook 的 `templates/cpp/CMakeLists.txt` 已开启）。
|
||||
- CMake：建议开启 `CMAKE_EXPORT_COMPILE_COMMANDS=ON`（本 Playbook 的
|
||||
`templates/cpp/CMakeLists.txt` 已开启）。
|
||||
- 使用 preset 构建后，在对应 build 目录会生成 `compile_commands.json`：
|
||||
- 例如：`build/windows-x86_64-clang-cross/Release/compile_commands.json`
|
||||
|
||||
## 3. `.clangd` 模板
|
||||
|
||||
- 模板文件：`templates/cpp/.clangd`
|
||||
- 关键字段：`CompileFlags.CompilationDatabase` 指向 build 目录（包含 `compile_commands.json` 的目录）。
|
||||
- 关键字段：`CompileFlags.CompilationDatabase` 指向 build 目录（包含
|
||||
`compile_commands.json` 的目录）。
|
||||
|
||||
## 4. Modules 注意事项（C++23）
|
||||
|
||||
- 若新增/删除/重命名 `.cppm`，必须同步更新构建系统的模块清单（例如 CMake `FILE_SET CXX_MODULES`），否则 `compile_commands.json` 可能缺项，导致 clangd 补全/跳转不稳定。
|
||||
- 若新增/删除/重命名 `.cppm`，必须同步更新构建系统的模块清单（例如 CMake
|
||||
`FILE_SET CXX_MODULES`），否则 `compile_commands.json`
|
||||
可能缺项，导致 clangd 补全/跳转不稳定。
|
||||
|
||||
+14
-6
@@ -22,7 +22,8 @@ cpp/
|
||||
### 1.2 文件扩展名约定
|
||||
|
||||
- 头文件：`.h`（Google 风格；若项目已统一 `.hpp`，以项目既有为准）
|
||||
- 源文件：`.cc`（优先；`main` 入口建议使用 `main.cc`；若项目已统一 `.cpp`，以项目既有为准）
|
||||
- 源文件：`.cc`（优先；`main` 入口建议使用 `main.cc`；若项目已统一
|
||||
`.cpp`，以项目既有为准）
|
||||
- Module Interface Unit：`.cppm`（推荐统一）
|
||||
- Module Partition：`.cppm`（在文件名中体现分区，例如 `foo_part.cppm`）
|
||||
|
||||
@@ -31,9 +32,13 @@ cpp/
|
||||
- Module 名称建议使用“点分层级”组织，且每一段使用 `lower_snake_case`：
|
||||
- 示例：`my_project.net.http`
|
||||
- 文件路径与 module 名建议可映射（便于检索）：
|
||||
- `cpp/modules/my_project/net/http.cppm` → `export module my_project.net.http;`
|
||||
- 避免在同一模块内混用“头文件边界”和“模块边界”造成可见性混乱；对外 API 优先通过 `export` 暴露。
|
||||
- 工程约束：新增/删除/重命名 `.cppm`（或变更 `export module ...`）时，必须同步更新构建系统的模块清单（例如 CMake 的 `target_sources(FILE_SET CXX_MODULES ...)`），否则容易出现“本地能编、CI/他人机器不能编”的漂移。
|
||||
- `cpp/modules/my_project/net/http.cppm` →
|
||||
`export module my_project.net.http;`
|
||||
- 避免在同一模块内混用“头文件边界”和“模块边界”造成可见性混乱；对外 API 优先通过
|
||||
`export` 暴露。
|
||||
- 工程约束：新增/删除/重命名 `.cppm`（或变更
|
||||
`export module ...`）时，必须同步更新构建系统的模块清单（例如 CMake 的
|
||||
`target_sources(FILE_SET CXX_MODULES ...)`），否则容易出现“本地能编、CI/他人机器不能编”的漂移。
|
||||
|
||||
## 2. 格式（Formatting）
|
||||
|
||||
@@ -42,7 +47,8 @@ cpp/
|
||||
- 本仓库/标准默认：`clang-format` + Google 风格。
|
||||
- 建议在项目根目录提供 `.clang-format` 并纳入 CI/本地钩子。
|
||||
- 列宽建议与本 Playbook 其他语言保持一致：默认 100（可按项目调整，但要全仓一致）。
|
||||
- 模板：`templates/cpp/.clang-format`（参考 `tsl-devkit/lsp-server/.clang-format` 并做了最小化泛化）。
|
||||
- 模板：`templates/cpp/.clang-format`（参考
|
||||
`tsl-devkit/lsp-server/.clang-format` 并做了最小化泛化）。
|
||||
|
||||
### 2.2 通用格式约定
|
||||
|
||||
@@ -67,6 +73,8 @@ cpp/
|
||||
|
||||
## 5. Windows 支持
|
||||
|
||||
- 本规范假设 **不做原生 Windows 开发环境支持**；Windows 产物通过 **Linux 上的 Clang 交叉编译工具链**获得（工具链路径/三元组等由项目的 Conan profile 或 toolchain 文件定义）。
|
||||
- 本规范假设 **不做原生 Windows 开发环境支持**；Windows 产物通过
|
||||
**Linux 上的 Clang 交叉编译工具链**获得（工具链路径/三元组等由项目的 Conan
|
||||
profile 或 toolchain 文件定义）。
|
||||
- 如需条件编译，优先用标准特性检测与最小化条件编译，并写清动机（例如 ABI/平台差异）。
|
||||
- 对路径、换行、编码、大小写敏感等行为要明确约束并在文档/测试中覆盖。
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
# C++ 第三方依赖（Conan）
|
||||
|
||||
本章节给出 Conan + CMake 的推荐落地方式（参考 `tsl-devkit/lsp-server/` 的实践）。
|
||||
本章节给出 Conan + CMake 的推荐落地方式（参考 `tsl-devkit/lsp-server/`
|
||||
的实践）。
|
||||
|
||||
## 1. 基本约定
|
||||
|
||||
@@ -32,7 +33,9 @@ cpp/
|
||||
- `linux-...`：产物平台为 Linux（`[settings] os=Linux`）
|
||||
- `windows-...`：产物平台为 Windows（`[settings] os=Windows`）
|
||||
- 跨编译 profile 建议以 `-cross` 结尾（例如 `windows-x86_64-clang-cross`）。
|
||||
- “工具链版本”以 profile 的 `[settings] compiler.version` 为准；如同一仓库并存多版本 clang，可将版本体现在文件名中（例如 `linux-x86_64-clang20`）。
|
||||
- “工具链版本”以 profile 的 `[settings] compiler.version`
|
||||
为准；如同一仓库并存多版本 clang，可将版本体现在文件名中（例如
|
||||
`linux-x86_64-clang20`）。
|
||||
|
||||
## 4. 安装与构建（推荐流程）
|
||||
|
||||
@@ -49,13 +52,16 @@ cpp/
|
||||
3. 构建：
|
||||
- `cmake --build --preset conan-release -j 8`
|
||||
|
||||
提示：如遇到 Conan 缓存/家目录权限问题，可临时设置 `CONAN_HOME=/tmp/conan-home` 再执行。
|
||||
提示：如遇到 Conan 缓存/家目录权限问题，可临时设置 `CONAN_HOME=/tmp/conan-home`
|
||||
再执行。
|
||||
|
||||
## 5. CMake Presets（推荐做法）
|
||||
|
||||
Conan 2 可以生成 CMake Presets（通常落在 `build/<...>/generators/CMakePresets.json`）。
|
||||
Conan 2 可以生成 CMake Presets（通常落在
|
||||
`build/<...>/generators/CMakePresets.json`）。
|
||||
|
||||
推荐将一个稳定的 `CMakeUserPresets.json` 放进仓库并 include 生成文件（参考 `tsl-devkit/lsp-server/CMakeUserPresets.json`），例如：
|
||||
推荐将一个稳定的 `CMakeUserPresets.json` 放进仓库并 include 生成文件（参考
|
||||
`tsl-devkit/lsp-server/CMakeUserPresets.json`），例如：
|
||||
|
||||
```json
|
||||
{
|
||||
|
||||
+20
-9
@@ -10,7 +10,8 @@
|
||||
- 编译器：
|
||||
- 目标平台：Windows（通过 Linux 交叉编译）
|
||||
- 主机平台：Linux
|
||||
- 工具链：`clang <版本>`（交叉编译；具体 clang 可执行路径由 Conan profile 配置）
|
||||
- 工具链：`clang <版本>`（交叉编译；具体 clang 可执行路径由 Conan
|
||||
profile 配置）
|
||||
- 目标三元组（示例）：`x86_64-w64-mingw32` / `aarch64-w64-mingw32`
|
||||
|
||||
### 1.2 构建系统
|
||||
@@ -24,15 +25,19 @@
|
||||
若项目使用 Conan 管理三方依赖，建议：
|
||||
|
||||
- Conan：`2.x`（本 Playbook 假设 Conan 2；不保证 Conan 1 的兼容性）
|
||||
- 使用 `conanfile.txt` + `CMakeDeps` + `CMakeToolchain` + `cmake_layout`（参考 `tsl-devkit/lsp-server/conanfile.txt`）。
|
||||
- 通过 `conan install` 生成工具链与（可选）CMake Presets，再用 `cmake --preset ...` 构建。
|
||||
- 使用 `conanfile.txt` + `CMakeDeps` + `CMakeToolchain` + `cmake_layout`（参考
|
||||
`tsl-devkit/lsp-server/conanfile.txt`）。
|
||||
- 通过 `conan install` 生成工具链与（可选）CMake Presets，再用
|
||||
`cmake --preset ...` 构建。
|
||||
|
||||
### 1.4 格式化（必选）
|
||||
|
||||
- `clang-format`：`<项目自选并固定版本>`
|
||||
- 兼容性策略：
|
||||
- `.clang-format` 是唯一真相（推荐使用 `templates/cpp/.clang-format` 落地到项目根目录）。
|
||||
- 不同版本的 `clang-format` 可能对同一配置产生不同输出；项目应在 CI/开发环境中固定版本，避免格式漂移。
|
||||
- `.clang-format` 是唯一真相（推荐使用 `templates/cpp/.clang-format`
|
||||
落地到项目根目录）。
|
||||
- 不同版本的 `clang-format`
|
||||
可能对同一配置产生不同输出；项目应在 CI/开发环境中固定版本，避免格式漂移。
|
||||
- CI 推荐用 `clang-format --dry-run --Werror <files...>` 做格式校验。
|
||||
|
||||
### 1.5 静态检查（暂不启用）
|
||||
@@ -69,12 +74,18 @@
|
||||
|
||||
参考 `tsl-devkit` 的做法：
|
||||
|
||||
- 将 `CMakeUserPresets.json` 纳入版本控制，并 `include` Conan 生成的 `build/.../generators/CMakePresets.json`。
|
||||
- 将 `CMakeUserPresets.json` 纳入版本控制，并 `include` Conan 生成的
|
||||
`build/.../generators/CMakePresets.json`。
|
||||
- 优点：统一 Windows/Linux/macOS 构建入口；Agent 也更容易用固定命令验证。
|
||||
|
||||
本 Playbook 约定：
|
||||
|
||||
- **强制统一 preset 名称**：`conan-release` / `conan-debug`（项目必须提供这两个 preset；实现方式不限：可由 Conan 生成，也可由项目自建 `CMakePresets.json` 适配）。
|
||||
- `CMakeUserPresets.json` 不是强制标准，仅作为一种推荐落地方式（模板见 `templates/cpp/CMakeUserPresets.json`）。
|
||||
- **强制统一 preset 名称**：`conan-release` /
|
||||
`conan-debug`（项目必须提供这两个 preset；实现方式不限：可由 Conan 生成，也可由项目自建
|
||||
`CMakePresets.json` 适配）。
|
||||
- `CMakeUserPresets.json` 不是强制标准，仅作为一种推荐落地方式（模板见
|
||||
`templates/cpp/CMakeUserPresets.json`）。
|
||||
|
||||
不在本 Playbook 中强制规定工具链分发方式（例如某种特定打包形态）；只要求把交叉编译所需的 `compiler_executables`、triplet、system_name 等写进 Conan profile，保证命令可复现。
|
||||
不在本 Playbook 中强制规定工具链分发方式（例如某种特定打包形态）；只要求把交叉编译所需的
|
||||
`compiler_executables`、triplet、system_name 等写进 Conan
|
||||
profile，保证命令可复现。
|
||||
|
||||
Reference in New Issue
Block a user