Pre-commit 代码检查使用指南【免费下载链接】shmemCANN SHMEM 是面向昇腾平台的多机多卡内存通信库基于OpenSHMEM 标准协议实现跨设备的高效内存访问与数据同步。项目地址: https://gitcode.com/cann/shmem介绍本项目使用 pre-commit 框架在代码提交前自动执行代码质量检查确保代码风格一致、无常见错误。安装1. 安装 pre-commitpip install pre-commit2. 安装 git hooks推荐pre-commit install安装后每次git commit会自动运行检查。使用方式自动检查推荐安装 git hooks 后每次提交代码会自动触发检查git add . git commit -m your message如果检查失败部分工具会自动修复如 ruff-format、clang-format修复后重新提交即可。手动检查检查暂存的文件pre-commit run检查指定文件pre-commit run ruff-check --files path/to/file.py pre-commit run clang-format --files path/to/file.cpp检查单个 hookpre-commit run ruff-check pre-commit run pylint pre-commit run clang-format跳过检查不推荐git commit --no-verify -m your message检查工具说明工具语言功能配置文件ruffPython代码格式化 Lintpre-commit/pyproject.tomlpylintPython代码质量检查pre-commit/pyproject.tomlbanditPython安全漏洞检查pre-commit/pyproject.tomlcodespell通用拼写检查.pre-commit-config.yamltypos通用拼写检查pre-commit/typos.tomlclang-formatC/C代码格式化.clang-format配置文件说明主配置文件.pre-commit-config.yaml- 定义要运行的检查工具和参数Python 工具配置pre-commit/pyproject.toml- ruff、pylint、bandit 的规则配置C 格式化配置.clang-format- clang-format 的格式化规则拼写检查白名单pre-commit/typos.toml- typos 工具的误报白名单常见问题Q: 检查失败怎么办部分工具支持自动修复如 ruff-format、clang-format直接重新提交即可。对于需要手动修复的问题根据错误提示修改代码后重新提交。Q: 如何更新 pre-commit hookspre-commit autoupdateQ: 如何查看某个工具的详细错误信息pre-commit run pylint --verboseQ: 如何临时禁用某条规则Python (ruff/pylint):在代码行尾添加注释x 1 # pylint: disableinvalid-nameC (clang-format):使用注释包围// clang-format off int unformatted_code 1; // clang-format onQ: 首次运行很慢怎么办首次运行需要下载和安装各个检查工具的环境之后会使用缓存速度会快很多。最佳实践安装 git hooks使用pre-commit install自动检查每次提交不要频繁使用--no-verify跳过检查可能导致问题代码进入仓库及时更新 hooks定期运行pre-commit autoupdate获取最新版本配置 IDE 集成在 IDE 中配置 ruff、clang-format 插件实时检查【免费下载链接】shmemCANN SHMEM 是面向昇腾平台的多机多卡内存通信库基于OpenSHMEM 标准协议实现跨设备的高效内存访问与数据同步。项目地址: https://gitcode.com/cann/shmem创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考