codeclimate cppcheck

Code Klima cppcheck Engine

codeclimate-cppcheck ist eine Code-Klima-Engine, die CPPCheck umrundet. Sie können es auf Ihrer Befehlszeile mit der Code -Klima -CLI oder auf unserer gehosteten Analyseplattform ausführen.

CPPcheck ist ein statisches Analysetool für C/C ++ - Code.

Installation

1. Wenn Sie es noch nicht getan haben, installieren Sie die Codeklima -CLI.
2. [Optional] codeclimate engines:install cppcheck um die CPPcheck -Engine der Code zu installieren.
3. Konfigurieren Sie Ihre .codeclimate.yml -Datei. Siehe Beispiel unten.
4. Sie sind bereit zu analysieren! Suchen Sie in den Ordner Ihres Projekts und führen Sie codeclimate analyze aus. Wenn Sie Schritt 2 übersprungen haben, wird der CPPcheck -Engine an diesem Punkt automatisch installiert, sofern er in .codeclimate.yml aktiviert ist.

Konfiguration

Wie das cppcheck -Befehlszeilen -Tool selbst können Sie verschiedene Aspekte der statischen Analyse konfigurieren. Derzeit werden die folgenden Optionen in .codeclimate.yml unterstützt:

• check : Ausgebenkategorien zu überprüfen. Standardmäßig sind keine zusätzlichen Schecks aktiviert. Verfügbare Werte sind: all , warning , style , performance , portability , information , unusedFunction usw. Weitere Informationen finden Sie in der Option --enable= Option von cppcheck .
• project : Verwenden Sie Visual Studio Project / Lösung ( *.vcxproj / *sln ) oder kompilieren Sie die Datenbank ( compile_commands.json ) für Dateien zur Analyse, Pfade, Definieren, Plattform und Unfines. Weitere Informationen finden Sie in der --project= Option von cppcheck .
• language : erzwingt cppcheck , alle Dateien als angegebene Sprache zu überprüfen. Gültige Werte sind: c , c++ . Weitere Informationen finden Sie in der Option --language= cppcheck .
• stds : Mehrere Sprachstandards, gegen die Sie überprüfen sollten. Weitere Informationen finden Sie in der Option --std= cppcheck .
• platform : Gibt plattformspezifische Typen und Größen an. Verfügbare integrierte Plattformen sind: unix32 , unix64 , win32A , win32W , win64 usw. Weitere Informationen finden Sie in der --platform= Option von cppcheck .
• library : Gibt die zu geladene cfg an. Weitere Informationen finden Sie in der Option --library= cppcheck .
• jobs : Legt die Anzahl der Ausführungsjobs an, die auf die Option -j <jobs> cppcheck -Option für weitere Informationen beziehen.
• dump : Erstellen Sie Dumpdateien während der Ausführung. Weitere Informationen finden Sie in der Option --dump -Option von cppcheck .
• defines : Definieren von Präprozessorensymbolen. Weitere Informationen finden Sie in der Option -D -Option von cppcheck .
• undefines : Unfeiner Präprozessor -Symbole. Weitere Informationen finden Sie in der Option -U -Option von cppcheck .
• includes : Pfade für die Suche in Einbeziehung von Dateien. Der erste angegebene Pfad wird zuerst nach enthaltenen Header -Dateien gesucht. Wenn Pfade relativ zu Quelldateien sind, ist dies nicht erforderlich. Weitere Informationen finden Sie in der Option -I -Option von cppcheck .
• max_configs : Maximale Anzahl von Konfigurationen zum Einchecken in einer Datei, bevor Sie sie überspringen. Standard ist 12. max_configs kann ebenfalls auf force eingestellt werden, was cppcheck dazu zwingt, alle Konfigurationen zu überprüfen. Weitere Informationen finden Sie in den Optionen --max-configs= und --force -Optionen von cppcheck .
• inconclusive : Berichterstattung von Meldeproblemen zulassen, die nicht nicht schlüssig sind. Weitere Informationen finden Sie in der Option --inconclusive von cppcheck .
• suppressions-list : Unterdrückung der in der Datei aufgeführten Warnungen. Weitere Informationen finden Sie in der Option --suppressions-list von cppcheck .
• inline-suppr : Ermöglichen Sie die Unterdrückung von Warnungen mit Inline-Kommentaren, zum Beispiel: // cppcheck-suppress arrayIndexOutOfBounds . Weitere Informationen finden Sie in der Option --inline-suppr -Option von cppcheck

Weitere Optionen können später unterstützt werden.

Ein Beispiel .codeclimate.yml -Datei:

 version : " 2 "
plugins :
  cppcheck :
    enabled : true
    config :
      check : all
      project : compile_commands.json
      language : c++
      stds :
        - c++11
      platform : unix64
      defines :
      - " DEBUG=1 "
      - " __cplusplus "
      undefines :
      - " DEBUG "
      includes :
      - include/
      max_configs : 42
      inconclusive : false
      dump : false
      dump : false
      suppressions-list : .cppcheck-suppressions
      inline-suppr : true
      jobs : 4
      library : googletest 

Benötigen Sie Hilfe?

Um Hilfe bei CPPCheck zu erhalten, lesen Sie ihre Dokumentation.

Wenn Sie auf ein Code -Klimaproblem stoßen, schauen Sie sich zunächst die Github -Probleme dieses Projekts an, da Ihre Frage möglicherweise bereits behandelt wurde. Wenn nicht, eröffnen Sie mit uns ein Support -Ticket.