redhat-developer / redhat-developer/vscode-java
Eclipse Formatter settings for comment length ignored
まだ誰も着手していません。
- 主要言語
- TypeScript
- スター
- 2.3k
- フォーク
- 546
- 平均マージ
- 20時間 1分
- マージ済み PR(30日)
- 11
説明
I have a custom, Eclipse Formatter XML preference file that includes the following Eclipse JDT formatter setting for comment length:
<setting id="org.eclipse.jdt.core.formatter.comment.line_length" value="120"/>
I have noticed that, when formatting the code using this settings, comments were always formatted to 80 columns, regardless of the value used. When opening > Java: Open Java Formatter Settings with Preview using the Command Palette, and navigating to the comment section, I noticed that the value in Maximum comment line length is set to 80 -- check out the image below. When modifying this value, my XML file is updated to include the following setting:
<setting id="comment_line_length" value="120"/>
It seems that the formatter is picking up its default setting for line length, which is a property name different than the Eclipse JDT Core formatter setting.
Environment
- Operating System: Amazon Linux 2 (running through SSH)
- JDK version: 8
- Visual Studio Code version: the latest (Nov 2023 release)
- Java extension version:
v1.24.0
Steps To Reproduce
- Create an Eclipsed Formatter XML file containing the setting
org.eclipse.jdt.core.formatter.comment.line_lengthwith a value different than80. - Write a comment that goes over
80or the value set for the property above. - Format the code and see the comment being limited to
80despite the value used in the property above.
Current Result
Comments are formatted to the default value set by comment_line_length instead of the value set by org.eclipse.jdt.core.formatter.comment.line_length.
Expected Result
Comments should be formatted using org.eclipse.jdt.core.formatter.comment.line_length when available.
Additional Informations
Likely related to https://github.com/redhat-developer/vscode-java/issues/2798
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
Eclipse Formatter XML ファイルと Java: Open Java Formatter Settings with Preview コマンドを使って問題を再現し、org.eclipse.jdt.core.formatter.comment.line_length と comment_line_length を比較します。formatter の設定がどのように読み込まれ、適用されるかを追跡します。値が存在する場合、80 以外の値も含めて、コメントが Eclipse JDT の値を使用すれば完了です。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- java, typescript
- 領域
- developer-experience, tooling
- issue の種類
- バグ
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 45/100