redhat-developer / redhat-developer/vscode-java

Improve quick fix

Abierto
#1,822 1 comentario 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

code action enhancement
Lenguaje dominante
TypeScript
Estrellas
2.3k
Forks
546
Merge medio
20 h 1 min
PR fusionados (30 d)
11

Descripción

Hi! I would like to suggest a new feature to improve the extension.

When programming in Java is a very common mistake to import the wrong class for some basic types. For example, importing java.awt.List instead of java.util.List.

In such cases, you don't have a quick fix action to solve the problem. Check the image below:

Captura de tela de 2021-02-27 14-46-28(1)

To fix this, one solution is to trigger the auto completion and choose the right type. But then, the extension will include the whole class name to avoid conflicts, because it probably assumes that you may have other classes with the same name in use on the code. Check the image below:

Captura de tela de 2021-02-27 14-52-28

So, my suggestion is to include a quick fix (and an auto completion) named "Replace by ..." where the user can choose to replace the import with another option easily. So, if I have the following code:

import java.awt.List;

private List doSomethingWithJavaAwtList(){
    // Do domething
}
private List<String> toList(String src){
    return Arrays.asList(src.split(","));
}

Then, I can position the cursor on top of List<String>, invoke the quick fix and it will present me the following options:

  • Replace misleading import by java.util.List
  • Replace misleading import by com.vendor.library.List

Selecting an option imports the right class and (if necessary) replaces other occurrences with the full qualified name. So, for the previous example, it would become:

import java.awt.List;
import java.util.List;

private java.awt.List doSomethingWithJavaAwtList(){
    // Do domething
}
private List<String> toList(String src){
    return Arrays.asList(src.split(","));
}

The suggestions given by the extension could be provided automatically based on the class name and/or provided by the user in "settings.json", globally or per project/workspace. For example:

{
    "java.configurations.misleading-imports.suggestions": {
         "List": [
              "java.util.List"
         ],
         "Connection" : [
              "java.sql.Connection"
         ]
    }
}

Also, it would be interesting to provide a feature allowing the user to quickly set a class as the preferred suggestion on the configurations. Something like this:

  • Replace misleading import by java.util.List and set as preferred replacement for this type

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

Comienza rastreando los puntos de entrada de quick-fix y auto-completion de la extensión para las importaciones de Java; después, revisa la configuración propuesta de settings.json para las sugerencias de importaciones engañosas. Compara el comportamiento existente con los ejemplos del issue. La implementación debe incluir sugerencias de reemplazo seleccionables, la calificación de otras apariciones de forma segura frente a conflictos y reemplazos preferidos opcionales.

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

Evaluación

Stack tecnológico
java, typescript, vscode
Área
developer-experience, tooling
Tipo de issue
Nueva funcionalidad
Dificultad
5/5
Tiempo estimado
Más de una semana
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
30/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.