Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Add support for a file name field in license headers

See original GitHub issue

It would be useful if there was a field in the license header template called $FILE, $file.fileName, or similar that would be replaced with the name of the file the header is being applied to.

For example, I could write something like:

/*
 * Copyright (c) 2021 OxygenCobalt
 * $file.fileName is part of Foo.
 */

And it would end up resolving to:

/*
 * Copyright (c) 2021 OxygenCobalt
 * Bar.kt is part of Foo.
 */

I’m mostly drawing this idea from IntelliJ’s Copyright Notice format.

Issue Analytics

State:
Created 2 years ago
Reactions:1
Comments:7 (2 by maintainers)

Top GitHub Comments

1reaction

nedtwiggcommented, Mar 14, 2022

For substitutions that have constant values (e.g. Module and Project) you can do this already via replaceRegex.

To inject something dynamic like the filename or author, you’ll have to create a custom step, and it’s pretty straightforward to modify the LicenseStep to do this.

0reactions

OxygenCobaltcommented, Mar 20, 2022

Honestly, I’d be willing to add most of the copyright notice format to the license header functionality in a PR. I feel like that would definitely help people trying to migrate from the somewhat unreliable IntelliJ plugin to spotless without issue. The only issue is that I’m quite busy right now, so I won’t be able to get to it immediately.