redhat-developer / redhat-developer/vscode-java

Add support for @CheckReturnValue

Offen
#2,238 0 Kommentare 2 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

code analysis diagnostics enhancement
Vorherrschende Sprache
TypeScript
Sterne
2.3k
Forks
546
Ø Merge
20 Std. 1 Min.
Gemergte PRs (30 T.)
11

Beschreibung

IntelliJ has a "clever" way to inform the users that the result of a method must be used.
It detects that the method is annotated with a @CheckReturnValue annotation regardless of its package. So, frameworks can provide their own (like SmallRye Commons Annotations).

Basically, if you have an API with:

@CheckReturnValue
public Uni<String> doSomethingCool();

a user using that method like in the following snippet would get a warning:

doSomethingCool();

The warning indicates that the return value must be used, like in:

doSomethingCool().subscribe().with(r -> ...);

This is particularly interesting for reactive APIs, stream APIs, and builders APIs.

It would be great if VS Code Java could provide the same kind of feature.

CC @maxandersen

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Es werden keine Quelldateien oder Tests genannt. Beginne damit, den Einstiegspunkt für die Java-Diagnose oder -Analyse von VS Code zu finden, und prüfe, wie Methodenannotationen behandelt werden; die Arbeit ist abgeschlossen, wenn paketunabhängige @CheckReturnValue-Annotationen eine Warnung für ignorierte Ergebnisse erzeugen, mit Abdeckung für reaktive, Stream- oder Builder-Aufrufe.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
java, typescript, vscode
Bereich
developer-experience, devtools
Issue-Typ
Feature
Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Aktivitätsstatus
Veraltet
Klarheit
Muss geklärt werden
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.