microsoft / microsoft/TypeScript
In JS, type annotations should not block errors from the rest of the program
まだ誰も着手していません。
- 主要言語
- Go
- スター
- 111k
- フォーク
- 14.4k
- 平均マージ
- 1日 19時間
- マージ済み PR(30日)
- 117
説明
In a Javascript file that is checked by flow, we may see code like this (from create-react-app/packages/react-error-overlay/src/utils/parseCompileError.js)
export type ErrorLocation = {|
fileName: string,
lineNumber: number,
colNumber?: number,
|}
function parseCompileError(message: string): ?ErrorLocation {
const lines: Array<string> = message.split('\n');
for (let i = 0; i < lines.length; i++) {
// ...................
return fileName && lineNumber ? { fileName, lineNumber, colNumber } : null;
}
This behaves badly when the typescript compiler compiles it with checkJs on:
Expected behavior:
- Errors on the type declaration and all the type annotations.
- However, ErrorLocation should be declared as a type alias, and message, lines, etc should all have their declared types.
- If they are used incorrectly, they should have errors.
Actual behavior:
- Errors on the type declaration and all the type annotations.
In the language service:
2. message, lines, etc have the correct types, but ErrorLocation is type any.
3. If they are used incorrectly, they have errors.
In batch compilation:
2. No errors show up except those from (1), even if there are lots of other javascript files without type annotations.
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
create-react-app/packages/react-error-overlay/src/utils/parseCompileError.js の checkJs の例から始め、language-service の動作とバッチコンパイルを比較します。型宣言とアノテーションが ErrorLocation、および message と lines の推論される型にどのような影響を与えるかを追跡します。両方のモードで、アノテーションのエラーが残り、関連のない JavaScript ファイルがそれぞれの型エラーを引き続き報告すれば完了です。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- javascript, typescript
- 領域
- compilers
- issue の種類
- バグ
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 35/100