diff --git a/docs/tools/cppcheck.md b/docs/tools/cppcheck.md new file mode 100644 index 00000000..04ac66d1 --- /dev/null +++ b/docs/tools/cppcheck.md @@ -0,0 +1,40 @@ +--- +title: Cppcheck +sidebar_label: Cppcheck +description: CodeRabbit's guide to Cppcheck. +--- + +[Cppcheck](https://cppcheck.sourceforge.io/) is a static code analysis tool for the C and C++ programming languages. + +## Files + +Cppcheck will run on files with the following extensions: + +- `.cpp` +- `.cxx` +- `.cc` +- `.c` +- `.tpp` +- `.txx` + +## Configuration + +CodeRabbit will use the following settings based on the profile selected: + +### Chill + +```shell +--disable=warning,style,information,portability,unusedFunction +``` + +### Assertive + +```shell +--disable=warning,style,information +``` + +CodeRabbit will use the default settings based on the profile selected if no config file is found. + +## Links + +- [Cppcheck Configuration](https://sourceforge.net/p/cppcheck/wiki/ListOfChecks/) diff --git a/docs/tools/tools.md b/docs/tools/tools.md index d8748e05..bbe4c69c 100644 --- a/docs/tools/tools.md +++ b/docs/tools/tools.md @@ -40,6 +40,7 @@ Remove extraneous f prefix | :-------------------------- | :--------------------------------------------------------- | | All | [Gitleaks][Gitleaks] | | CloudFormation | [Checkov][Checkov] | +| Cppcheck | [Cppcheck][Cppcheck] | | CSS | [Biome][Biome] | | Docker | [Hadolint][Hadolint], [Checkov][Checkov] | | GitHub Actions | [Actionlint][Actionlint] | @@ -83,3 +84,4 @@ Remove extraneous f prefix [Actionlint]: ./actionlint.md [Regal]: ./regal.md [PMD]: ./pmd.md +[Cppcheck]: ./cppcheck.md