🎨 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:
+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