Maven package-info.java Plugin

Autogenerates package-info.java files with arbitrary headers

License	The GNU General Public License, Version 3.0
Categories	Maven Build Tools
GroupId	de.shadowhunt.maven.plugins
ArtifactId	package-info-maven-plugin
Last Version	2.0.0
Release Date	Mar 19, 2017
Type	maven-plugin
Description	Maven package-info.java Plugin Autogenerates package-info.java files with arbitrary headers
Project Organization	shadowhunt
Source Code Management	https://github.com/thrawn-sh/package-info

Download package-info-maven-plugin

Filename	Size
package-info-maven-plugin-2.0.0.pom
package-info-maven-plugin-2.0.0.jar	18 KB
package-info-maven-plugin-2.0.0-sources.jar	7 KB
package-info-maven-plugin-2.0.0-javadoc.jar	42 KB

How to add to project

Apache Maven

<plugin>
    <groupId>de.shadowhunt.maven.plugins</groupId>
    <artifactId>package-info-maven-plugin</artifactId>
    <version>2.0.0</version>
</plugin>

Dependencies

compile (1)

Group / Artifact	Type	Version
commons-lang : commons-lang	jar	2.6

provided (5)

Group / Artifact	Type	Version
com.google.code.findbugs : annotations	jar	3.0.1u2
de.shadowhunt : annotations	jar	2.0.0
org.apache.maven : maven-core	jar	3.0
org.apache.maven : maven-plugin-api	jar	3.0
org.apache.maven.plugin-tools : maven-plugin-annotations	jar	3.0

test (2)

Group / Artifact	Type	Version
junit : junit	jar	4.12
org.mockito : mockito-core	jar	2.7.17

Project Modules

There are no modules declared in this project.

Shadowhunt package-info.java Generator

This Maven project generates package-info.java for every Java package that does not already contain such a file. You can generate findbugs, sportbugs, checkstyle, pmd, ... package annotations for each package and save the trouble of keeping them in sync.

Usage

...
<plugin>
    <groupId>de.shadowhunt.maven.plugins</groupId>
    <artifactId>package-info-maven-plugin</artifactId>
    <version>2.0.0</version>
    <executions>
        <execution>
            <phase>generate-sources</phase>
            <goals>
                <goal>package-info</goal>
            </goals>
        </execution>
    </executions>
    <configuration>
        <packages>
            <package regex="net.example.database">
                <annotations>
                    <annotation>@de.shadowhunt.annotation.ReturnValuesAreNonnullByDefault</annotation>
                </annotations>
            </package>
            <package><!-- all other packages -->
                <annotations>
                    <annotation>@de.shadowhunt.annotation.ReturnValuesAreNonnullByDefault</annotation>
                    <annotation>@javax.annotation.ParametersAreNonnullByDefault</annotation>
                </annotations>
            </package>
        </packages>
    </configuration>
</plugin>
...

Versions

Version
2.0.0 Mar 19, 2017
1.4.5 Nov 1, 2016
1.4.4 Jun 12, 2016
1.4.3 Jun 29, 2014
1.4.2 Dec 21, 2013