4 http://checkstyle.sourceforge.net/
7 To get the Eclipse Checkstyle plugin
8 ------------------------------------
9 - Help | Eclipse Marketplace
10 - search for checkstyle
11 - install eclipse-cs checkstyle plugin
12 The current version is 6.19.1 (August 2016).
17 File Jalview/.checkstyle holds configuration for the "JalviewCheckstyle" ruleset.
18 This includes confining its scope to src/*.java and resources/*.properties.
19 This can be modified interactively through the checkstyle properties editor.
21 Checkstyle config files in resources/checkstyle:
22 checkstyle.xml : main configuration file with selected checkstyle modules
23 checkstyle-suppress.xml : rules to exclude certain checks / files
24 import-control.xml : package import rules
26 Checkstyle error messages can be customised. I've done this for TypeName as an example.
31 Option 1: enable it for the Jalview project
32 - right-click on project | Checkstyle | Activate Checkstyle
33 - notice CheckstyleNature gets added to the .project file
34 - don't commit this file unless we all agree to!
35 - Checkstyle will run as you recompile changed code
36 - checking the whole project can be slow and may hang - not recommended for now
38 Option 2: on selected code
39 - right-click on a class or package and Checkstyle | Check code with checkstyle
43 Documented at http://checkstyle.sourceforge.net/checks.html
44 Should be self-documenting in checkstyle.xml
47 - what naming and layout standards to apply
48 - settings for complexity metrics
49 - whether any rules should report error instead of warning
53 Sometimes checkstyle needs a kick before it will refresh its findings.
54 A whitespace edit in checkstyle.xml usually does this. There may be better ways.
56 Invalid configuration files may result in checkstyle failing with an error reported
57 in the Eclipse log file.
58 Help | Installation Details | Configuration takes you to a screen with a
59 'View Error Log' button.
61 Sometimes checkstyle can fail silently. Try 'touching' (editing) config files, failing
62 that, carefully check / back out / redo any recent changes to its config.
64 Putting <!-- XML comments --> inside a checkstyle <module> causes it to be ignored!