Support author name in LicenseHeaderStep

Open
#323 5 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

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

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.

Description

enhancement

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,

    licenseHeader('/* Copyright ${year} ${author}*/',
                      [year: java.time.LocalDate.now().year, author: 'John Doe'])
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.