microsoft / microsoft/TypeScript
Add option to always inline .json type import
まだ誰も着手していません。
- 主要言語
- Go
- スター
- 111k
- フォーク
- 14.3k
- 平均マージ
- 2日 4時間
- マージ済み PR(30日)
- 132
説明
### 🔍 Search Terms
json type import inline library resolveJsonModule
### ✅ Viability Checklist
- [x] This wouldn't be a breaking change in existing TypeScript/JavaScript code
- [x] This wouldn't change the runtime behavior of existing JavaScript code
- [x] This could be implemented without emitting different JS based on the types of the expressions
- [x] This isn't a runtime feature (e.g. library functionality, non-ECMAScript syntax with JavaScript output, new syntax sugar for JS, etc.)
- [x] This isn't a request to add a new utility type: https://github.com/microsoft/TypeScript/wiki/No-New-Utility-Types
- [x] This feature would agree with the rest of our Design Goals: https://github.com/Microsoft/TypeScript/wiki/TypeScript-Design-Goals
### ⭐ Suggestion
Add a tsconfig.json option to force .json type imports to inline the inferred .json type, rather than preserve .json import inside emitted .d.ts
or always inline without introducing a new option
or enable [#resolveJsonModule](https://www.typescriptlang.org/tsconfig/#resolveJsonModule) by default
### 📃 Motivating Example
JSON type imports are a very convenient feature for getting a type of localization strings to get intellisense when dealing with translation strings:
```ts
// The .json for correct locale will be loaded at runtime - but we need a type at compile time
import type T9nStrings from "../assets/t9n/messages.en.json";
```
However, as a library author, that presents two issues because TypeScript may preserve the above type import in the .d.ts file:
- Unless every consumer has [#resolveJsonModule](https://www.typescriptlang.org/tsconfig/#resolveJsonModule) enabled, their typescript will error out when trying to resolve the .json type import from my .d.ts
- I need to make sure the above .json file is also accessible relative to the final .d.ts file I distribute in dist/
### 💻 Use Cases
1. What do you want to use this for?
- I want to use .json type imports for getting types of translation files and configuration files
2. What shortcomings exist with current approaches?
- the .json type import is inlined some of the time only. when not inlined, it can break my consumers
3. What workarounds are you using in the meantime?
- the following hack seems to trigger typescript to always inline the .json file rather than preserve the type import:
```ts
import type T9nStrings from "./assets/t9n/messages.en.json";
const identity = (value: T): T => value;
const messages = identity;
type Messages = ReturnType;
```
related issues:
- https://github.com/microsoft/TypeScript/issues/60647
- https://github.com/microsoft/TypeScript/issues/43940
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
まず、resolveJsonModule に関する tsconfig.json のドキュメントと、関連する issue #60647 および #43940 を読んでください。出力された .d.ts ファイルで JSON 型のインポートがどのように表現されるかを追跡し、その後、提案されたオプションまたはデフォルトの動作がインライン化にどのような影響を与えるべきかを判断してください。この動作を選択した場合に、ライブラリの宣言で利用者が元の .json ファイルを解決する必要がなくなれば完了です。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- typescript
- 領域
- compilers
- issue の種類
- 機能追加
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 35/100