INRIA/spoon

Spotless for imports

Open

#5,741 opened on Apr 6, 2024

View on GitHubContributor guide
 (8 comments) (1 reaction) (0 assignees)Java (383 forks)github user discovery
discussiongood first issue

Repository metrics

Stars
 (1,933 stars)
PR merge metrics
 (Avg merge 19d 11h) (49 merged PRs in 30d)

Description

Currently, our import ordering in spoon is a bit messy. This leads to an unpleasant time with IntelliJ trying to sort the imports in a more normal order. Why don't we use spotless-maven-plugin to sort all our imports in a fixed sorting? This also helps to reduce diffs in the future for PRs. The benefit compared to checkstyle is that we can do the sorting automatic. See https://github.com/diffplug/spotless/tree/main/plugin-maven#java for an example.

Contributor guide

Research direction
Add spotless maven plugin to pom.xml with import order configuration and run 'mvn spotless:check' to verify.
Tech stack
java
Domain
build systemdeveloper experience
Issue type
Chore
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
MavenGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90