Apply license header to `package-info.java` and `module-info.java`

Open
#532 11 comments 6 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
52/100
Issue type
Bug
Clarity
Mostly clear
Activity status
Quiet
Tech stack
java
Domain
build-system

Research direction

Start by reproducing the shown Spotless configuration and running spotlessJavaApply against package-info.java and module-info.java. Check whether those files are included in the Java source selection and license-header step; the issue is done when the expected header behavior is established and those files are handled consistently.

Written by the indexing model from the issue text.

Description

enhancement

We added spotless with the Google Java style:

spotless {
    java {
        googleJavaFormat("1.7")
        licenseHeaderFile "${project.rootDir}/company.license.java"
    }
}

and it formatted all code...but left all the package-info.java classes untouched when we run spotlessJavaApply

is that expected behaviour or a bug? How can we force the format to include those files as well?

Dominant language
Java
Stars
5.7k
Forks
560
Avg merge
1d 13h
Merged PRs (30d)
43

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from diffplug/spotless

All issues in diffplug/spotless

Similar issues

More Java issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.