daverona/pre-commit-cpp repository overview

⁠daverona/pre-commit/cpp

This is a set of C/C++ hooks for pre-commit framework⁠.

• GitLab repository: https://gitlab.com/daverona/pre-commit/cpp⁠
• Docker registry: https://hub.docker.com/r/daverona/pre-commit-cpp⁠
• Available releases: https://gitlab.com/daverona/pre-commit/cpp/-/releases⁠

⁠Overview

C/C++ hooks provided are:

• clang-format⁠: formatter of C/C++ code based on a style guide
• cpplint⁠: linter (or style-error detector) for Google C++ Style Guide⁠
• cppcheck⁠: static analyzer of C/C++ code
• docker-clang-format: docker-version clang-format hook
• docker-cpplint: docker-version cpplint hook
• docker-clang-format: docker-version clang-format hook

⁠Hook Prerequisites

• clang-format hook requires clang-format executable. Use brew (on macOS) or apt-get (on Ubuntu) to install it. For Windows, please read http://releases.llvm.org/download.html⁠.
• cppcheck hook requires cppcheck executable. Use brew (on macOS) or apt-get (on Ubuntu) to install it. For Windows, please read http://cppcheck.sourceforge.net/#download⁠.

⁠Hook Installation

To use C/C++ hooks, add the following code block to your .pre-commit-config.yaml:

- repo: https://gitlab.com/daverona/pre-commit/cpp
  rev: 0.8.0                 # use the most recent version
  hooks:
  # Hooks using native
  - id: clang-format         # formatter for C/C++ code based on a style guide
  - id: cpplint              # linter (or style-error checker) for Google C++ Style Guide
  - id: cppcheck             # static analyzer for C/C++ code
  # Hooks using Docker
  - id: docker-clang-format  # clang-format in Docker container
  - id: docker-cpplint       # cpplint in Docker container
  - id: docker-cppcheck      # cppcheck in Docker container

⁠Hook Configuration

⁠clang-format

clang-format hook uses Google style (as described in Google C++ Style Guide⁠) by default. If you like to use a different style, say LLVM Coding Standards⁠, please add args to the hook to override the default style:

- repo: https://gitlab.com/daverona/pre-commit/cpp
  rev: 0.8.0               # use the most recent version
  hooks:
  - id: clang-format
    args: ["-style=LLVM"]  # use LLVM Coding Standards

Available styles are LLVM, Google, Chromium, Mozilla, and WebKit.

⁠References

• pre-commit framework: https://pre-commit.com/⁠
• pre-commit supported hooks: https://pre-commit.com/hooks.html⁠
• caramelomartins/awesome-linters: https://github.com/caramelomartins/awesome-linters#cc⁠
• clang-format homepage: https://clang.llvm.org/docs/ClangFormat.html⁠
• clang-format man: http://manpages.ubuntu.com/manpages/xenial/en/man1/clang-format-3.5.1.html⁠
• cpplint homepage: https://github.com/cpplint/cpplint⁠
• cppcheck homepage: http://cppcheck.sourceforge.net/⁠
• cppcheck man: http://www.polarhome.com/service/man/?qf=cppcheck&tf=2&of=Ubuntu&sf=1⁠
• LLVM Coding Standards: http://llvm.org/docs/CodingStandards.html⁠
• Google C++ Style Guide: http://google.github.io/styleguide/cppguide.html⁠
• Chromium C++ Style Guide: https://chromium.googlesource.com/chromium/src/+/master/styleguide/c++/c++.md⁠
• Mozilla Coding Style Guide: https://www-archive.mozilla.org/hacking/mozilla-style-guide.html⁠
• WebKit Code Style Guidelines: https://webkit.org/code-style-guidelines/⁠