Checkstyle
- In StreamPipes we follow the Google Java Checkstyle for the Java code. [Link]
- For automatic validation we have a checkstyle.xml file [Link].
- If you want to change something, please edit it in the checkstyle.xml file and provide a PR with the changes.
Custom StreamPipes Guidelines
- Here we can collect guidelines and best practices relevant for StreamPipes
Configure IDE
IntelliJ
- Install IntelliJ Checkstyle Plugin [Link]
- Configuration:
- Open Settings ( Ctrl + Alt + S)
- Tab Editor -> Code Style
- Select Scheme
Project
- Click on "Show Schema Settings" on the gear wheel next to Schema
- select import scheme -> checkstyle configuration -> select checkstyle.xml file from tools directory (../incubator-streampipes/tools/maven/checkstyle.xml)
Click ok.
- Select Scheme
- Tab Tools -> Checkstyle
- Add Style from tools directory (../incubator-streampipes/tools/maven/checkstyle.xml)
- Activate checkbox Active
- Set Scan Cope to Only Java Soures (including tests)
Press OK
Run in IDE
- In the Toolbar CheckStyle run "check current file" to run the style check
- Specific Error Messages can be looked up here https://checkstyle.org/apidocs/