Repository files navigation

codeclimate-cppcheck is a Code Climate engine that wrapsCppcheck.You can run it on your command line using the Code Climate CLI, or on ourhosted analysis platform.

Cppcheck is a static analysis tool for C/C++ code.

1. If you haven't already,install the Code Climate CLI.
2. [optional] Runcodeclimate engines:install cppcheck to install the CodeClimate Cppcheck engine.
3. Configure your.codeclimate.yml file. See example below.
4. You're ready to analyze! Browse into your project's folder and runcodeclimate analyze. If you skipped step 2, the Cppcheck engine willautomatically be installed at this point, assuming it's enabled in.codeclimate.yml.

Like thecppcheck command line tool itself, you can configure variousaspects of the static analysis. Right now, the following options are supportedin.codeclimate.yml:

• check: issue categories to check.By default, no additional checks are enabled.Available values are:all,warning,style,performance,portability,information,unusedFunction, etc.Refer to the--enable= option ofcppcheck for more information.
• project: use Visual Studio project/solution (*.vcxproj/*sln) or compiledatabase (compile_commands.json) for files to analyse, include paths,defines, platform and undefines.Refer to the--project= option ofcppcheck for more information.
• language: forcescppcheck to check all files as the given language.Valid values are:c,c++.Refer to the--language= option ofcppcheck for more information.
• stds: multiple language standards to check against.Refer to the--std= option ofcppcheck for more information.
• platform: specifies platform specific types and sizes. Available builtinplatforms are:unix32,unix64,win32A,win32W,win64, etc.Refer to the--platform= option ofcppcheck for more information.
• library: specifies librarycfg files to be loaded. Refer to the--library= option ofcppcheck for more information.
• jobs: specifies the number of jobs for execution Refer to the-j <jobs> option ofcppcheck for more information.
• dump: create dump files during execution.Refer to the--dump option ofcppcheck for more information.
• defines: define preprocessor symbols.Refer to the-D option ofcppcheck for more information.
• undefines: undefine preprocessor symbols.Refer to the-U option ofcppcheck for more information.
• includes: paths for searching include files. First given path is searchedfor contained header files first. If paths are relative to source files,this is not needed.Refer to the-I option ofcppcheck for more information.
• max_configs: maximum number of configurations to check in a file beforeskipping it. Default is 12.max_configs can also be set toforce, whichforcescppcheck to check all configs.Refer to the--max-configs= and--force options ofcppcheck for moreinformation.
• inconclusive: allow reporting issues that are not inconclusive.Refer to the--inconclusive option ofcppcheck for more information.
• suppressions-list: suppress warnings listed in the file.Refer to the--suppressions-list option ofcppcheck for more information.
• inline-suppr: allow suppression of warnings with inline comments,for example:// cppcheck-suppress arrayIndexOutOfBounds.Refer to the--inline-suppr option ofcppcheck for more information

Additional options may be supported later.

An example.codeclimate.yml file:

version:"2"plugins:cppcheck:enabled:trueconfig:check:allproject:compile_commands.jsonlanguage:c++stds:        -c++11platform:unix64defines:      -"DEBUG=1"      -"__cplusplus"undefines:      -"DEBUG"includes:      -include/max_configs:42inconclusive:falsedump:falsedump:falsesuppressions-list:.cppcheck-suppressionsinline-suppr:truejobs:4library:googletest

For help withCppcheck, check out their documentation.

If you're running into a Code Climate issue, first look over this project'sGitHub Issues, as your question may have already been covered.If not,go ahead and open a support ticket with us.