redhat-developer / redhat-developer/vscode-java

Improve quick fix

Aperta
#1,822 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

code action enhancement
Lingua principale
TypeScript
Stelle
2.3k
Fork
546
Merge medio
20h 1m
PR unite (30g)
11

Descrizione

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

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia tracciando i punti di ingresso quick-fix e auto-completion dell'estensione per gli import Java, quindi esamina la configurazione settings.json proposta per i suggerimenti relativi agli import fuorvianti. Confronta il comportamento esistente con gli esempi nell'issue. Il completamento deve includere suggerimenti di sostituzione selezionabili, la qualificazione delle altre occorrenze in modo sicuro rispetto ai conflitti e sostituzioni preferite opzionali.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
java, typescript, vscode
Ambito
developer-experience, tooling
Tipo di issue
Funzionalità
Difficoltà
5/5
Tempo stimato
Più di una settimana
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
30/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.