microsoft / microsoft/TypeScript
`@deprecated` nested namespace handling is buggy
まだ誰も着手していません。
- 主要言語
- Go
- スター
- 111k
- フォーク
- 14.4k
- 平均マージ
- 1日 19時間
- マージ済み PR(30日)
- 117
説明
🔎 Search Terms
deprecated nested namespace
🕗 Version & Regression Information
- This is the behavior in every version I tried
⏯ Playground Link
💻 Code
/** @deprecated */
namespace Foo1.Bar {
export const x = 1;
}
namespace Foo1.Baz {
export const x = 1;
}
Foo1.Bar.x;
Foo1.Baz.x;
namespace Foo2.Baz {
export const x = 1;
}
/** @deprecated */
namespace Foo2.Bar {
export const x = 1;
}
Foo2.Bar.x;
Foo2.Baz.x;
🙁 Actual behavior
Usages of Foo1 are stricken through
But usages of Foo2 are not stricken through
Yet intellisense shows the tag in the hover for Foo2
🙂 Expected behavior
Either both Foo1 and Foo2 should be treated as deprecated, or neither should and instead the Bar in Foo1.Bar and Foo2.Bar should be treated as deprecated.
Additional information about the issue
@typescript-eslint recently released a new lint rule no-deprecated which reports a lint error whenever you use a thing marked with @deprecated.
A user mentioned to us that the rule reports incorrectly in certain cases (https://github.com/typescript-eslint/typescript-eslint/issues/9902).
Specifically in a case like this
https://github.com/DefinitelyTyped/DefinitelyTyped/blob/d1c172bdcfd4508405f4b233e11ccd7d8743f763/types/chrome/index.d.ts#L8553-L8556
We did some investigation and found that things can be pretty ambiguous when nested namespace declarations are marked @deprecated like this and TS itself struggles with it.
It's worth noting that the above behaviour is consistent between nested namespace shorthand (namespace Foo.Bar) and the non-shorthand style
Note you see similar behaviour for many declaration-merged things where TS's handling only makrs something as deprecated if the first definition is marked as deprecated, eg Enums.
But there are also cases where TS gets it right, eg Interfaces
Then there are weird cases like type/value shadowing where I'm not sure if TS is right or wrong -- depends on what you expect I guess.
I would love to see some clarification on what you guys think is the correct behaviour so that we can follow-suit!
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
issue にある 2 つの TypeScript Playground の例から始め、Foo1 と Foo2 で deprecation がどのように解決されるかを比較します。関連する動作について、リンクされている @typescript-eslint no-deprecated レポートと DefinitelyTyped の chrome 宣言を確認します。外側の namespace とネストされた Bar のどちらを deprecated にすべきかについて、明確で一貫した判断ができれば完了です。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- typescript
- 領域
- compilers
- issue の種類
- バグ
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 活発さ
- 停滞
- 明瞭さ
- 説明が足りない
- 初心者へのやさしさ
- 25/100