Microsoft/TypeScript

Suggestion: Change `Diagnostic.file` to be `SourceFileLike` instead of `SourceFile`.

Open

#18,013 创建于 2017年8月24日

在 GitHub 查看
 (1 评论) (1 反应) (0 负责人)TypeScript (48,455 star) (6,726 fork)batch import
Domain: APIHelp WantedSuggestion

描述

Diagnostic.file is of type SourceFile which forces plugins to cast a non-SourceFile to a SourceFile to report diagnostic messages and guess which parts of SourceFile are not used by tsserver.

Consider changing file to be something like SourceFileLIke or SourceMapSource that specifies the exact requirements that must be supplied by plugins for this field.

贡献者指南

技术栈
typescript
领域
developer experienceapi
议题类型
feature
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 hours
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
stale
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
TypeScript compiler internalsplugin system
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
20
研究方向
The issue proposes changing the `Diagnostic.file` type from `SourceFile` to a more generic interface like `SourceFileLike` that only includes the properties actually used by `tsserver`. Investigate the current usage of `Diagnostic.file` in the TypeScript codebase, especially in `src/compiler/diagnostic.ts` and related plugin APIs. Review the TypeScript plugin protocol to understand constraints. The existing comment and reactions suggest minimal discussion; consider reaching out to maintainers for alignment on the desired contract.