Document that formatter does not order imports

[ttddyy]

Should this plugin re-order import statements?

In spring-boot project,

This is the one passing ./mvnw validate

import java.time.Duration;
import java.util.Collections;
import java.util.Set;

import org.junit.Test;
import org.mockito.InOrder;

import org.springframework.transaction.PlatformTransactionManager;
import org.springframework.transaction.TransactionDefinition;
import org.springframework.transaction.annotation.Isolation;
import org.springframework.transaction.annotation.Propagation;
import org.springframework.transaction.support.TransactionTemplate;

I swapped java.time.Duration and java.util.Collections, then ran ./mvnw io.spring.javaformat:spring-javaformat-maven-plugin:apply

Nothing changed in import ordering, and ./mvnw validate failes on checkstyle.

Also, on Intellij with spring-javaformat plugin, when I do "Optimise Import", it shuffles import like this:

import org.junit.Test;
import org.mockito.InOrder;
import org.springframework.transaction.PlatformTransactionManager;
import org.springframework.transaction.TransactionDefinition;
import org.springframework.transaction.annotation.Isolation;
import org.springframework.transaction.annotation.Propagation;
import org.springframework.transaction.support.TransactionTemplate;

import java.time.Duration;
import java.util.Collections;
import java.util.Set;

This also fails on checkstyle.

[philwebb]

The formatter cannot order imports I'm afraid. All it can effectively do is add and remove whitespace.

[ttddyy]

Ok, thanks,

@philwebb
Can you add this limitation (or area that this plugin applies) to maybe README.adoc?
So that, ppl can have more clear understanding where this plugin works.

[philwebb]

Sure

[jasonparallel]

Is the recommendation to setup your IDE so that it auto organizes imports following this projects rules? (As mentioned here checkstyle/checkstyle#1448)