IT数码 购物 网址 头条 软件 日历 阅读 图书馆
TxT小说阅读器
↓语音阅读,小说下载,古典文学↓
图片批量下载器
↓批量下载图片,美女图库↓
图片自动播放器
↓图片自动播放器↓
一键清除垃圾
↓轻轻一点,清除系统垃圾↓
开发: C++知识库 Java知识库 JavaScript Python PHP知识库 人工智能 区块链 大数据 移动开发 嵌入式 开发工具 数据结构与算法 开发测试 游戏开发 网络协议 系统运维
教程: HTML教程 CSS教程 JavaScript教程 Go语言教程 JQuery教程 VUE教程 VUE3教程 Bootstrap教程 SQL数据库教程 C语言教程 C++教程 Java教程 Python教程 Python3教程 C#教程
数码: 电脑 笔记本 显卡 显示器 固态硬盘 硬盘 耳机 手机 iphone vivo oppo 小米 华为 单反 装机 图拉丁
 
   -> 开发工具 -> C++ 项目中使用 Pre-commit 协助实现代码规范检查 -> 正文阅读

[开发工具]C++ 项目中使用 Pre-commit 协助实现代码规范检查

0. 前言

  • 多人项目开发需要统一代码规范,为了执行这些代码规范,需要有工具的辅助。
  • 目前选择的工具组合式:
    • precommit:在执行 git commit 的时候进行代码检查。具体执行的命令就是通过下面几个工具。
    • clang-format:代码格式检查(formatting工具,只检查格式)
    • cpplint:C++代码静态检查工具

1. 工具简单介绍

1.1 pre-commit 的简单使用

  • 官网
  • 第一步:安装,pip install pre-commit
  • 第二步:在项目根目录下添加配置文件 .pre-commit-config.yaml ,示例如下。
    • 需要注意的是 repo 的链接。pre-commit 会执行 git clone 命令,如果是 gitlab/github 的很可能在服务器上无法正常获取。
    • 在官方 Hook 列表中选择了 pocc/pre-commit-hooks,这个库中带有我们目前所有的工具(还有更多)。
fail_fast: false
repos:
  - repo: https://github.com/pocc/pre-commit-hooks
    rev: master
    hooks:
      - id: clang-format
        args: [--style=Google]
      - id: clang-tidy
      - id: oclint
      - id: uncrustify
      - id: cppcheck
      - id: cpplint
      - id: include-what-you-use
  • 第三步:根据配置文件安装hook,即在项目根目录下运行 pre-commit install
    • 注意,git hook 是 git 本身自带的功能,而不是 pre-commit 提供的,而pre-commit 实现的就是注册了一些 git 能够使用的 hook。
  • 第四步:在当前项目执行 git commit 时会自动进行代码检查。
    • 注意:git clone 命令应该是在此时执行,如果网速不够会失败。
    • 所有repo只需要clone一次,但我也没具体了解过clone到哪里。

1.2 clang-format

  • clang-format 是 Clang 编译器中的一个工具,是 C++ 代码 formatting(格式化)的最常用工具。

  • 安装:

    • ubuntu 下 apt install clang-format 就行
    • 如果是使用 pre-commit 工具,需要先安装
  • 文档:

  • 构建配置文件 .clang-format

    • 目前我只用到指定Google规范,其他的都无所谓。
BasedOnStyle: Google

1.3 cpplint

  • Google 出品的静态代码检查工具

  • 安装:

    • 直接通过 pip install cpplint 即可
    • 如果是通过 pre-commit 工具,需要先安装
  • 文档:要么直接看源码中的注释,要么通过 cpplint -h 来查看

  • 参数设置:如果需要设置参数,可以在 precommit 的配置文件中指定

  • 命令示例

cpplint --verbose=0 \
	--recursive \
	--exclude=build/* \
	--exclude=3rdparty/* \
	.

2. 最佳实践

  • 方便自己后续使用,记录一下。
  • 目标:部署 pre-commit 的 C++ Code Review 环境。
  • 步骤:
    • 准备配置文件。
    • 安装指定程序以及 git hook。

2.1 配置文件

  • 在项目根目录下新建名为 .pre-commit-config.yaml 的文件,内容如下
    • 注意,原始 repo 路径为 https://github.com/pocc/pre-commit-hooks,但由于公司连Github网速太慢,所以在公司git上上传了一份代码,然后使用公司内部的链接。同理,如果连Github网速慢,也可以放到gitee上。
repos:
  - repo: https://git.cethik.com/zhangyiyang/cpp-pre-commit-hooks.git
    rev: master
    hooks:
      - id: clang-format
        args: [--style=Google]
      - id: cpplint

2.2 安装依赖程序

  • 主要就是安装 pre-commit/clang-format/cpplint

  • Ubuntu 下安装与使用

sudo apt install cpplint
pip3 install pre-commit cpplint
pre-commit install
  开发工具 最新文章
Postman接口测试之Mock快速入门
ASCII码空格替换查表_最全ASCII码对照表0-2
如何使用 ssh 建立 socks 代理
Typora配合PicGo阿里云图床配置
SoapUI、Jmeter、Postman三种接口测试工具的
github用相对路径显示图片_GitHub 中 readm
Windows编译g2o及其g2o viewer
解决jupyter notebook无法连接/ jupyter连接
Git恢复到之前版本
VScode常用快捷键
上一篇文章      下一篇文章      查看所有文章
加:2022-04-28 12:03:57  更:2022-04-28 12:04:40 
 
开发: C++知识库 Java知识库 JavaScript Python PHP知识库 人工智能 区块链 大数据 移动开发 嵌入式 开发工具 数据结构与算法 开发测试 游戏开发 网络协议 系统运维
教程: HTML教程 CSS教程 JavaScript教程 Go语言教程 JQuery教程 VUE教程 VUE3教程 Bootstrap教程 SQL数据库教程 C语言教程 C++教程 Java教程 Python教程 Python3教程 C#教程
数码: 电脑 笔记本 显卡 显示器 固态硬盘 硬盘 耳机 手机 iphone vivo oppo 小米 华为 单反 装机 图拉丁

360图书馆 购物 三丰科技 阅读网 日历 万年历 2024年11日历 -2024/11/14 15:14:21-

图片自动播放器
↓图片自动播放器↓
TxT小说阅读器
↓语音阅读,小说下载,古典文学↓
一键清除垃圾
↓轻轻一点,清除系统垃圾↓
图片批量下载器
↓批量下载图片,美女图库↓
  网站联系: qq:121756557 email:121756557@qq.com  IT数码