From eb5610a4123d8009af2c9126985d673e48353c3a Mon Sep 17 00:00:00 2001 From: Josh Goldberg Date: Sun, 5 Jan 2020 14:57:19 -0500 Subject: [PATCH 1/3] Added @ts-expect-error to @ts-ignore directives Similar to `// @ts-ignore`, but will itself cause a new error diagnostic if it does not cause an existing diagnostic to be ignored. Technical summary: 1. The scanner will now keep track of `CommentDirective`s it comes across: both `@ts-expect-error` and `@ts-ignore` 2. During type checking, the program will turn those directives into a map keying them by line number 3. For each diagnostic, if it's preceded by a directive, that directive is marked as "used" 4. All `@ts-expect-error` directives not marked as used generate a new diagnostic error --- src/compiler/diagnosticMessages.json | 4 + src/compiler/parser.ts | 2 + src/compiler/program.ts | 98 +++++++++++-------- src/compiler/scanner.ts | 46 +++++++++ src/compiler/types.ts | 20 ++++ src/compiler/utilities.ts | 39 ++++++++ src/services/services.ts | 1 + .../reference/ts-expect-error.errors.txt | 28 ++++++ tests/baselines/reference/ts-expect-error.js | 29 ++++++ .../reference/ts-expect-error.symbols | 23 +++++ .../baselines/reference/ts-expect-error.types | 29 ++++++ .../baselines/reference/ts-ignore.errors.txt | 22 +++++ tests/baselines/reference/ts-ignore.js | 29 ++++++ tests/baselines/reference/ts-ignore.symbols | 23 +++++ tests/baselines/reference/ts-ignore.types | 29 ++++++ .../conformance/directives/ts-expect-error.ts | 15 +++ .../cases/conformance/directives/ts-ignore.ts | 15 +++ 17 files changed, 411 insertions(+), 41 deletions(-) create mode 100644 tests/baselines/reference/ts-expect-error.errors.txt create mode 100644 tests/baselines/reference/ts-expect-error.js create mode 100644 tests/baselines/reference/ts-expect-error.symbols create mode 100644 tests/baselines/reference/ts-expect-error.types create mode 100644 tests/baselines/reference/ts-ignore.errors.txt create mode 100644 tests/baselines/reference/ts-ignore.js create mode 100644 tests/baselines/reference/ts-ignore.symbols create mode 100644 tests/baselines/reference/ts-ignore.types create mode 100644 tests/cases/conformance/directives/ts-expect-error.ts create mode 100644 tests/cases/conformance/directives/ts-ignore.ts diff --git a/src/compiler/diagnosticMessages.json b/src/compiler/diagnosticMessages.json index f7949496bfee2..a06afceb220cf 100644 --- a/src/compiler/diagnosticMessages.json +++ b/src/compiler/diagnosticMessages.json @@ -2153,6 +2153,10 @@ "category": "Error", "code": 2577 }, + "Unused '@ts-expect-error' directive.": { + "category": "Error", + "code": 2578 + }, "Cannot find name '{0}'. Do you need to install type definitions for node? Try `npm i @types/node`.": { "category": "Error", "code": 2580 diff --git a/src/compiler/parser.ts b/src/compiler/parser.ts index 2287c41431616..3e326a22c792d 100644 --- a/src/compiler/parser.ts +++ b/src/compiler/parser.ts @@ -842,6 +842,7 @@ namespace ts { function clearState() { // Clear out the text the scanner is pointing at, so it doesn't keep anything alive unnecessarily. + scanner.clearCommentDirectives(); scanner.setText(""); scanner.setOnError(undefined); @@ -875,6 +876,7 @@ namespace ts { setExternalModuleIndicator(sourceFile); + sourceFile.commentDirectives = scanner.getCommentDirectives(); sourceFile.nodeCount = nodeCount; sourceFile.identifierCount = identifierCount; sourceFile.identifiers = identifiers; diff --git a/src/compiler/program.ts b/src/compiler/program.ts index 891763ddbbd33..6095d6a598f2d 100644 --- a/src/compiler/program.ts +++ b/src/compiler/program.ts @@ -1,6 +1,4 @@ namespace ts { - const ignoreDiagnosticCommentRegEx = /(^\s*$)|(^\s*\/\/\/?\s*(@ts-ignore)?)/; - export function findConfigFile(searchPath: string, fileExists: (fileName: string) => boolean, configName = "tsconfig.json"): string | undefined { return forEachAncestorDirectory(searchPath, ancestor => { const fileName = combinePaths(ancestor, configName); @@ -1650,17 +1648,16 @@ namespace ts { const fileProcessingDiagnosticsInFile = fileProcessingDiagnostics.getDiagnostics(sourceFile.fileName); const programDiagnosticsInFile = programDiagnostics.getDiagnostics(sourceFile.fileName); - let diagnostics: Diagnostic[] | undefined; - for (const diags of [fileProcessingDiagnosticsInFile, programDiagnosticsInFile]) { - if (diags) { - for (const diag of diags) { - if (shouldReportDiagnostic(diag)) { - diagnostics = append(diagnostics, diag); - } - } - } + return getMergedProgramDiagnostics(sourceFile, fileProcessingDiagnosticsInFile, programDiagnosticsInFile); + } + + function getMergedProgramDiagnostics(sourceFile: SourceFile, ...allDiagnostics: (readonly Diagnostic[] | undefined)[]) { + const flatDiagnostics = flatten(allDiagnostics); + if (!sourceFile.commentDirectives?.length) { + return flatDiagnostics; } - return diagnostics || emptyArray; + + return getDiagnosticsPastDirectives(sourceFile, sourceFile.commentDirectives, flatDiagnostics).diagnostics; } function getDeclarationDiagnostics(sourceFile?: SourceFile, cancellationToken?: CancellationToken): readonly DiagnosticWithLocation[] { @@ -1738,20 +1735,34 @@ namespace ts { const bindDiagnostics: readonly Diagnostic[] = includeBindAndCheckDiagnostics ? sourceFile.bindDiagnostics : emptyArray; const checkDiagnostics = includeBindAndCheckDiagnostics ? typeChecker.getDiagnostics(sourceFile, cancellationToken) : emptyArray; - let diagnostics: Diagnostic[] | undefined; - for (const diags of [bindDiagnostics, checkDiagnostics, isCheckJs ? sourceFile.jsDocDiagnostics : undefined]) { - if (diags) { - for (const diag of diags) { - if (shouldReportDiagnostic(diag)) { - diagnostics = append(diagnostics, diag); - } - } - } - } - return diagnostics || emptyArray; + return getMergedBindAndCheckDiagnostics(sourceFile, bindDiagnostics, checkDiagnostics, isCheckJs ? sourceFile.jsDocDiagnostics : undefined); }); } + function getMergedBindAndCheckDiagnostics(sourceFile: SourceFile, ...allDiagnostics: (readonly Diagnostic[] | undefined)[]) { + const flatDiagnostics = flatten(allDiagnostics); + if (!sourceFile.commentDirectives?.length) { + return flatDiagnostics; + } + + const { diagnostics, directives } = getDiagnosticsPastDirectives(sourceFile, sourceFile.commentDirectives, flatDiagnostics); + + for (const errorExpectation of directives.getUnusedExpectations()) { + diagnostics.push(createDiagnosticForRange(sourceFile, errorExpectation.range, Diagnostics.Unused_ts_expect_error_directive)); + } + + return diagnostics; + } + + function getDiagnosticsPastDirectives(sourceFile: SourceFile, commentDirectives: CommentDirective[], flatDiagnostics: Diagnostic[]) { + // Diagnostics are only reported if there is no comment directive preceding them + // This will modify the directives map by marking "used" ones with a corresponding diagnostic + const directives = createCommentDirectivesMap(sourceFile, commentDirectives); + const diagnostics = flatDiagnostics.filter(diagnostic => markPrecedingCommentDirectiveLine(diagnostic, directives) === -1); + + return { diagnostics, directives }; + } + function getSuggestionDiagnostics(sourceFile: SourceFile, cancellationToken: CancellationToken): readonly DiagnosticWithLocation[] { return runWithCancellationToken(() => { return getDiagnosticsProducingTypeChecker().getSuggestionDiagnostics(sourceFile, cancellationToken); @@ -1759,28 +1770,33 @@ namespace ts { } /** - * Skip errors if previous line start with '// @ts-ignore' comment, not counting non-empty non-comment lines + * @returns The line index marked as preceding the diagnostic, or -1 if none was. */ - function shouldReportDiagnostic(diagnostic: Diagnostic) { + function markPrecedingCommentDirectiveLine(diagnostic: Diagnostic, directives: CommentDirectivesMap) { const { file, start } = diagnostic; - if (file) { - const lineStarts = getLineStarts(file); - let { line } = computeLineAndCharacterOfPosition(lineStarts, start!); // TODO: GH#18217 - while (line > 0) { - const previousLineText = file.text.slice(lineStarts[line - 1], lineStarts[line]); - const result = ignoreDiagnosticCommentRegEx.exec(previousLineText); - if (!result) { - // non-empty line - return true; - } - if (result[3]) { - // @ts-ignore - return false; - } - line--; + if (!file) { + return -1; + } + + // Start out with the line just before the text + const lineStarts = getLineStarts(file); + let line = computeLineAndCharacterOfPosition(lineStarts, start!).line - 1; // TODO: GH#18217 + while (line >= 0) { + // As soon as that line is known to have a comment directive, use that + if (directives.markUsed(line)) { + return line; } + + // Stop searching if the line is not empty and not a comment + const lineText = file.text.slice(lineStarts[line - 1], lineStarts[line]).trim(); + if (lineText !== "" && !/^(\s*)\/\/(.*)$/.test(lineText)) { + return -1; + } + + line--; } - return true; + + return -1; } function getJSSyntacticDiagnosticsForFile(sourceFile: SourceFile): DiagnosticWithLocation[] { diff --git a/src/compiler/scanner.ts b/src/compiler/scanner.ts index 2ccc8ef270d0f..cbe4044698a14 100644 --- a/src/compiler/scanner.ts +++ b/src/compiler/scanner.ts @@ -25,6 +25,8 @@ namespace ts { isReservedWord(): boolean; isUnterminated(): boolean; /* @internal */ + getCommentDirectives(): CommentDirective[] | undefined; + /* @internal */ getTokenFlags(): TokenFlags; reScanGreaterToken(): SyntaxKind; reScanSlashToken(): SyntaxKind; @@ -38,7 +40,10 @@ namespace ts { scanJsxToken(): JsxTokenSyntaxKind; scanJsDocToken(): JSDocSyntaxKind; scan(): SyntaxKind; + getText(): string; + /* @internal */ + clearCommentDirectives(): void; // Sets the text for the scanner to scan. An optional subrange starting point and length // can be provided to have the scanner only scan a portion of the text. setText(text: string | undefined, start?: number, length?: number): void; @@ -263,6 +268,11 @@ namespace ts { const unicodeESNextIdentifierStart = [65, 90, 97, 122, 170, 170, 181, 181, 186, 186, 192, 214, 216, 246, 248, 705, 710, 721, 736, 740, 748, 748, 750, 750, 880, 884, 886, 887, 890, 893, 895, 895, 902, 902, 904, 906, 908, 908, 910, 929, 931, 1013, 1015, 1153, 1162, 1327, 1329, 1366, 1369, 1369, 1376, 1416, 1488, 1514, 1519, 1522, 1568, 1610, 1646, 1647, 1649, 1747, 1749, 1749, 1765, 1766, 1774, 1775, 1786, 1788, 1791, 1791, 1808, 1808, 1810, 1839, 1869, 1957, 1969, 1969, 1994, 2026, 2036, 2037, 2042, 2042, 2048, 2069, 2074, 2074, 2084, 2084, 2088, 2088, 2112, 2136, 2144, 2154, 2208, 2228, 2230, 2237, 2308, 2361, 2365, 2365, 2384, 2384, 2392, 2401, 2417, 2432, 2437, 2444, 2447, 2448, 2451, 2472, 2474, 2480, 2482, 2482, 2486, 2489, 2493, 2493, 2510, 2510, 2524, 2525, 2527, 2529, 2544, 2545, 2556, 2556, 2565, 2570, 2575, 2576, 2579, 2600, 2602, 2608, 2610, 2611, 2613, 2614, 2616, 2617, 2649, 2652, 2654, 2654, 2674, 2676, 2693, 2701, 2703, 2705, 2707, 2728, 2730, 2736, 2738, 2739, 2741, 2745, 2749, 2749, 2768, 2768, 2784, 2785, 2809, 2809, 2821, 2828, 2831, 2832, 2835, 2856, 2858, 2864, 2866, 2867, 2869, 2873, 2877, 2877, 2908, 2909, 2911, 2913, 2929, 2929, 2947, 2947, 2949, 2954, 2958, 2960, 2962, 2965, 2969, 2970, 2972, 2972, 2974, 2975, 2979, 2980, 2984, 2986, 2990, 3001, 3024, 3024, 3077, 3084, 3086, 3088, 3090, 3112, 3114, 3129, 3133, 3133, 3160, 3162, 3168, 3169, 3200, 3200, 3205, 3212, 3214, 3216, 3218, 3240, 3242, 3251, 3253, 3257, 3261, 3261, 3294, 3294, 3296, 3297, 3313, 3314, 3333, 3340, 3342, 3344, 3346, 3386, 3389, 3389, 3406, 3406, 3412, 3414, 3423, 3425, 3450, 3455, 3461, 3478, 3482, 3505, 3507, 3515, 3517, 3517, 3520, 3526, 3585, 3632, 3634, 3635, 3648, 3654, 3713, 3714, 3716, 3716, 3718, 3722, 3724, 3747, 3749, 3749, 3751, 3760, 3762, 3763, 3773, 3773, 3776, 3780, 3782, 3782, 3804, 3807, 3840, 3840, 3904, 3911, 3913, 3948, 3976, 3980, 4096, 4138, 4159, 4159, 4176, 4181, 4186, 4189, 4193, 4193, 4197, 4198, 4206, 4208, 4213, 4225, 4238, 4238, 4256, 4293, 4295, 4295, 4301, 4301, 4304, 4346, 4348, 4680, 4682, 4685, 4688, 4694, 4696, 4696, 4698, 4701, 4704, 4744, 4746, 4749, 4752, 4784, 4786, 4789, 4792, 4798, 4800, 4800, 4802, 4805, 4808, 4822, 4824, 4880, 4882, 4885, 4888, 4954, 4992, 5007, 5024, 5109, 5112, 5117, 5121, 5740, 5743, 5759, 5761, 5786, 5792, 5866, 5870, 5880, 5888, 5900, 5902, 5905, 5920, 5937, 5952, 5969, 5984, 5996, 5998, 6000, 6016, 6067, 6103, 6103, 6108, 6108, 6176, 6264, 6272, 6312, 6314, 6314, 6320, 6389, 6400, 6430, 6480, 6509, 6512, 6516, 6528, 6571, 6576, 6601, 6656, 6678, 6688, 6740, 6823, 6823, 6917, 6963, 6981, 6987, 7043, 7072, 7086, 7087, 7098, 7141, 7168, 7203, 7245, 7247, 7258, 7293, 7296, 7304, 7312, 7354, 7357, 7359, 7401, 7404, 7406, 7411, 7413, 7414, 7418, 7418, 7424, 7615, 7680, 7957, 7960, 7965, 7968, 8005, 8008, 8013, 8016, 8023, 8025, 8025, 8027, 8027, 8029, 8029, 8031, 8061, 8064, 8116, 8118, 8124, 8126, 8126, 8130, 8132, 8134, 8140, 8144, 8147, 8150, 8155, 8160, 8172, 8178, 8180, 8182, 8188, 8305, 8305, 8319, 8319, 8336, 8348, 8450, 8450, 8455, 8455, 8458, 8467, 8469, 8469, 8472, 8477, 8484, 8484, 8486, 8486, 8488, 8488, 8490, 8505, 8508, 8511, 8517, 8521, 8526, 8526, 8544, 8584, 11264, 11310, 11312, 11358, 11360, 11492, 11499, 11502, 11506, 11507, 11520, 11557, 11559, 11559, 11565, 11565, 11568, 11623, 11631, 11631, 11648, 11670, 11680, 11686, 11688, 11694, 11696, 11702, 11704, 11710, 11712, 11718, 11720, 11726, 11728, 11734, 11736, 11742, 12293, 12295, 12321, 12329, 12337, 12341, 12344, 12348, 12353, 12438, 12443, 12447, 12449, 12538, 12540, 12543, 12549, 12591, 12593, 12686, 12704, 12730, 12784, 12799, 13312, 19893, 19968, 40943, 40960, 42124, 42192, 42237, 42240, 42508, 42512, 42527, 42538, 42539, 42560, 42606, 42623, 42653, 42656, 42735, 42775, 42783, 42786, 42888, 42891, 42943, 42946, 42950, 42999, 43009, 43011, 43013, 43015, 43018, 43020, 43042, 43072, 43123, 43138, 43187, 43250, 43255, 43259, 43259, 43261, 43262, 43274, 43301, 43312, 43334, 43360, 43388, 43396, 43442, 43471, 43471, 43488, 43492, 43494, 43503, 43514, 43518, 43520, 43560, 43584, 43586, 43588, 43595, 43616, 43638, 43642, 43642, 43646, 43695, 43697, 43697, 43701, 43702, 43705, 43709, 43712, 43712, 43714, 43714, 43739, 43741, 43744, 43754, 43762, 43764, 43777, 43782, 43785, 43790, 43793, 43798, 43808, 43814, 43816, 43822, 43824, 43866, 43868, 43879, 43888, 44002, 44032, 55203, 55216, 55238, 55243, 55291, 63744, 64109, 64112, 64217, 64256, 64262, 64275, 64279, 64285, 64285, 64287, 64296, 64298, 64310, 64312, 64316, 64318, 64318, 64320, 64321, 64323, 64324, 64326, 64433, 64467, 64829, 64848, 64911, 64914, 64967, 65008, 65019, 65136, 65140, 65142, 65276, 65313, 65338, 65345, 65370, 65382, 65470, 65474, 65479, 65482, 65487, 65490, 65495, 65498, 65500, 65536, 65547, 65549, 65574, 65576, 65594, 65596, 65597, 65599, 65613, 65616, 65629, 65664, 65786, 65856, 65908, 66176, 66204, 66208, 66256, 66304, 66335, 66349, 66378, 66384, 66421, 66432, 66461, 66464, 66499, 66504, 66511, 66513, 66517, 66560, 66717, 66736, 66771, 66776, 66811, 66816, 66855, 66864, 66915, 67072, 67382, 67392, 67413, 67424, 67431, 67584, 67589, 67592, 67592, 67594, 67637, 67639, 67640, 67644, 67644, 67647, 67669, 67680, 67702, 67712, 67742, 67808, 67826, 67828, 67829, 67840, 67861, 67872, 67897, 67968, 68023, 68030, 68031, 68096, 68096, 68112, 68115, 68117, 68119, 68121, 68149, 68192, 68220, 68224, 68252, 68288, 68295, 68297, 68324, 68352, 68405, 68416, 68437, 68448, 68466, 68480, 68497, 68608, 68680, 68736, 68786, 68800, 68850, 68864, 68899, 69376, 69404, 69415, 69415, 69424, 69445, 69600, 69622, 69635, 69687, 69763, 69807, 69840, 69864, 69891, 69926, 69956, 69956, 69968, 70002, 70006, 70006, 70019, 70066, 70081, 70084, 70106, 70106, 70108, 70108, 70144, 70161, 70163, 70187, 70272, 70278, 70280, 70280, 70282, 70285, 70287, 70301, 70303, 70312, 70320, 70366, 70405, 70412, 70415, 70416, 70419, 70440, 70442, 70448, 70450, 70451, 70453, 70457, 70461, 70461, 70480, 70480, 70493, 70497, 70656, 70708, 70727, 70730, 70751, 70751, 70784, 70831, 70852, 70853, 70855, 70855, 71040, 71086, 71128, 71131, 71168, 71215, 71236, 71236, 71296, 71338, 71352, 71352, 71424, 71450, 71680, 71723, 71840, 71903, 71935, 71935, 72096, 72103, 72106, 72144, 72161, 72161, 72163, 72163, 72192, 72192, 72203, 72242, 72250, 72250, 72272, 72272, 72284, 72329, 72349, 72349, 72384, 72440, 72704, 72712, 72714, 72750, 72768, 72768, 72818, 72847, 72960, 72966, 72968, 72969, 72971, 73008, 73030, 73030, 73056, 73061, 73063, 73064, 73066, 73097, 73112, 73112, 73440, 73458, 73728, 74649, 74752, 74862, 74880, 75075, 77824, 78894, 82944, 83526, 92160, 92728, 92736, 92766, 92880, 92909, 92928, 92975, 92992, 92995, 93027, 93047, 93053, 93071, 93760, 93823, 93952, 94026, 94032, 94032, 94099, 94111, 94176, 94177, 94179, 94179, 94208, 100343, 100352, 101106, 110592, 110878, 110928, 110930, 110948, 110951, 110960, 111355, 113664, 113770, 113776, 113788, 113792, 113800, 113808, 113817, 119808, 119892, 119894, 119964, 119966, 119967, 119970, 119970, 119973, 119974, 119977, 119980, 119982, 119993, 119995, 119995, 119997, 120003, 120005, 120069, 120071, 120074, 120077, 120084, 120086, 120092, 120094, 120121, 120123, 120126, 120128, 120132, 120134, 120134, 120138, 120144, 120146, 120485, 120488, 120512, 120514, 120538, 120540, 120570, 120572, 120596, 120598, 120628, 120630, 120654, 120656, 120686, 120688, 120712, 120714, 120744, 120746, 120770, 120772, 120779, 123136, 123180, 123191, 123197, 123214, 123214, 123584, 123627, 124928, 125124, 125184, 125251, 125259, 125259, 126464, 126467, 126469, 126495, 126497, 126498, 126500, 126500, 126503, 126503, 126505, 126514, 126516, 126519, 126521, 126521, 126523, 126523, 126530, 126530, 126535, 126535, 126537, 126537, 126539, 126539, 126541, 126543, 126545, 126546, 126548, 126548, 126551, 126551, 126553, 126553, 126555, 126555, 126557, 126557, 126559, 126559, 126561, 126562, 126564, 126564, 126567, 126570, 126572, 126578, 126580, 126583, 126585, 126588, 126590, 126590, 126592, 126601, 126603, 126619, 126625, 126627, 126629, 126633, 126635, 126651, 131072, 173782, 173824, 177972, 177984, 178205, 178208, 183969, 183984, 191456, 194560, 195101]; const unicodeESNextIdentifierPart = [48, 57, 65, 90, 95, 95, 97, 122, 170, 170, 181, 181, 183, 183, 186, 186, 192, 214, 216, 246, 248, 705, 710, 721, 736, 740, 748, 748, 750, 750, 768, 884, 886, 887, 890, 893, 895, 895, 902, 906, 908, 908, 910, 929, 931, 1013, 1015, 1153, 1155, 1159, 1162, 1327, 1329, 1366, 1369, 1369, 1376, 1416, 1425, 1469, 1471, 1471, 1473, 1474, 1476, 1477, 1479, 1479, 1488, 1514, 1519, 1522, 1552, 1562, 1568, 1641, 1646, 1747, 1749, 1756, 1759, 1768, 1770, 1788, 1791, 1791, 1808, 1866, 1869, 1969, 1984, 2037, 2042, 2042, 2045, 2045, 2048, 2093, 2112, 2139, 2144, 2154, 2208, 2228, 2230, 2237, 2259, 2273, 2275, 2403, 2406, 2415, 2417, 2435, 2437, 2444, 2447, 2448, 2451, 2472, 2474, 2480, 2482, 2482, 2486, 2489, 2492, 2500, 2503, 2504, 2507, 2510, 2519, 2519, 2524, 2525, 2527, 2531, 2534, 2545, 2556, 2556, 2558, 2558, 2561, 2563, 2565, 2570, 2575, 2576, 2579, 2600, 2602, 2608, 2610, 2611, 2613, 2614, 2616, 2617, 2620, 2620, 2622, 2626, 2631, 2632, 2635, 2637, 2641, 2641, 2649, 2652, 2654, 2654, 2662, 2677, 2689, 2691, 2693, 2701, 2703, 2705, 2707, 2728, 2730, 2736, 2738, 2739, 2741, 2745, 2748, 2757, 2759, 2761, 2763, 2765, 2768, 2768, 2784, 2787, 2790, 2799, 2809, 2815, 2817, 2819, 2821, 2828, 2831, 2832, 2835, 2856, 2858, 2864, 2866, 2867, 2869, 2873, 2876, 2884, 2887, 2888, 2891, 2893, 2902, 2903, 2908, 2909, 2911, 2915, 2918, 2927, 2929, 2929, 2946, 2947, 2949, 2954, 2958, 2960, 2962, 2965, 2969, 2970, 2972, 2972, 2974, 2975, 2979, 2980, 2984, 2986, 2990, 3001, 3006, 3010, 3014, 3016, 3018, 3021, 3024, 3024, 3031, 3031, 3046, 3055, 3072, 3084, 3086, 3088, 3090, 3112, 3114, 3129, 3133, 3140, 3142, 3144, 3146, 3149, 3157, 3158, 3160, 3162, 3168, 3171, 3174, 3183, 3200, 3203, 3205, 3212, 3214, 3216, 3218, 3240, 3242, 3251, 3253, 3257, 3260, 3268, 3270, 3272, 3274, 3277, 3285, 3286, 3294, 3294, 3296, 3299, 3302, 3311, 3313, 3314, 3328, 3331, 3333, 3340, 3342, 3344, 3346, 3396, 3398, 3400, 3402, 3406, 3412, 3415, 3423, 3427, 3430, 3439, 3450, 3455, 3458, 3459, 3461, 3478, 3482, 3505, 3507, 3515, 3517, 3517, 3520, 3526, 3530, 3530, 3535, 3540, 3542, 3542, 3544, 3551, 3558, 3567, 3570, 3571, 3585, 3642, 3648, 3662, 3664, 3673, 3713, 3714, 3716, 3716, 3718, 3722, 3724, 3747, 3749, 3749, 3751, 3773, 3776, 3780, 3782, 3782, 3784, 3789, 3792, 3801, 3804, 3807, 3840, 3840, 3864, 3865, 3872, 3881, 3893, 3893, 3895, 3895, 3897, 3897, 3902, 3911, 3913, 3948, 3953, 3972, 3974, 3991, 3993, 4028, 4038, 4038, 4096, 4169, 4176, 4253, 4256, 4293, 4295, 4295, 4301, 4301, 4304, 4346, 4348, 4680, 4682, 4685, 4688, 4694, 4696, 4696, 4698, 4701, 4704, 4744, 4746, 4749, 4752, 4784, 4786, 4789, 4792, 4798, 4800, 4800, 4802, 4805, 4808, 4822, 4824, 4880, 4882, 4885, 4888, 4954, 4957, 4959, 4969, 4977, 4992, 5007, 5024, 5109, 5112, 5117, 5121, 5740, 5743, 5759, 5761, 5786, 5792, 5866, 5870, 5880, 5888, 5900, 5902, 5908, 5920, 5940, 5952, 5971, 5984, 5996, 5998, 6000, 6002, 6003, 6016, 6099, 6103, 6103, 6108, 6109, 6112, 6121, 6155, 6157, 6160, 6169, 6176, 6264, 6272, 6314, 6320, 6389, 6400, 6430, 6432, 6443, 6448, 6459, 6470, 6509, 6512, 6516, 6528, 6571, 6576, 6601, 6608, 6618, 6656, 6683, 6688, 6750, 6752, 6780, 6783, 6793, 6800, 6809, 6823, 6823, 6832, 6845, 6912, 6987, 6992, 7001, 7019, 7027, 7040, 7155, 7168, 7223, 7232, 7241, 7245, 7293, 7296, 7304, 7312, 7354, 7357, 7359, 7376, 7378, 7380, 7418, 7424, 7673, 7675, 7957, 7960, 7965, 7968, 8005, 8008, 8013, 8016, 8023, 8025, 8025, 8027, 8027, 8029, 8029, 8031, 8061, 8064, 8116, 8118, 8124, 8126, 8126, 8130, 8132, 8134, 8140, 8144, 8147, 8150, 8155, 8160, 8172, 8178, 8180, 8182, 8188, 8255, 8256, 8276, 8276, 8305, 8305, 8319, 8319, 8336, 8348, 8400, 8412, 8417, 8417, 8421, 8432, 8450, 8450, 8455, 8455, 8458, 8467, 8469, 8469, 8472, 8477, 8484, 8484, 8486, 8486, 8488, 8488, 8490, 8505, 8508, 8511, 8517, 8521, 8526, 8526, 8544, 8584, 11264, 11310, 11312, 11358, 11360, 11492, 11499, 11507, 11520, 11557, 11559, 11559, 11565, 11565, 11568, 11623, 11631, 11631, 11647, 11670, 11680, 11686, 11688, 11694, 11696, 11702, 11704, 11710, 11712, 11718, 11720, 11726, 11728, 11734, 11736, 11742, 11744, 11775, 12293, 12295, 12321, 12335, 12337, 12341, 12344, 12348, 12353, 12438, 12441, 12447, 12449, 12538, 12540, 12543, 12549, 12591, 12593, 12686, 12704, 12730, 12784, 12799, 13312, 19893, 19968, 40943, 40960, 42124, 42192, 42237, 42240, 42508, 42512, 42539, 42560, 42607, 42612, 42621, 42623, 42737, 42775, 42783, 42786, 42888, 42891, 42943, 42946, 42950, 42999, 43047, 43072, 43123, 43136, 43205, 43216, 43225, 43232, 43255, 43259, 43259, 43261, 43309, 43312, 43347, 43360, 43388, 43392, 43456, 43471, 43481, 43488, 43518, 43520, 43574, 43584, 43597, 43600, 43609, 43616, 43638, 43642, 43714, 43739, 43741, 43744, 43759, 43762, 43766, 43777, 43782, 43785, 43790, 43793, 43798, 43808, 43814, 43816, 43822, 43824, 43866, 43868, 43879, 43888, 44010, 44012, 44013, 44016, 44025, 44032, 55203, 55216, 55238, 55243, 55291, 63744, 64109, 64112, 64217, 64256, 64262, 64275, 64279, 64285, 64296, 64298, 64310, 64312, 64316, 64318, 64318, 64320, 64321, 64323, 64324, 64326, 64433, 64467, 64829, 64848, 64911, 64914, 64967, 65008, 65019, 65024, 65039, 65056, 65071, 65075, 65076, 65101, 65103, 65136, 65140, 65142, 65276, 65296, 65305, 65313, 65338, 65343, 65343, 65345, 65370, 65382, 65470, 65474, 65479, 65482, 65487, 65490, 65495, 65498, 65500, 65536, 65547, 65549, 65574, 65576, 65594, 65596, 65597, 65599, 65613, 65616, 65629, 65664, 65786, 65856, 65908, 66045, 66045, 66176, 66204, 66208, 66256, 66272, 66272, 66304, 66335, 66349, 66378, 66384, 66426, 66432, 66461, 66464, 66499, 66504, 66511, 66513, 66517, 66560, 66717, 66720, 66729, 66736, 66771, 66776, 66811, 66816, 66855, 66864, 66915, 67072, 67382, 67392, 67413, 67424, 67431, 67584, 67589, 67592, 67592, 67594, 67637, 67639, 67640, 67644, 67644, 67647, 67669, 67680, 67702, 67712, 67742, 67808, 67826, 67828, 67829, 67840, 67861, 67872, 67897, 67968, 68023, 68030, 68031, 68096, 68099, 68101, 68102, 68108, 68115, 68117, 68119, 68121, 68149, 68152, 68154, 68159, 68159, 68192, 68220, 68224, 68252, 68288, 68295, 68297, 68326, 68352, 68405, 68416, 68437, 68448, 68466, 68480, 68497, 68608, 68680, 68736, 68786, 68800, 68850, 68864, 68903, 68912, 68921, 69376, 69404, 69415, 69415, 69424, 69456, 69600, 69622, 69632, 69702, 69734, 69743, 69759, 69818, 69840, 69864, 69872, 69881, 69888, 69940, 69942, 69951, 69956, 69958, 69968, 70003, 70006, 70006, 70016, 70084, 70089, 70092, 70096, 70106, 70108, 70108, 70144, 70161, 70163, 70199, 70206, 70206, 70272, 70278, 70280, 70280, 70282, 70285, 70287, 70301, 70303, 70312, 70320, 70378, 70384, 70393, 70400, 70403, 70405, 70412, 70415, 70416, 70419, 70440, 70442, 70448, 70450, 70451, 70453, 70457, 70459, 70468, 70471, 70472, 70475, 70477, 70480, 70480, 70487, 70487, 70493, 70499, 70502, 70508, 70512, 70516, 70656, 70730, 70736, 70745, 70750, 70751, 70784, 70853, 70855, 70855, 70864, 70873, 71040, 71093, 71096, 71104, 71128, 71133, 71168, 71232, 71236, 71236, 71248, 71257, 71296, 71352, 71360, 71369, 71424, 71450, 71453, 71467, 71472, 71481, 71680, 71738, 71840, 71913, 71935, 71935, 72096, 72103, 72106, 72151, 72154, 72161, 72163, 72164, 72192, 72254, 72263, 72263, 72272, 72345, 72349, 72349, 72384, 72440, 72704, 72712, 72714, 72758, 72760, 72768, 72784, 72793, 72818, 72847, 72850, 72871, 72873, 72886, 72960, 72966, 72968, 72969, 72971, 73014, 73018, 73018, 73020, 73021, 73023, 73031, 73040, 73049, 73056, 73061, 73063, 73064, 73066, 73102, 73104, 73105, 73107, 73112, 73120, 73129, 73440, 73462, 73728, 74649, 74752, 74862, 74880, 75075, 77824, 78894, 82944, 83526, 92160, 92728, 92736, 92766, 92768, 92777, 92880, 92909, 92912, 92916, 92928, 92982, 92992, 92995, 93008, 93017, 93027, 93047, 93053, 93071, 93760, 93823, 93952, 94026, 94031, 94087, 94095, 94111, 94176, 94177, 94179, 94179, 94208, 100343, 100352, 101106, 110592, 110878, 110928, 110930, 110948, 110951, 110960, 111355, 113664, 113770, 113776, 113788, 113792, 113800, 113808, 113817, 113821, 113822, 119141, 119145, 119149, 119154, 119163, 119170, 119173, 119179, 119210, 119213, 119362, 119364, 119808, 119892, 119894, 119964, 119966, 119967, 119970, 119970, 119973, 119974, 119977, 119980, 119982, 119993, 119995, 119995, 119997, 120003, 120005, 120069, 120071, 120074, 120077, 120084, 120086, 120092, 120094, 120121, 120123, 120126, 120128, 120132, 120134, 120134, 120138, 120144, 120146, 120485, 120488, 120512, 120514, 120538, 120540, 120570, 120572, 120596, 120598, 120628, 120630, 120654, 120656, 120686, 120688, 120712, 120714, 120744, 120746, 120770, 120772, 120779, 120782, 120831, 121344, 121398, 121403, 121452, 121461, 121461, 121476, 121476, 121499, 121503, 121505, 121519, 122880, 122886, 122888, 122904, 122907, 122913, 122915, 122916, 122918, 122922, 123136, 123180, 123184, 123197, 123200, 123209, 123214, 123214, 123584, 123641, 124928, 125124, 125136, 125142, 125184, 125259, 125264, 125273, 126464, 126467, 126469, 126495, 126497, 126498, 126500, 126500, 126503, 126503, 126505, 126514, 126516, 126519, 126521, 126521, 126523, 126523, 126530, 126530, 126535, 126535, 126537, 126537, 126539, 126539, 126541, 126543, 126545, 126546, 126548, 126548, 126551, 126551, 126553, 126553, 126555, 126555, 126557, 126557, 126559, 126559, 126561, 126562, 126564, 126564, 126567, 126570, 126572, 126578, 126580, 126583, 126585, 126588, 126590, 126590, 126592, 126601, 126603, 126619, 126625, 126627, 126629, 126633, 126635, 126651, 131072, 173782, 173824, 177972, 177984, 178205, 178208, 183969, 183984, 191456, 194560, 195101, 917760, 917999]; + /** + * Test for whether a comment's text contains a `@ts-expect-error` or `@ts-ignore` directive. + */ + const commentDirectiveRegEx = /^\s*\/\/\/?\s*@(ts-expect-error|ts-ignore)/; + function lookupInUnicodeMap(code: number, map: readonly number[]): boolean { // Bail out quickly if it couldn't possibly be in the map. if (code < map[0]) { @@ -880,6 +890,7 @@ namespace ts { let tokenValue!: string; let tokenFlags: TokenFlags; + let commentDirectives: CommentDirective[] | undefined; let inJSDocType = 0; setText(text, start, length); @@ -897,6 +908,7 @@ namespace ts { isIdentifier: () => token === SyntaxKind.Identifier || token > SyntaxKind.LastReservedWord, isReservedWord: () => token >= SyntaxKind.FirstReservedWord && token <= SyntaxKind.LastReservedWord, isUnterminated: () => (tokenFlags & TokenFlags.Unterminated) !== 0, + getCommentDirectives: () => commentDirectives, getTokenFlags: () => tokenFlags, reScanGreaterToken, reScanSlashToken, @@ -911,6 +923,7 @@ namespace ts { scanJsDocToken, scan, getText, + clearCommentDirectives, setText, setScriptTarget, setLanguageVariant, @@ -1641,7 +1654,17 @@ namespace ts { break; } pos++; + } + const type = getDirectiveFromComment(text.slice(tokenPos, pos)); + if (type !== undefined) { + commentDirectives = append( + commentDirectives, + { + range: { pos: tokenPos, end: pos }, + type, + }, + ); } if (skipTrivia) { @@ -2015,6 +2038,23 @@ namespace ts { return token; } + function getDirectiveFromComment(text: string) { + const match = commentDirectiveRegEx.exec(text); + if (!match) { + return undefined; + } + + switch (match[1]) { + case "ts-expect-error": + return CommentDirectiveType.ExpectError; + + case "ts-ignore": + return CommentDirectiveType.Ignore; + } + + return undefined; + } + /** * Unconditionally back up and scan a template expression portion. */ @@ -2256,6 +2296,7 @@ namespace ts { const saveToken = token; const saveTokenValue = tokenValue; const saveTokenFlags = tokenFlags; + const saveErrorExpectations = commentDirectives; setText(text, start, length); const result = callback(); @@ -2267,6 +2308,7 @@ namespace ts { token = saveToken; tokenValue = saveTokenValue; tokenFlags = saveTokenFlags; + commentDirectives = saveErrorExpectations; return result; } @@ -2283,6 +2325,10 @@ namespace ts { return text; } + function clearCommentDirectives() { + commentDirectives = undefined; + } + function setText(newText: string | undefined, start: number | undefined, length: number | undefined) { text = newText || ""; end = length === undefined ? text.length : start! + length; diff --git a/src/compiler/types.ts b/src/compiler/types.ts index 107f2b8155205..6ba1a72cce4fc 100644 --- a/src/compiler/types.ts +++ b/src/compiler/types.ts @@ -2963,6 +2963,8 @@ namespace ts { // This field should never be used directly to obtain line map, use getLineMap function instead. /* @internal */ lineMap: readonly number[]; /* @internal */ classifiableNames?: ReadonlyUnderscoreEscapedMap; + // Comments containing @ts-* directives, in order. + /* @internal */ commentDirectives?: CommentDirective[]; // Stores a mapping 'external module reference text' -> 'resolved file name' | undefined // It is used to resolve module names in the checker. // Content of this field should never be used directly - use getResolvedModuleFileName/setResolvedModuleFileName functions instead @@ -2982,6 +2984,18 @@ namespace ts { /*@internal*/ exportedModulesFromDeclarationEmit?: ExportedModulesFromDeclarationEmit; } + /* @internal */ + export interface CommentDirective { + range: TextRange; + type: CommentDirectiveType, + } + + /* @internal */ + export const enum CommentDirectiveType { + ExpectError, + Ignore, + } + /*@internal*/ export type ExportedModulesFromDeclarationEmit = readonly Symbol[]; @@ -6566,6 +6580,12 @@ namespace ts { forEach(action: (value: PragmaPseudoMap[TKey] | PragmaPseudoMap[TKey][], key: TKey) => void): void; } + /* @internal */ + export interface CommentDirectivesMap { + getUnusedExpectations(): CommentDirective[]; + markUsed(matchedLine: number): boolean; + } + export interface UserPreferences { readonly disableSuggestions?: boolean; readonly quotePreference?: "auto" | "double" | "single"; diff --git a/src/compiler/utilities.ts b/src/compiler/utilities.ts index 93343650841c7..a684220b0a07e 100644 --- a/src/compiler/utilities.ts +++ b/src/compiler/utilities.ts @@ -466,6 +466,34 @@ namespace ts { text.charCodeAt(start + 2) === CharacterCodes.exclamation; } + export function createCommentDirectivesMap(sourceFile: SourceFile, commentDirectives: CommentDirective[]): CommentDirectivesMap { + const directivesByLine = createMapFromEntries( + commentDirectives.map(commentDirective => ([ + `${getLineAndCharacterOfPosition(sourceFile, commentDirective.range.pos).line}`, + commentDirective, + ])) + ); + + const usedLines = createMap(); + + return { getUnusedExpectations, markUsed }; + + function getUnusedExpectations() { + return arrayFrom(directivesByLine.entries()) + .filter(([line, directive]) => directive.type === CommentDirectiveType.ExpectError && !usedLines.get(line)) + .map(([_, directive]) => directive); + } + + function markUsed(line: number) { + if (!directivesByLine.has(`${line}`)) { + return false; + } + + usedLines.set(`${line}`, true); + return true; + } + } + export function getTokenPosOfNode(node: Node, sourceFile?: SourceFileLike, includeJsDoc?: boolean): number { // With nodes that have no width (i.e. 'Missing' nodes), we actually *don't* // want to skip trivia because this will launch us forward to the next token. @@ -901,6 +929,17 @@ namespace ts { }; } + export function createDiagnosticForRange(sourceFile: SourceFile, range: TextRange, message: DiagnosticMessage): DiagnosticWithLocation { + return { + file: sourceFile, + start: range.pos, + length: range.end - range.pos, + code: message.code, + category: message.category, + messageText: message.message, + }; + } + export function getSpanOfTokenAtPosition(sourceFile: SourceFile, pos: number): TextSpan { const scanner = createScanner(sourceFile.languageVersion, /*skipTrivia*/ true, sourceFile.languageVariant, sourceFile.text, /*onError:*/ undefined, pos); scanner.scan(); diff --git a/src/services/services.ts b/src/services/services.ts index 1a3eae675e62c..d532efe356bac 100644 --- a/src/services/services.ts +++ b/src/services/services.ts @@ -614,6 +614,7 @@ namespace ts { private namedDeclarations: Map | undefined; public ambientModuleNames!: string[]; public checkJsDirective: CheckJsDirective | undefined; + public errorExpectations: TextRange[] | undefined; public possiblyContainDynamicImport?: boolean; public pragmas!: PragmaMap; public localJsxFactory: EntityName | undefined; diff --git a/tests/baselines/reference/ts-expect-error.errors.txt b/tests/baselines/reference/ts-expect-error.errors.txt new file mode 100644 index 0000000000000..7ffda9dbf1f9e --- /dev/null +++ b/tests/baselines/reference/ts-expect-error.errors.txt @@ -0,0 +1,28 @@ +tests/cases/conformance/directives/ts-expect-error.ts(4,1): error TS2578: Unused '@ts-expect-error' directive. +tests/cases/conformance/directives/ts-expect-error.ts(10,1): error TS2578: Unused '@ts-expect-error' directive. +tests/cases/conformance/directives/ts-expect-error.ts(13,5): error TS2322: Type '"nope"' is not assignable to type 'number'. + + +==== tests/cases/conformance/directives/ts-expect-error.ts (3 errors) ==== + // @ts-expect-error additional commenting + var invalidCommentedFancy: number = 'nope'; + + // @ts-expect-error additional commenting + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +!!! error TS2578: Unused '@ts-expect-error' directive. + var validCommentedFancy: string = 'nope'; + + // @ts-expect-error + var invalidCommentedPlain: number = 'nope'; + + // @ts-expect-error + ~~~~~~~~~~~~~~~~~~~ +!!! error TS2578: Unused '@ts-expect-error' directive. + var validCommentedPlain: string = 'nope'; + + var invalidPlain: number = 'nope'; + ~~~~~~~~~~~~ +!!! error TS2322: Type '"nope"' is not assignable to type 'number'. + + var validPlain: string = 'nope'; + \ No newline at end of file diff --git a/tests/baselines/reference/ts-expect-error.js b/tests/baselines/reference/ts-expect-error.js new file mode 100644 index 0000000000000..f37316d92b73c --- /dev/null +++ b/tests/baselines/reference/ts-expect-error.js @@ -0,0 +1,29 @@ +//// [ts-expect-error.ts] +// @ts-expect-error additional commenting +var invalidCommentedFancy: number = 'nope'; + +// @ts-expect-error additional commenting +var validCommentedFancy: string = 'nope'; + +// @ts-expect-error +var invalidCommentedPlain: number = 'nope'; + +// @ts-expect-error +var validCommentedPlain: string = 'nope'; + +var invalidPlain: number = 'nope'; + +var validPlain: string = 'nope'; + + +//// [ts-expect-error.js] +// @ts-expect-error additional commenting +var invalidCommentedFancy = 'nope'; +// @ts-expect-error additional commenting +var validCommentedFancy = 'nope'; +// @ts-expect-error +var invalidCommentedPlain = 'nope'; +// @ts-expect-error +var validCommentedPlain = 'nope'; +var invalidPlain = 'nope'; +var validPlain = 'nope'; diff --git a/tests/baselines/reference/ts-expect-error.symbols b/tests/baselines/reference/ts-expect-error.symbols new file mode 100644 index 0000000000000..fec43e1eb2e01 --- /dev/null +++ b/tests/baselines/reference/ts-expect-error.symbols @@ -0,0 +1,23 @@ +=== tests/cases/conformance/directives/ts-expect-error.ts === +// @ts-expect-error additional commenting +var invalidCommentedFancy: number = 'nope'; +>invalidCommentedFancy : Symbol(invalidCommentedFancy, Decl(ts-expect-error.ts, 1, 3)) + +// @ts-expect-error additional commenting +var validCommentedFancy: string = 'nope'; +>validCommentedFancy : Symbol(validCommentedFancy, Decl(ts-expect-error.ts, 4, 3)) + +// @ts-expect-error +var invalidCommentedPlain: number = 'nope'; +>invalidCommentedPlain : Symbol(invalidCommentedPlain, Decl(ts-expect-error.ts, 7, 3)) + +// @ts-expect-error +var validCommentedPlain: string = 'nope'; +>validCommentedPlain : Symbol(validCommentedPlain, Decl(ts-expect-error.ts, 10, 3)) + +var invalidPlain: number = 'nope'; +>invalidPlain : Symbol(invalidPlain, Decl(ts-expect-error.ts, 12, 3)) + +var validPlain: string = 'nope'; +>validPlain : Symbol(validPlain, Decl(ts-expect-error.ts, 14, 3)) + diff --git a/tests/baselines/reference/ts-expect-error.types b/tests/baselines/reference/ts-expect-error.types new file mode 100644 index 0000000000000..e338b276b7c5c --- /dev/null +++ b/tests/baselines/reference/ts-expect-error.types @@ -0,0 +1,29 @@ +=== tests/cases/conformance/directives/ts-expect-error.ts === +// @ts-expect-error additional commenting +var invalidCommentedFancy: number = 'nope'; +>invalidCommentedFancy : number +>'nope' : "nope" + +// @ts-expect-error additional commenting +var validCommentedFancy: string = 'nope'; +>validCommentedFancy : string +>'nope' : "nope" + +// @ts-expect-error +var invalidCommentedPlain: number = 'nope'; +>invalidCommentedPlain : number +>'nope' : "nope" + +// @ts-expect-error +var validCommentedPlain: string = 'nope'; +>validCommentedPlain : string +>'nope' : "nope" + +var invalidPlain: number = 'nope'; +>invalidPlain : number +>'nope' : "nope" + +var validPlain: string = 'nope'; +>validPlain : string +>'nope' : "nope" + diff --git a/tests/baselines/reference/ts-ignore.errors.txt b/tests/baselines/reference/ts-ignore.errors.txt new file mode 100644 index 0000000000000..d2e7aea2253ea --- /dev/null +++ b/tests/baselines/reference/ts-ignore.errors.txt @@ -0,0 +1,22 @@ +tests/cases/conformance/directives/ts-ignore.ts(13,5): error TS2322: Type '"nope"' is not assignable to type 'number'. + + +==== tests/cases/conformance/directives/ts-ignore.ts (1 errors) ==== + // @ts-ignore with additional commenting + var invalidCommentedFancy: number = 'nope'; + + // @ts-ignore with additional commenting + var validCommentedFancy: string = 'nope'; + + // @ts-ignore + var invalidCommentedPlain: number = 'nope'; + + // @ts-ignore + var validCommentedPlain: string = 'nope'; + + var invalidPlain: number = 'nope'; + ~~~~~~~~~~~~ +!!! error TS2322: Type '"nope"' is not assignable to type 'number'. + + var validPlain: string = 'nope'; + \ No newline at end of file diff --git a/tests/baselines/reference/ts-ignore.js b/tests/baselines/reference/ts-ignore.js new file mode 100644 index 0000000000000..5786f42851d61 --- /dev/null +++ b/tests/baselines/reference/ts-ignore.js @@ -0,0 +1,29 @@ +//// [ts-ignore.ts] +// @ts-ignore with additional commenting +var invalidCommentedFancy: number = 'nope'; + +// @ts-ignore with additional commenting +var validCommentedFancy: string = 'nope'; + +// @ts-ignore +var invalidCommentedPlain: number = 'nope'; + +// @ts-ignore +var validCommentedPlain: string = 'nope'; + +var invalidPlain: number = 'nope'; + +var validPlain: string = 'nope'; + + +//// [ts-ignore.js] +// @ts-ignore with additional commenting +var invalidCommentedFancy = 'nope'; +// @ts-ignore with additional commenting +var validCommentedFancy = 'nope'; +// @ts-ignore +var invalidCommentedPlain = 'nope'; +// @ts-ignore +var validCommentedPlain = 'nope'; +var invalidPlain = 'nope'; +var validPlain = 'nope'; diff --git a/tests/baselines/reference/ts-ignore.symbols b/tests/baselines/reference/ts-ignore.symbols new file mode 100644 index 0000000000000..70623b0fc8c5c --- /dev/null +++ b/tests/baselines/reference/ts-ignore.symbols @@ -0,0 +1,23 @@ +=== tests/cases/conformance/directives/ts-ignore.ts === +// @ts-ignore with additional commenting +var invalidCommentedFancy: number = 'nope'; +>invalidCommentedFancy : Symbol(invalidCommentedFancy, Decl(ts-ignore.ts, 1, 3)) + +// @ts-ignore with additional commenting +var validCommentedFancy: string = 'nope'; +>validCommentedFancy : Symbol(validCommentedFancy, Decl(ts-ignore.ts, 4, 3)) + +// @ts-ignore +var invalidCommentedPlain: number = 'nope'; +>invalidCommentedPlain : Symbol(invalidCommentedPlain, Decl(ts-ignore.ts, 7, 3)) + +// @ts-ignore +var validCommentedPlain: string = 'nope'; +>validCommentedPlain : Symbol(validCommentedPlain, Decl(ts-ignore.ts, 10, 3)) + +var invalidPlain: number = 'nope'; +>invalidPlain : Symbol(invalidPlain, Decl(ts-ignore.ts, 12, 3)) + +var validPlain: string = 'nope'; +>validPlain : Symbol(validPlain, Decl(ts-ignore.ts, 14, 3)) + diff --git a/tests/baselines/reference/ts-ignore.types b/tests/baselines/reference/ts-ignore.types new file mode 100644 index 0000000000000..96b6db555d938 --- /dev/null +++ b/tests/baselines/reference/ts-ignore.types @@ -0,0 +1,29 @@ +=== tests/cases/conformance/directives/ts-ignore.ts === +// @ts-ignore with additional commenting +var invalidCommentedFancy: number = 'nope'; +>invalidCommentedFancy : number +>'nope' : "nope" + +// @ts-ignore with additional commenting +var validCommentedFancy: string = 'nope'; +>validCommentedFancy : string +>'nope' : "nope" + +// @ts-ignore +var invalidCommentedPlain: number = 'nope'; +>invalidCommentedPlain : number +>'nope' : "nope" + +// @ts-ignore +var validCommentedPlain: string = 'nope'; +>validCommentedPlain : string +>'nope' : "nope" + +var invalidPlain: number = 'nope'; +>invalidPlain : number +>'nope' : "nope" + +var validPlain: string = 'nope'; +>validPlain : string +>'nope' : "nope" + diff --git a/tests/cases/conformance/directives/ts-expect-error.ts b/tests/cases/conformance/directives/ts-expect-error.ts new file mode 100644 index 0000000000000..5baea77dc51e4 --- /dev/null +++ b/tests/cases/conformance/directives/ts-expect-error.ts @@ -0,0 +1,15 @@ +// @ts-expect-error additional commenting +var invalidCommentedFancy: number = 'nope'; + +// @ts-expect-error additional commenting +var validCommentedFancy: string = 'nope'; + +// @ts-expect-error +var invalidCommentedPlain: number = 'nope'; + +// @ts-expect-error +var validCommentedPlain: string = 'nope'; + +var invalidPlain: number = 'nope'; + +var validPlain: string = 'nope'; diff --git a/tests/cases/conformance/directives/ts-ignore.ts b/tests/cases/conformance/directives/ts-ignore.ts new file mode 100644 index 0000000000000..0b058f9ea3b53 --- /dev/null +++ b/tests/cases/conformance/directives/ts-ignore.ts @@ -0,0 +1,15 @@ +// @ts-ignore with additional commenting +var invalidCommentedFancy: number = 'nope'; + +// @ts-ignore with additional commenting +var validCommentedFancy: string = 'nope'; + +// @ts-ignore +var invalidCommentedPlain: number = 'nope'; + +// @ts-ignore +var validCommentedPlain: string = 'nope'; + +var invalidPlain: number = 'nope'; + +var validPlain: string = 'nope'; From 629021226e3dc8b5c69d88b03263fbec669f2b1c Mon Sep 17 00:00:00 2001 From: Josh Goldberg Date: Thu, 5 Mar 2020 10:06:24 -0500 Subject: [PATCH 2/3] Renamed to getDiagnosticsWithPrecedingDirectives per suggestion --- src/compiler/program.ts | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/compiler/program.ts b/src/compiler/program.ts index bc00fdc29f4c8..0555bbbcaa13d 100644 --- a/src/compiler/program.ts +++ b/src/compiler/program.ts @@ -1668,7 +1668,7 @@ namespace ts { return flatDiagnostics; } - return getDiagnosticsPastDirectives(sourceFile, sourceFile.commentDirectives, flatDiagnostics).diagnostics; + return getDiagnosticsWithPrecedingDirectives(sourceFile, sourceFile.commentDirectives, flatDiagnostics).diagnostics; } function getDeclarationDiagnostics(sourceFile?: SourceFile, cancellationToken?: CancellationToken): readonly DiagnosticWithLocation[] { @@ -1756,7 +1756,7 @@ namespace ts { return flatDiagnostics; } - const { diagnostics, directives } = getDiagnosticsPastDirectives(sourceFile, sourceFile.commentDirectives, flatDiagnostics); + const { diagnostics, directives } = getDiagnosticsWithPrecedingDirectives(sourceFile, sourceFile.commentDirectives, flatDiagnostics); for (const errorExpectation of directives.getUnusedExpectations()) { diagnostics.push(createDiagnosticForRange(sourceFile, errorExpectation.range, Diagnostics.Unused_ts_expect_error_directive)); @@ -1765,7 +1765,7 @@ namespace ts { return diagnostics; } - function getDiagnosticsPastDirectives(sourceFile: SourceFile, commentDirectives: CommentDirective[], flatDiagnostics: Diagnostic[]) { + function getDiagnosticsWithPrecedingDirectives(sourceFile: SourceFile, commentDirectives: CommentDirective[], flatDiagnostics: Diagnostic[]) { // Diagnostics are only reported if there is no comment directive preceding them // This will modify the directives map by marking "used" ones with a corresponding diagnostic const directives = createCommentDirectivesMap(sourceFile, commentDirectives); From 88b0f8937522465f0a69b750824b8aa290d66f4f Mon Sep 17 00:00:00 2001 From: Josh Goldberg Date: Thu, 5 Mar 2020 10:08:37 -0500 Subject: [PATCH 3/3] Added JSDoc comment I thought I did already --- src/compiler/program.ts | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/src/compiler/program.ts b/src/compiler/program.ts index 0555bbbcaa13d..d876626119a33 100644 --- a/src/compiler/program.ts +++ b/src/compiler/program.ts @@ -1765,6 +1765,10 @@ namespace ts { return diagnostics; } + /** + * Creates a map of comment directives along with the diagnostics immediately preceded by one of them. + * Comments that match to any of those diagnostics are marked as used. + */ function getDiagnosticsWithPrecedingDirectives(sourceFile: SourceFile, commentDirectives: CommentDirective[], flatDiagnostics: Diagnostic[]) { // Diagnostics are only reported if there is no comment directive preceding them // This will modify the directives map by marking "used" ones with a corresponding diagnostic