Improve error report summaries (#45713)

microsoft · orta · Dec 7, 2021 · Sep 5, 2021 · Sep 13, 2021 · Sep 14, 2021
commit 0638417eb17d464f41c2c3f4d560262ad31fea70
diff --git a/src/compiler/diagnosticMessages.json b/src/compiler/diagnosticMessages.json
@@ -4834,6 +4834,18 @@
         "category": "Message",
         "code": 6257
     },
+    "Found 1 error in {1}": {
+        "category": "Message",
+        "code": 6258
+    },
+    "Found {0} errors in 1 file.": {
+        "category": "Message",
+        "code": 6259
+    },
+    "Found {0} errors in {1} files.": {
+        "category": "Message",
+        "code": 6260
+    },
 
     "Enable project compilation": {
         "category": "Message",

diff --git a/src/compiler/tsbuildPublic.ts b/src/compiler/tsbuildPublic.ts
@@ -76,7 +76,7 @@ namespace ts {
         return fileExtensionIs(fileName, Extension.Dts);
     }
 
-    export type ReportEmitErrorSummary = (errorCount: number) => void;
+    export type ReportEmitErrorSummary = (errorCount: number, filesInError: (string | undefined)[]) => void;
 
     export interface SolutionBuilderHostBase<T extends BuilderProgram> extends ProgramHost<T> {
         createDirectory?(path: string): void;
@@ -2002,10 +2002,12 @@ namespace ts {
         const canReportSummary = state.watch || !!state.host.reportErrorSummary;
         const { diagnostics } = state;
         let totalErrors = 0;
+        let filesInError: (string | undefined)[] = [];
         if (isCircularBuildOrder(buildOrder)) {
             reportBuildQueue(state, buildOrder.buildOrder);
             reportErrors(state, buildOrder.circularDiagnostics);
             if (canReportSummary) totalErrors += getErrorCountForSummary(buildOrder.circularDiagnostics);
+            if (canReportSummary) filesInError = [...filesInError, ...getFilesInErrorForSummary(buildOrder.circularDiagnostics)];
         }
         else {
             // Report errors from the other projects
@@ -2016,13 +2018,14 @@ namespace ts {
                 }
             });
             if (canReportSummary) diagnostics.forEach(singleProjectErrors => totalErrors += getErrorCountForSummary(singleProjectErrors));
+            if (canReportSummary) diagnostics.forEach(singleProjectErrors => [...filesInError, ...getFilesInErrorForSummary(singleProjectErrors)]);
         }
 
         if (state.watch) {
             reportWatchStatus(state, getWatchErrorSummaryDiagnosticMessage(totalErrors), totalErrors);
         }
         else if (state.host.reportErrorSummary) {
-            state.host.reportErrorSummary(totalErrors);
+            state.host.reportErrorSummary(totalErrors, filesInError);
         }
     }
 

diff --git a/src/compiler/watch.ts b/src/compiler/watch.ts
@@ -7,7 +7,7 @@ namespace ts {
     } : undefined;
 
     /**
-     * Create a function that reports error by writing to the system and handles the formating of the diagnostic
+     * Create a function that reports error by writing to the system and handles the formatting of the diagnostic
      */
     export function createDiagnosticReporter(system: System, pretty?: boolean): DiagnosticReporter {
         const host: FormatDiagnosticsHost = system === sys && sysFormatDiagnosticsHost ? sysFormatDiagnosticsHost : {
@@ -101,15 +101,51 @@ namespace ts {
         return countWhere(diagnostics, diagnostic => diagnostic.category === DiagnosticCategory.Error);
     }
 
+    export function getFilesInErrorForSummary(diagnostics: readonly Diagnostic[]) {
+        return filter(diagnostics, diagnostic => diagnostic.category === DiagnosticCategory.Error)
+            .map(
+                errorDiagnostic => {
+                    if(errorDiagnostic.file === undefined) return;
+                    return `${errorDiagnostic.file.fileName}`;
+            })
+            .filter((value, index, self) => self !== undefined && self.indexOf(value) === index)
+            .map((fileName: string) => {
+                const diagnosticForFileName = find(diagnostics, diagnostic =>
+                    diagnostic.file !== undefined && diagnostic.file.fileName === fileName
+                );
+
+                if(diagnosticForFileName !== undefined) {
+                    const { line } = getLineAndCharacterOfPosition(diagnosticForFileName.file!, diagnosticForFileName.start!);
+                    return `${fileName}:${line + 1}`;
+                }
+            });
+    }
+
     export function getWatchErrorSummaryDiagnosticMessage(errorCount: number) {
         return errorCount === 1 ?
             Diagnostics.Found_1_error_Watching_for_file_changes :
             Diagnostics.Found_0_errors_Watching_for_file_changes;
     }
 
-    export function getErrorSummaryText(errorCount: number, newLine: string) {
+    export function getErrorSummaryText(
+        errorCount: number,
+        filesInError: readonly (string | undefined)[],
+        newLine: string
+    ) {
         if (errorCount === 0) return "";
-        const d = createCompilerDiagnostic(errorCount === 1 ? Diagnostics.Found_1_error : Diagnostics.Found_0_errors, errorCount);
+        const d = errorCount === 1 ?
+            createCompilerDiagnostic(
+                filesInError[0] !== undefined ?
+                    Diagnostics.Found_1_error_in_1 :
+                    Diagnostics.Found_1_error,
+                errorCount,
+                filesInError[0]) :
+            createCompilerDiagnostic(
+                filesInError.length === 1 ?
+                    Diagnostics.Found_0_errors_in_1_file :
+                    Diagnostics.Found_0_errors_in_1_files,
+                errorCount,
+                filesInError.length);
         return `${newLine}${flattenDiagnosticMessageText(d.messageText, newLine)}${newLine}${newLine}`;
     }
 
@@ -350,7 +386,7 @@ namespace ts {
         }
 
         if (reportSummary) {
-            reportSummary(getErrorCountForSummary(diagnostics));
+            reportSummary(getErrorCountForSummary(diagnostics), getFilesInErrorForSummary(diagnostics));
         }
 
         return {
@@ -656,7 +692,7 @@ namespace ts {
             builderProgram,
             input.reportDiagnostic || createDiagnosticReporter(system),
             s => host.trace && host.trace(s),
-            input.reportErrorSummary || input.options.pretty ? errorCount => system.write(getErrorSummaryText(errorCount, system.newLine)) : undefined
+            input.reportErrorSummary || input.options.pretty ? (errorCount, filesInError) => system.write(getErrorSummaryText(errorCount, filesInError, system.newLine)) : undefined
         );
         if (input.afterProgramEmitAndDiagnostics) input.afterProgramEmitAndDiagnostics(builderProgram);
         return exitStatus;

diff --git a/src/executeCommandLine/executeCommandLine.ts b/src/executeCommandLine/executeCommandLine.ts
@@ -749,7 +749,7 @@ namespace ts {
 
     function createReportErrorSummary(sys: System, options: CompilerOptions | BuildOptions): ReportEmitErrorSummary | undefined {
         return shouldBePretty(sys, options) ?
-            errorCount => sys.write(getErrorSummaryText(errorCount, sys.newLine)) :
+            (errorCount, filesInError) => sys.write(getErrorSummaryText(errorCount, filesInError, sys.newLine)) :
             undefined;
     }
 

diff --git a/src/harness/harnessIO.ts b/src/harness/harnessIO.ts
@@ -536,7 +536,7 @@ namespace Harness {
                 outputLines += content;
             }
             if (pretty) {
-                outputLines += ts.getErrorSummaryText(ts.getErrorCountForSummary(diagnostics), IO.newLine());
+                outputLines += ts.getErrorSummaryText(ts.getErrorCountForSummary(diagnostics), ts.getFilesInErrorForSummary(diagnostics), IO.newLine());
             }
             return outputLines;
         }

diff --git a/src/testRunner/unittests/tsbuild/publicApi.ts b/src/testRunner/unittests/tsbuild/publicApi.ts
@@ -54,7 +54,7 @@ export function f22() { } // trailing`,
                     /*createProgram*/ undefined,
                 createDiagnosticReporter(sys, /*pretty*/ true),
                 createBuilderStatusReporter(sys, /*pretty*/ true),
-                errorCount => sys.write(getErrorSummaryText(errorCount, sys.newLine))
+                (errorCount, filesInError) => sys.write(getErrorSummaryText(errorCount, filesInError, sys.newLine))
             );
             buildHost.afterProgramEmitAndDiagnostics = cb;
             buildHost.afterEmitBundle = cb;

diff --git a/src/testRunner/unittests/tscWatch/helpers.ts b/src/testRunner/unittests/tscWatch/helpers.ts
@@ -204,13 +204,18 @@ namespace ts.tscWatch {
         assert.equal(host.exitCode, expectedExitCode);
     }
 
-    export function checkNormalBuildErrors(host: WatchedSystem, errors: readonly Diagnostic[] | readonly string[], reportErrorSummary?: boolean) {
+    export function checkNormalBuildErrors(
+        host: WatchedSystem,
+        errors: readonly Diagnostic[] | readonly string[],
+        files: readonly string[],
+        reportErrorSummary?: boolean
+    ) {
         checkOutputErrors(
             host,
             [
                 ...map(errors, hostOutputDiagnostic),
                 ...reportErrorSummary ?
-                    [hostOutputWatchDiagnostic(getErrorSummaryText(errors.length, host.newLine))] :
+                    [hostOutputWatchDiagnostic(getErrorSummaryText(errors.length, files, host.newLine))] :
                     emptyArray
             ]
         );

diff --git a/tests/baselines/reference/api/tsserverlibrary.d.ts b/tests/baselines/reference/api/tsserverlibrary.d.ts
@@ -5249,7 +5249,7 @@ declare namespace ts {
         traceResolution?: boolean;
         [option: string]: CompilerOptionsValue | undefined;
     }
-    type ReportEmitErrorSummary = (errorCount: number) => void;
+    type ReportEmitErrorSummary = (errorCount: number, filesInError: (string | undefined)[]) => void;
     interface SolutionBuilderHostBase<T extends BuilderProgram> extends ProgramHost<T> {
         createDirectory?(path: string): void;
         /**

diff --git a/tests/baselines/reference/api/typescript.d.ts b/tests/baselines/reference/api/typescript.d.ts
@@ -5249,7 +5249,7 @@ declare namespace ts {
         traceResolution?: boolean;
         [option: string]: CompilerOptionsValue | undefined;
     }
-    type ReportEmitErrorSummary = (errorCount: number) => void;
+    type ReportEmitErrorSummary = (errorCount: number, filesInError: (string | undefined)[]) => void;
     interface SolutionBuilderHostBase<T extends BuilderProgram> extends ProgramHost<T> {
         createDirectory?(path: string): void;
         /**

diff --git a/tests/baselines/reference/deeplyNestedAssignabilityIssue.errors.txt b/tests/baselines/reference/deeplyNestedAssignabilityIssue.errors.txt
@@ -65,5 +65,5 @@
         }
     }
 
-Found 2 errors.
+Found 2 errors in 1 file.
 
diff --git a/tests/baselines/reference/duplicateIdentifierRelatedSpans1.errors.txt b/tests/baselines/reference/duplicateIdentifierRelatedSpans1.errors.txt
@@ -92,5 +92,5 @@
 !!! error TS2451: Cannot redeclare block-scoped variable 'Bar'.
 !!! related TS6203 tests/cases/compiler/file1.ts:2:7: 'Bar' was also declared here.
 
-Found 6 errors.
+Found 6 errors in 3 files.
 
diff --git a/tests/baselines/reference/duplicateIdentifierRelatedSpans2.errors.txt b/tests/baselines/reference/duplicateIdentifierRelatedSpans2.errors.txt
@@ -45,5 +45,5 @@
     class H { }
     class I { }
 
-Found 2 errors.
+Found 2 errors in 2 files.
 
diff --git a/tests/baselines/reference/duplicateIdentifierRelatedSpans3.errors.txt b/tests/baselines/reference/duplicateIdentifierRelatedSpans3.errors.txt
@@ -85,5 +85,5 @@
 !!! related TS6203 tests/cases/compiler/file1.ts:4:5: 'duplicate3' was also declared here.
     }
 
-Found 6 errors.
+Found 6 errors in 2 files.
 
diff --git a/tests/baselines/reference/duplicateIdentifierRelatedSpans4.errors.txt b/tests/baselines/reference/duplicateIdentifierRelatedSpans4.errors.txt
@@ -47,5 +47,5 @@
         duplicate8(): number;
     }
 
-Found 2 errors.
+Found 2 errors in 2 files.
 
diff --git a/tests/baselines/reference/duplicateIdentifierRelatedSpans5.errors.txt b/tests/baselines/reference/duplicateIdentifierRelatedSpans5.errors.txt
@@ -92,5 +92,5 @@
     }
     export {}
 
-Found 6 errors.
+Found 6 errors in 2 files.
 
diff --git a/tests/baselines/reference/duplicateIdentifierRelatedSpans6.errors.txt b/tests/baselines/reference/duplicateIdentifierRelatedSpans6.errors.txt
@@ -92,5 +92,5 @@
 !!! related TS6203 tests/cases/compiler/file2.ts:7:9: 'duplicate3' was also declared here.
         }
     }
-Found 6 errors.
+Found 6 errors in 2 files.
 
diff --git a/tests/baselines/reference/duplicateIdentifierRelatedSpans7.errors.txt b/tests/baselines/reference/duplicateIdentifierRelatedSpans7.errors.txt
@@ -56,5 +56,5 @@
             duplicate9: () => string;
         }
     }
-Found 2 errors.
+Found 2 errors in 2 files.
 
diff --git a/tests/baselines/reference/esModuleInteropPrettyErrorRelatedInformation.errors.txt b/tests/baselines/reference/esModuleInteropPrettyErrorRelatedInformation.errors.txt
@@ -23,5 +23,5 @@
 !!! error TS2345:   Type '{ default: () => void; }' provides no match for the signature '(): void'.
 !!! related TS7038 tests/cases/compiler/index.ts:1:1: Type originates at this import. A namespace-style import cannot be called or constructed, and will cause a failure at runtime. Consider using a default import or import require here instead.
 
-Found 1 error.
+Found 1 error in tests/cases/compiler/index.ts:3
 
diff --git a/tests/baselines/reference/multiLineContextDiagnosticWithPretty.errors.txt b/tests/baselines/reference/multiLineContextDiagnosticWithPretty.errors.txt
@@ -21,5 +21,5 @@
 !!! error TS2322:   Object literal may only specify known properties, and 'a' does not exist in type '{ c: string; }'.
     };
 
-Found 1 error.
+Found 1 error in tests/cases/compiler/multiLineContextDiagnosticWithPretty.ts:2
 
diff --git a/tests/baselines/reference/prettyContextNotDebugAssertion.errors.txt b/tests/baselines/reference/prettyContextNotDebugAssertion.errors.txt
@@ -15,5 +15,5 @@
 
 !!! error TS1005: '}' expected.
 !!! related TS1007 tests/cases/compiler/index.ts:1:11: The parser expected to find a '}' to match the '{' token here.
-Found 1 error.
+Found 1 error in tests/cases/compiler/index.ts:2
 
diff --git a/tests/baselines/reference/prettyFileWithErrorsAndTabs.errors.txt b/tests/baselines/reference/prettyFileWithErrorsAndTabs.errors.txt
@@ -26,5 +26,5 @@
 !!! error TS2322: Type 'number' is not assignable to type 'string'.
     	}
     }
-Found 3 errors.
+Found 3 errors in 1 file.
 
diff --git a/...eference/tsbuild/configFileErrors/initial-build/when-tsconfig-extends-the-missing-file.js b/...eference/tsbuild/configFileErrors/initial-build/when-tsconfig-extends-the-missing-file.js
@@ -42,7 +42,7 @@ Output::
 [91merror[0m[90m TS18003: [0mNo inputs were found in config file '/src/tsconfig.second.json'. Specified 'include' paths were '["**/*"]' and 'exclude' paths were '[]'.
 
 
-Found 4 errors.
+Found 4 errors in 0 files.
 
 exitCode:: ExitStatus.DiagnosticsPresent_OutputsSkipped
 

diff --git a/.../in-bad-ref-branch-reports-the-error-about-files-not-in-rootDir-at-the-import-location.js b/.../in-bad-ref-branch-reports-the-error-about-files-not-in-rootDir-at-the-import-location.js
@@ -208,7 +208,7 @@ Output::
 [[90m12:00:00 AM[0m] Skipping build of project '/src/zoo/tsconfig.json' because its dependency '/src/animals' was not built
 
 
-Found 7 errors.
+Found 7 errors in 0 files.
 
 exitCode:: ExitStatus.DiagnosticsPresent_OutputsSkipped
 

diff --git a/...tial-build/when-setting-composite-false-on-command-line-but-has-tsbuild-info-in-config.js b/...tial-build/when-setting-composite-false-on-command-line-but-has-tsbuild-info-in-config.js
@@ -40,7 +40,7 @@ Output::
 [7m [0m [91m        ~~~~~~~~~~~~~~~~~[0m
 
 
-Found 1 error.
+Found 1 error in src/project/tsconfig.json:6
 
 exitCode:: ExitStatus.DiagnosticsPresent_OutputsGenerated
 

diff --git a/...tionEmit/when-pkg-references-sibling-package-through-indirect-symlink-moduleCaseChange.js b/...tionEmit/when-pkg-references-sibling-package-through-indirect-symlink-moduleCaseChange.js
@@ -78,7 +78,7 @@ pkg3/src/keys.ts
 pkg3/src/index.ts
   Matched by include pattern '**/*' in 'pkg3/tsconfig.json'
 
-Found 1 error.
+Found 1 error in /user/username/projects/myproject/pkg3/src/keys.ts:2
 
 
 

diff --git a/...rence/tsc/declarationEmit/when-pkg-references-sibling-package-through-indirect-symlink.js b/...rence/tsc/declarationEmit/when-pkg-references-sibling-package-through-indirect-symlink.js
@@ -78,7 +78,7 @@ pkg3/src/keys.ts
 pkg3/src/index.ts
   Matched by include pattern '**/*' in 'pkg3/tsconfig.json'
 
-Found 1 error.
+Found 1 error in /user/username/projects/myproject/pkg3/src/keys.ts:2
-Original file line number
+Diff line change
@@ Expand Up / @@ -65,5 +65,5 @@ @@
             }
         }
-    Found 2 errors.
+    Found 2 errors in 1 file.