Skip to content

Latest commit

 

History

History
38 lines (29 loc) · 1.81 KB

README.md

File metadata and controls

38 lines (29 loc) · 1.81 KB

invesdwin-checkstyle-plugin

This plugin contains additional checks for checkstyle. It is packaged as an eclipse plugin, so it can be used with the Eclipse Checkstyle Plugin by just putting the invesdwin-checkstyle-plugin.jar inside eclipse/dropins/ or /home/$USER/.eclipse/<current>/dropins or /home/$USER/snap/eclipse/current/amd64/dropins depending on the installation method.

Maven

Releases and snapshots are deployed to this maven repository:

https://invesdwin.de/repo/invesdwin-oss-remote/

Dependency declaration:

<dependency>
	<groupId>de.invesdwin</groupId>
	<artifactId>invesdwin-checkstyle-plugin</artifactId>
	<version>1.0.4</version>
</dependency>

Checks

Currently this plugin contains the following checks:

  • de.invesdwin.checkstyle.InternalImportCheck: with this you can enforce the rule that internal packages are not used outside of your module. You can also change the name of the package by using the internalPackageName property.
<module name="de.invesdwin.checkstyle.InternalImportCheck">
	<property name="internalPackageName" value="internal" />
</module>
  • de.invesdwin.checkstyle.NotNullParameterAnnotationCheck: Findbugs can parse @Nonnull, but not @NotNull in parameters correctly, this check verifies that the developer does not use the wrong annotation.
<module name="de.invesdwin.checkstyle.NotNullParameterAnnotationCheck" />

Support

If you need further assistance or have some ideas for improvements and don't want to create an issue here on github, feel free to start a discussion in our invesdwin-platform mailing list.