diffplug / diffplug/spotless

imports broken by whitespace over at least two lines cannot be parsed

Abierto
#2,106 1 comentario 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Lenguaje dominante
Java
Estrellas
5.7k
Forks
561
Merge medio
1 d 14 h
PR fusionados (30 d)
43

Descripción

Gradle 7.6.1
Spotless 6.25.0
Ubuntu 22.04
Java 11 or 17

Our code is:

import static foo.bar.
    FooClass.CONSTANT;

The import class package is very very long so it's broken across multiple lines, but I believe any import will reproduce the issue.

The spotless stacktrace is:

Step 'removeUnusedImports' found problem in 'path/to/offending/file.java':
14:84: error: <identifier> expected
com.google.googlejavaformat.java.FormatterException: 14:84: error: <identifier> expected
        at com.google.googlejavaformat.java.FormatterException.fromJavacDiagnostics(FormatterException.java:51)
        at com.google.googlejavaformat.java.RemoveUnusedImports.parse(RemoveUnusedImports.java:264)
        at com.google.googlejavaformat.java.RemoveUnusedImports.removeUnusedImports(RemoveUnusedImports.java:218)
        at com.diffplug.spotless.glue.java.GoogleJavaFormatRemoveUnusedImporterFormatterFunc.apply(GoogleJavaFormatRemoveUnusedImporterFormatterFunc.java:38)

Using toggleOffOn() with // spotless:off and // spotless:on around the offending import(s) makes no difference because the code cannot be parsed.

Gradle plugin block:

spotless {
    enforceCheck false
    java {
        toggleOffOn()
        target 'src/**/*.java'
        encoding 'UTF-8'
        lineEndings 'UNIX'
        importOrderFile("/path/to/import-order-file")
        removeUnusedImports()
    }   
}   

My workaround at the moment is to add:

targetExclude 'path/to/offending/file.java'

to our gradle plugin config.

At a minimum the toggleOffOn() should work but in theory, since this is legal java, the parser should be able to deal with it and it should just work.

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Línea de trabajo

Reproduce el fallo con la configuración de Gradle y el import multilínea mostrados en la issue, y después empieza por RemoveUnusedImports.parse y removeUnusedImports en el stack trace. Compara el comportamiento con toggleOffOn y targetExclude; se considera terminado cuando los imports multilínea válidos se gestionan sin el error de parseo informado y la configuración documentada se comporta como se espera.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
java
Área
build-system, tooling
Tipo de issue
Error
Dificultad
4/5
Tiempo estimado
3-5 días
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
45/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.