microsoft / microsoft/TypeScript

Typecheck code blocks in jsdoc

未关闭
#62,383 0 条评论 1 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

Awaiting More Feedback Suggestion
主要语言
Go
星标
111k
派生
14.3k
平均合并
2 天 4 小时
30 天内合并 PR
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

贡献指南

打开贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

调研方向

未指定文件、测试或入口点。研究应识别 JSDoc 代码块和类型检查入口点,然后定义测试,以表明示例会根据周围的声明进行检查,同时不改变生成的 JavaScript。

由索引模型根据 Issue 内容生成。

评估

技术栈
javascript, typescript
领域
compilers, documentation
Issue 类型
功能
难度
5/5
预计耗时
一周以上
活跃度
停滞
描述清晰度
基本清楚
新手友好度
30/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。