walkmod-license-applier-plugin

Walkmod plugin to add license headers into Java source files.

License

License

GroupId

GroupId

org.walkmod
ArtifactId

ArtifactId

walkmod-license-applier-plugin
Last Version

Last Version

2.2
Release Date

Release Date

Type

Type

jar
Description

Description

walkmod-license-applier-plugin
Walkmod plugin to add license headers into Java source files.
Project URL

Project URL

https://github.com/rpau/walkmod-license-applier-plugin
Source Code Management

Source Code Management

https://github.com/rpau/walkmod-license-applier-plugin

Download walkmod-license-applier-plugin

How to add to project

<!-- https://jarcasting.com/artifacts/org.walkmod/walkmod-license-applier-plugin/ -->
<dependency>
    <groupId>org.walkmod</groupId>
    <artifactId>walkmod-license-applier-plugin</artifactId>
    <version>2.2</version>
</dependency>
// https://jarcasting.com/artifacts/org.walkmod/walkmod-license-applier-plugin/
implementation 'org.walkmod:walkmod-license-applier-plugin:2.2'
// https://jarcasting.com/artifacts/org.walkmod/walkmod-license-applier-plugin/
implementation ("org.walkmod:walkmod-license-applier-plugin:2.2")
'org.walkmod:walkmod-license-applier-plugin:jar:2.2'
<dependency org="org.walkmod" name="walkmod-license-applier-plugin" rev="2.2">
  <artifact name="walkmod-license-applier-plugin" type="jar" />
</dependency>
@Grapes(
@Grab(group='org.walkmod', module='walkmod-license-applier-plugin', version='2.2')
)
libraryDependencies += "org.walkmod" % "walkmod-license-applier-plugin" % "2.2"
[org.walkmod/walkmod-license-applier-plugin "2.2"]

Dependencies

compile (2)

Group / Artifact Type Version
org.walkmod : javalang jar [4.0.0, 5.0.0)
org.walkmod : walkmod-core jar [1.0.0,2.0.0)

test (1)

Group / Artifact Type Version
junit : junit jar 4.5

Project Modules

There are no modules declared in this project.

walkmod-license-applier-plugin

Build Status

This is a walkmod plugin to add license headers in Java source files. By default, it add your license header if it is missing in your source files. However, there are the following actions:

  • update: updates the existing header with a new one.

  • check: checks if the header is missing in some source file but it does not change any source file.

  • remove: removes the existing header.

  • reformat: adds headers if they are missing (default option).

Usage

1) Check that your walkmod version is > = 2.2.0.

2) In order to configure this convention to apply or update a license to all your source files, execute the following command:

walkmod add -DlicenseFile=src/main/walkmod/license-applier/license.txt -Daction=reformat license-applier

And then, to see the results:

walkmod apply

Contributing

If you want to hack on this, fork it, improve it and send me a pull request.

To get started using it, just clone it and call mvn install.

Versions

Version
2.2
2.1
2.0
1.0