microsoft / microsoft/TypeScript

Typecheck code blocks in jsdoc

オープン
#62,383 コメント 0 件 リアクション 1 件 担当者 0 名 GitHub で見る
Awaiting More Feedback Suggestion
主要言語
Go
スター
111k
フォーク
14.3k
平均マージ
2日 4時間
マージ済み PR(30日)
132

説明

### 🔍 Search Terms

jsdoc typecheck

### ✅ 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

When a codeblock is created in jsdoc, apply typechecking on it as if it were part of the code in the file.

### 📃 Motivating Example

I create a method that has a non-trivial function signature (example is contrived)
```ts
type OtherType = { data: TData };
class Class {
doSomething(arg: OtherType): void;
}
```
I would like to document the idiomatic usage in jsdoc
```ts
/**
* Does something, example:
* ```ts
* const cls = new Class<{ x: number }>();
* cls.doSomething({ data: { x: 1, y: 2 } });
* ```
*/
```
If the function signature or underlying types change in any way, the typechecker will tell me to update the usages, but not the example.
The example becomes outdated potentially unknowingly, potentially causing bad code that could have been prevented if the example was typechecked.

### 💻 Use Cases

1. What do you want to use this for?

Typecheck code blocks in jsdoc

2. What shortcomings exist with current approaches?

Relying on implementations as the idiomatic way when the example in the jsdoc is intended the be the idiomatic way.

3. What workarounds are you using in the meantime?

Inspection

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

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

調査の方向性

ファイル、テスト、エントリーポイントは指定されていません。調査では、JSDoc のコードブロックと型チェックのエントリーポイントを特定し、そのうえで、出力される JavaScript を変更せずに、周囲の宣言に照らして例がチェックされることを示すテストを定義する必要があります。

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

評価

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

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

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