microsoft / microsoft/TypeScript
Declaration emit of private properties should strip jsdoc
オープン
まだ誰も着手していません。
Bug
Domain: Declaration Emit
Help Wanted
- 主要言語
- Go
- スター
- 111k
- フォーク
- 14.3k
- 平均マージ
- 1日 19時間
- マージ済み PR(30日)
- 117
説明
🔎 Search Terms
jsdoc dts declaration emit private properties property
🕗 Version & Regression Information
- This is the behavior in every version I tried
⏯ Playground Link
💻 Code
export class Foo {
/** This is a public method. */
public publicMethod() {}
/** This is a private method, and will be stripped in the declaration file. */
private privateMethod() {}
}
🙁 Actual behavior
export declare class Foo {
/** This is a public method. */
publicMethod(): void;
/** This is a private method, and will be stripped in the declaration file. */
private privateMethod;
}
Note the jsdoc on the private method.
🙂 Expected behavior
export declare class Foo {
/** This is a public method. */
publicMethod(): void;
private privateMethod;
}
Additional information about the issue
It sure seems like this info should be stripped; after all, the type information is gone, leaving only a marker to inform child classes.
This causes TypeScript's own dts files to be filled with private method jsdoc. https://github.com/microsoft/TypeScript/pull/57492/files#r1559884318
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
Playground Linkから始め、issueに示されている宣言出力を再現します。privateプロパティに対するTypeScriptの宣言出力処理を追跡し、その後、生成された宣言出力でprivateマーカーが残る一方、privateプロパティのJSDocが省略されることを確認します。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- typescript
- 領域
- compilers
- issue の種類
- バグ
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 活発さ
- 静か
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 48/100