LicenseHeaderStep: Support repeating placeholders

Open
#787 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
45/100
Issue type
Feature
Clarity
Clearly specified
Activity status
Stale
Tech stack
java
Domain
tooling

Research direction

Start by locating the LicenseHeaderStep entry point and inspect how $YEAR and $today.year placeholders are replaced. Verify the change against the two-line template shown in the issue, ensuring every matching placeholder is updated while preserving the surrounding license text.

Written by the indexing model from the issue text.

Description

enhancement

We have the case of requiring multiple copyright years in our license headers for our source files.

Example:

/*
 * (c) Copyright CompanyA Inc., 2010-2020
 * (c) Copyright CompanyB Inc., 2020-2021
 */

Currently the LicenseHeaderStep only supports replacing/updating the placeholder for the year ($YEAR or $today.year) only a single time.

Using this template:

/*
 * (c) Copyright CompanyA Inc., $YEAR
 * (c) Copyright CompanyB Inc., $YEAR
 */

The result would be as follows:

/*
 * (c) Copyright CompanyA Inc., 2010-2020
 * (c) Copyright CompanyB Inc., $YEAR
 */
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.