Findbugs detectors for Guice
Java
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.
src
.gitignore
LICENSE
README.md
pom.xml

README.md

findbugs-guice

findbugs-guice is a detector for Findbugs, a popular static analysis tool, that detects errors in the use of Guice.

findbugs-guice detects:

  • scope annotations on interfaces (which Guice does not support)
  • installation of submodules via Module.configure() (which doesn't install @Provides methods) rather than Module.install()
  • static field injection (which is recommended against)
  • final field injection (which is recommended against and error-prone)

How to install

... using the Findbugs Maven plugin

Add the following to your pom.xml:

<project>
    <build>
        <plugins>
            <plugin>
                <groupId>org.codehaus.mojo</groupId>
                <artifactId>findbugs-maven-plugin</artifactId>
                <version>3.0.1</version>
                <configuration>
                    <plugins>
                        <plugin>
                            <groupId>uk.me.tom-fitzhenry.findbugs-guice</groupId>
                            <artifactId>findbugs-guice</artifactId>
                            <version>0.5</version>
                        </plugin>
                    </plugins>
                </configuration>
            </plugin>
        </plugins>
    </build>
</project>

And run mvn site to generate the findbugs results, as usual.

... otherwise

Install findbugs-guice like any other Findbugs detector:

  1. Put the JAR in FINDBUGS_HOME/plugin.
  2. Test your installation against code which exhibits the issues that findbugs-guice detects.

How to build

mvn package