google / google/google-java-format
Eclipse-Formatter-Plugin fails due to wrong assumptions
- Linguagem predominante
- Java
- Estrelas
- 6.2k
- Forks
- 936
- Merge médio
- 6min
- PRs com merge (30d)
- 3
Descrição
The Eclipse-Plugin has sometimes a problem when I call the formatter programatically inside Eclipse. I am using the Snippet from https://help.eclipse.org/latest/topic/org.eclipse.jdt.doc.isv/guide/jdt_api_codeformatter.htm to format a complete Java-File. I have created a minimal Test-Class:
```
package test;
/**
* Test Class
*
* Generated
*
*/
public class Test
{
}
```
The standalone-Formatter-Jar adds a HTML-Tag
before the "Generated". Unfortunately, when I call the plugin via the Eclipse-APIs:
```java
final TextEdit edit =
codeFormatter.format(
CodeFormatter.K_COMPILATION_UNIT, // format a compilation unit
content, // source to format
0, // starting position
content.length(), // length
0, // initial indentation
"\r\n" // line separator
);
```
the method returns a null because it can not format the content. I have tracked the problem back to the class SnippetFormatter.java, Method toReplacements(). This method has the condition which checks the unformatted and the formatted source:
```java
if (!NOT_WHITESPACE.retainFrom(source).equals(NOT_WHITESPACE.retainFrom(replacement))) {
throw new IllegalArgumentException(
"source = \"" + source + "\", replacement = \"" + replacement + "\"");
}
```
This condition checks that there are only whitespace-changes in the new formatted source. The Javadoc says:
```quote
under the assumption that they differ in whitespace alone.
```
Unfortunately, this assumption is not correct. The source has (as mentioned above) an additional non-whitespace change and the IllegalArgumentException is thrown. This Exception causes the Eclipse-Formatter-Class to fail and to return only null, thereby denying to format the source.
Guia de contribuição
Direção de pesquisa
Start by reproducing the minimal Test class with the Eclipse API snippet, then read SnippetFormatter.java and its toReplacements() method. Trace how the non-whitespace comparison leads to the Eclipse formatter returning null. Done means the sample source can be formatted through the plugin without this failure, with the behavior verified by a regression test.
Escrita pelo modelo de indexação a partir do texto da issue.
Avaliação
- Stack de tecnologia
- java
- Domínio
- tooling
- Tipo de issue
- Bug
- Dificuldade
- 4/5
- Tempo estimado
- 3-5 dias
- Status de atividade
- Estagnada
- Clareza
- Razoavelmente clara
- Facilidade para iniciantes
- 45/100