redhat-developer / redhat-developer/vscode-java

Add support for @CheckReturnValue

オープン
#2,238 コメント 0 件 リアクション 2 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

code analysis diagnostics enhancement
主要言語
TypeScript
スター
2.3k
フォーク
546
平均マージ
20時間 1分
マージ済み PR(30日)
11

説明

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

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

ソースファイルやテストは指定されていません。まず VS Code の Java 診断または解析のエントリーポイントを見つけ、メソッドアノテーションの扱いを確認してください。パッケージに依存しない @CheckReturnValue アノテーションによって、無視された結果に対する警告が生成され、リアクティブ、ストリーム、またはビルダースタイルの呼び出しがカバレッジに含まれれば、作業は完了です。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
java, typescript, vscode
領域
developer-experience, devtools
issue の種類
機能追加
難易度
5/5
見積もり時間
1週間以上
活発さ
停滞
明瞭さ
説明が足りない
初心者へのやさしさ
35/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。