microsoft / microsoft/TypeScript

typedef imports should use default exports

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

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

Awaiting More Feedback In Discussion Suggestion
主要言語
Go
スター
111k
フォーク
14.3k
平均マージ
1日 19時間
マージ済み PR(30日)
117

説明

Search Terms

checkJs typedef import

Suggestion

When the module ./core.controller has a default export defined, I would like to be able to do:

/**
 * @typedef { import("./core.controller") } Chart
 */

Instead of:

/**
 * @typedef { import("./core.controller").Chart } Chart
 */

Use Cases

My file had defined export default Chart;.

TypeScript made me add a duplicate export, which I don't want to have to add

export {
	Chart
};

This resulted in lots of extra code

It also took me an extremely long amount of time to figure out I needed to do this because the documentation did not mention this as a limitation.

Examples

Already shared in the above sections.

Checklist

My suggestion meets these guidelines:

  • This wouldn't be a breaking change in existing TypeScript/JavaScript code
  • This wouldn't change the runtime behavior of existing JavaScript code
  • This could be implemented without emitting different JS based on the types of the expressions
  • This isn't a runtime feature (e.g. library functionality, non-ECMAScript syntax with JavaScript output, etc.)
  • This feature would agree with the rest of TypeScript's Design Goals.

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

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

はじめの一歩

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

調査の方向性

TypeScript ハンドブックの import types セクションと、issue に示されている既存の JSDoc typedef import forms から始めます。default-exported module がどのように表現され、テストされているかを追跡し、そのうえで、重複した named export を必要とせずに短い import form が受け入れられること、およびドキュメントがその動作を説明していることを確認します。

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

評価

技術スタック
javascript, typescript
領域
compilers
issue の種類
機能追加
難易度
4/5
見積もり時間
3〜5日
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
38/100

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

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