cxx-dev-tools

Linter, CMake, GH Hooks and other tools for standardizing CXX projects.

Overview

This repo provides a growing list of tools.

• CMake linter
• CXX linter
• Git hooks

This tools aim to support best coding practices like linting files, configuring a Git pre-commit hook, etc.

The main motivation for developing these tools is to address an issue that typically affects code bases that are organized into multiple repositories. In the example of a CMake linter:

1. each repository may host a copy of the configuration that the linter must use
2. each repository may define a different version of the linter

Both elements contribute to introduce discrepancies in the code formatting and make the maintenance of the code base across multiple repositories more difficult.

The solution proposed is to define both tools and configurations in one repository. This repository can then be added as a Git submodule to multiple repositories that will then benefit from the same tools and configurations.

Requirements

The following programs must be installed before using the tools provided by the repository.

• cmake-format
• cmake-lint
• clang-format

An example of how to install these programs is given in this Dockerfile.

Usage

If you want to use the tool versions and configurations defined in this repository, simply add it as a git submodule to your projects.

git submodule add -b master https://github.com/tschaffter/cxx-dev-tools.git cxx-dev-tools

Run the following command to add the CXX dev tools to the PATH.

cd dev-cxx-tools && . export.sh

If you want to customize the tool versions and configuration, then fork this repository before adding it as a submodule to your projects.

Tools

cxxdt-cmake-lint

Checks if the format of the specified CMake files is compliant with the CMake style configuration defined in this repository (cmake/config).

$ cxxdt-cmake-lint test/cmake-lint/samples/invalid-format.cmake
test/cmake-lint/samples/invalid-format.cmake
============================================
test/cmake-lint/samples/invalid-format.cmake:10,04: [C0305] too many newlines between statements

Summary
=======
files scanned: 1
found lint:
  Convention: 1

$ echo $?
1

$ cxxdt-cmake-lint test/cmake-lint/samples/valid-format.cmake
test/cmake-lint/samples/valid-format.cmake
==========================================

Summary
=======
files scanned: 1
found lint:

$ echo $?
0

The exit status returned is 0 if the format of the file is valid.

If no CMake files are specified, cxxdt-cmake-lint tries to read a list CMake files from ./.cxxdt-cmake-lint (one file/file expression per line). The following command is used in the CI configuration of this repo to check that the CMake module BuildType.cmake is correctly formatted.

$ cxxdt-cmake-lint
cmake/BuildType.cmake
=====================

Summary
=======
files scanned: 1
found lint:

$ echo $?
0

cxxdt-cmake-format

Formats the specified CMake files using the CMake style configuration defined in this repository. The CML interface is the same as cxxdt-cmake-lint.

cxxdt-cxx-lint

Checks if the format of the specified CXX files is compliant with the CXX style configuration defined in this repository (cxx/config). The CML interface is the same as cxxdt-cmake-lint.

cxxdt-cxx-format

Formats the specified CXX files using the CXX style configuration defined in this repository. The CML interface is the same as cxxdt-cmake-lint.

GitHub tools

• .githook/pre-commit - Validates .circleci/config.yml before acceptiing a commit.

Continuous Integration

An example of integration of cxx-dev-tools into a CI configuration is available in .circleci/config.yml.

Related open source projects

Projects	Description
tschaffter/cxx-ci	CXX build and test environment
tschaffter/esp-idf-ci	ESP-IDF build and test environment

Contributing change

Please read the CONTRIBUTING.md for details on how to contribute to this project.