Skip to content

Latest commit

 

History

History
40 lines (28 loc) · 1.68 KB

checkstyle.md

File metadata and controls

40 lines (28 loc) · 1.68 KB

Checkstyle for CodeChecker Eclipse plugin

Maven

Usage

Maven is configured to automatically run checksytle plugin during the build, no other action is needed. The current configuration won't fail the build, only emit warnings.

Adhering to to these style checks is mandatory.

In the future the the severity level will be changed to error, and will fail the build.

The checkstyle.xml file that defines the checks to be used is under /eclipse-plugin/eclipse/cc.codechecker.eclipse.parent/

The Maven checkstyle plugin also configured in this folders pom.xml under the build section.

Eclipse IDE

  • Installation:

    • InstallCheckstyle Plug-in from Eclipse marketplace.

  • Confugration:

    • To configure Checkstyle plug-in go to preferences > Checkstyle.
    • Add the checkstyle.xml with new as an External configuration file, and specify a name also. Config Pages
    • This step is optional:Set as Default the new configuration
    • Under the project preferences tick Checkstyle active for this project and make sure that the configuration you added is being used. Config Pages

  • Usage:

    • Checkstyle automatically monitors the project for imperfections.
    • The lines containing checkstyle problems are yellowed.
    • There is a view (Checkstyle violations) that can be opened.
    • There is a right click context item. (Apply Checkstyle fixes).

Codacy

Codacy is set to use the same checkers as the project.