Groovy formatting is very limited - possible idea

Abierto
#2,513 6 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
5/5
Tiempo estimado
Más de una semana
Aptitud para principiantes
25/100
Tipo de issue
Nueva funcionalidad
Claridad
Necesita aclaración
Estado de actividad
Estancado
Stack tecnológico
groovy, java
Área
tooling

Línea de trabajo

Empieza leyendo las directrices de contribución y el formateador de Groovy existente que utiliza Eclipse formatter. Compara su contrato de formateo de un solo archivo con los modos propuestos de línea de comandos dry-run y format de IntelliJ Community Edition, incluidos los aspectos relacionados con los archivos temporales y los procesos externos. Se consideraría completado cuando exista una forma acordada y mantenible de mejorar el formateo de Groovy y Spock en Spotless.

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

Descripción

The current Groovy formatting using the Eclipse formatter is very limited. It can't even format apply({println it }) into something stringent. Let alone Spock tests written in Groovy.

The ways to format Groovy code are very limited. There is a npm-groovy-lint. That works better as the Eclipse formatter but has it own flaws (multi-line strings, ...). And fails on Spock tests, too.

My idea would be to use the IntelliJ formatter of the freely available community edition.

Here's the catch.
That's a command line tool that has the necessary two working options.
dry-run - just like spotless:check - checks a file or the files in a folder if they conform the expected formatting. If not, the files are reported.
format - just like spotless:apply - formats a file or the files in a folder.

After reading the contribution guideline I think this IntelliJ approach fits hardly into the Spotless Formatter approach, where one single file is given into the method and the formatted result is returned.

Of course it's possible to write the file content into a temporary file, call IntelliJ format on that temporary file, read the file again and return it's result.
I believe that's very cumbersome - especially on Windows with limited NTFS.

The necessary IntelliJ files could be packaged and provided as Maven dependency and then started as external process.

Is there a way to achieve better Groovy formation with Spotless?

(Of course, IntelliJ could format many other file types, too, but I'm mainly interested in Groovy.)

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

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.

Más de diffplug/spotless

Todos los issues de diffplug/spotless

Issues similares

Más issues de Java

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.