diffplug / diffplug/spotless

Support author name in LicenseHeaderStep

Open
#323 5 comments 1 reaction 0 assignees View on GitHub
enhancement
Dominant language
Java
Stars
5.7k
Forks
561
Avg merge
1d 14h
Merged PRs (30d)
43

Description

Some license texts include the name of the file's initial creator. This is currently not possible to do with the `LicenseHeaderStep`.
Maybe the step could should work with templates rather than constant strings, e,g,
```groovy
licenseHeader('/* Copyright ${year} ${author}*/',
[year: java.time.LocalDate.now().year, author: 'John Doe'])
```

Contributor guide

Open the contributing guide

Research direction

Start at the LicenseHeaderStep entry point and trace how licenseHeader currently accepts constant strings. Define how the proposed year and author values should be supplied and determine the expected rendered header using the example; completion requires focused coverage for template substitution.

Written by the indexing model from the issue text.

Assessment

Tech stack
groovy, java
Domain
tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.