code_checker 1.0.0
Tool to check the quality of code for a review/inspection/PR
To use this package, run the following command in your project's root directory:
Manual usage
Put the following dependency into your project's dependences section:
This package provides sub packages which can be used individually:
code_checker:colorlog - std.experimental.logger with color support
code_checker:toml - D implementation of TOML
code_checker:unit-threaded - Advanced multi-threaded unit testing framework with minimal to no boilerplate using built-in unittest blocks
codechecker [![Build Status](https://dev.azure.com/wikodes/wikodes/apis/build/status/joakim-brannstrom.codechecker?branchName=master)](https://dev.azure.com/wikodes/wikodes/build/latest?definitionId=5&branchName=master)
code_checker is a tool that perform a quality check of C/C++ code. The intended use is as an automated sanity check of code before e.g. a pull request is accepted, a manual inspection by a human etc.
Getting Started
code_checker depends on the following software packages:
- D compiler (dmd 2.079+, ldc 1.8.0+)
- clang-tidy (4.0+)
For users running Ubuntu one of the dependencies can be installed with apt.
sudo apt install clang-tidy
Download the D compiler of your choice, extract it and add to your PATH shell variable.
# example with an extracted DMD
export PATH=/path/to/dmd/linux/bin64/:$PATH
Once the dependencies are installed it is time to download the source code to install code_checker.
git clone https://github.com/joakim-brannstrom/code_checker.git
cd code_checker
dub build -b release
Done! The binary is place in build/. Have fun. Don't be shy to report any issue that you find.
Config
The default configuration file that code_checker
uses s located at
<binary>/../default_code_checker.toml
. This can be changed via the
environment variable CODE_CHECKER_DEFAULT
.
The following configuration options can use {code_checker}
in the config to
replace it with the directory where the code_checker
binary is.
[iwyu] default_mapping_files
[iwyu] mapping_files
- Registered by Joakim Brännström
- 1.0.0 released 4 years ago
- joakim-brannstrom/code_checker
- BSL-1.0
- Copyright © 2018, Joakim Brännström
- Authors:
- Sub packages:
- code_checker:colorlog, code_checker:toml, code_checker:unit-threaded
- Dependencies:
- code_checker:toml, code_checker:colorlog
- Versions:
-
2.1.0 2024-Mar-25 2.0.0 2021-Sep-30 1.0.0 2020-Mar-08 0.0.7 2019-Oct-06 0.0.6 2019-Aug-03 - Download Stats:
-
-
0 downloads today
-
0 downloads this week
-
0 downloads this month
-
26 downloads total
-
- Score:
- 1.2
- Short URL:
- code_checker.dub.pm