Possible to use RegularFileProperty as Input to License/EclipseFormatter/ImportOrder?

Open
#2,058 0 comments 0 reactions 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
java
Domain
build-system

Research direction

Start by tracing the Gradle integration around FormatterStep configuration and the handling of config files from resource jars. Check how formatter state is compared at configuration time and how task inputs are currently declared. Done means determining whether a RegularFileProperty can represent License, EclipseFormatter, and ImportOrder inputs while supporting outputs from other tasks and up-to-date checking.

Written by the indexing model from the issue text.

Description

First, I have read all the issues about config files in resource jars etc. In my understanding, the problem with these approaches is that FormatterSteps are immutable states that must be compared to determine whether something has changed. For this comparison, the config files' content must be read at configuration time. This prohibits lazily extracting these files from the resource jar to the build directory because they have to exist before the build even starts.

However, wouldn't it be possible to use something like @InputFile RegularFilePropery as an alternative? It would leverage gradles mechanism of up-to-date checking and allows developers to wire outputs from other tasks as inputs to spotless.

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.