Merge pull request #3473 from D4N14L/user/danade/FileError

[node-core-library] Add `FileError` class for errors found in target files

Author: iclanton

apps/heft/src/pluginFramework/logging/FileError.ts

@@ -3,8 +3,12 @@
 
 import { IHeftPlugin } from '../IHeftPlugin';
 import { ScopedLogger } from './ScopedLogger';
-import { ITerminalProvider } from '@rushstack/node-core-library';
-import { FileErrorFormat, FileError } from './FileError';
+import {
+  FileError,
+  FileLocationStyle,
+  ITerminalProvider,
+  IFileErrorFormattingOptions
+} from '@rushstack/node-core-library';
 
 export interface ILoggingManagerOptions {
   terminalProvider: ITerminalProvider;
@@ -48,38 +52,41 @@ export class LoggingManager {
     }
   }
 
-  public getErrorStrings(fileErrorFormat?: FileErrorFormat): string[] {
+  public getErrorStrings(fileLocationStyle?: FileLocationStyle): string[] {
     const result: string[] = [];
 
     for (const scopedLogger of this._scopedLoggers.values()) {
       result.push(
         ...scopedLogger.errors.map(
-          (error) => `[${scopedLogger.loggerName}] ${LoggingManager.getErrorMessage(error, fileErrorFormat)}`
+          (error) =>
+            `[${scopedLogger.loggerName}] ` +
+            LoggingManager.getErrorMessage(error, { format: fileLocationStyle })
         )
       );
     }
 
     return result;
   }
 
-  public getWarningStrings(fileErrorFormat?: FileErrorFormat): string[] {
+  public getWarningStrings(fileErrorFormat?: FileLocationStyle): string[] {
     const result: string[] = [];
 
     for (const scopedLogger of this._scopedLoggers.values()) {
       result.push(
         ...scopedLogger.warnings.map(
           (warning) =>
-            `[${scopedLogger.loggerName}] ${LoggingManager.getErrorMessage(warning, fileErrorFormat)}`
+            `[${scopedLogger.loggerName}] ` +
+            LoggingManager.getErrorMessage(warning, { format: fileErrorFormat })
         )
       );
     }
 
     return result;
   }
 
-  public static getErrorMessage(error: Error, fileErrorFormat?: FileErrorFormat): string {
+  public static getErrorMessage(error: Error, options?: IFileErrorFormattingOptions): string {
     if (error instanceof FileError) {
-      return error.toString(fileErrorFormat);
+      return error.getFormattedErrorMessage(options);
     } else {
       return error.message;
     }

apps/heft/src/pluginFramework/logging/LoggingManager.ts

@@ -5,10 +5,10 @@ import * as path from 'path';
 import * as crypto from 'crypto';
 import * as semver from 'semver';
 import * as TEslint from 'eslint';
+import { FileError } from '@rushstack/node-core-library';
 
 import { LinterBase, ILinterBaseOptions, ITiming } from './LinterBase';
 import { IExtendedProgram, IExtendedSourceFile } from './internalTypings/TypeScriptInternals';
-import { FileError } from '../../pluginFramework/logging/FileError';
 
 interface IEslintOptions extends ILinterBaseOptions {
   eslintPackagePath: string;
@@ -68,22 +68,18 @@ export class Eslint extends LinterBase<TEslint.ESLint.LintResult> {
     const warnings: Error[] = [];
 
     for (const eslintFileResult of this._lintResult) {
-      const buildFolderRelativeFilePath: string = path.relative(
-        this._buildFolderPath,
-        eslintFileResult.filePath
-      );
       for (const message of eslintFileResult.messages) {
         eslintFailureCount++;
         // https://eslint.org/docs/developer-guide/nodejs-api#◆-lintmessage-type
         const formattedMessage: string = message.ruleId
           ? `(${message.ruleId}) ${message.message}`
           : message.message;
-        const errorObject: FileError = new FileError(
-          formattedMessage,
-          buildFolderRelativeFilePath,
-          message.line,
-          message.column
-        );
+        const errorObject: FileError = new FileError(formattedMessage, {
+          absolutePath: eslintFileResult.filePath,
+          projectFolder: this._buildFolderPath,
+          line: message.line,
+          column: message.column
+        });
         switch (message.severity) {
           case EslintMessageSeverity.error: {
             errors.push(errorObject);

apps/heft/src/pluginFramework/logging/test/FileError.test.ts

@@ -4,12 +4,11 @@
 import * as path from 'path';
 import type * as TTslint from 'tslint';
 import * as crypto from 'crypto';
-import { Import, ITerminal, JsonFile } from '@rushstack/node-core-library';
+import { Import, ITerminal, JsonFile, FileError } from '@rushstack/node-core-library';
 
 import { LinterBase, ILinterBaseOptions } from './LinterBase';
 import { IExtendedSourceFile, IExtendedProgram } from './internalTypings/TypeScriptInternals';
 import { IExtendedLinter } from './internalTypings/TslintInternals';
-import { FileError } from '../../pluginFramework/logging/FileError';
 import { TypeScriptCachedFileSystem } from '../../utilities/fileSystem/TypeScriptCachedFileSystem';
 
 interface ITslintOptions extends ILinterBaseOptions {
@@ -101,18 +100,14 @@ export class Tslint extends LinterBase<TTslint.RuleFailure> {
       );
 
       for (const tslintFailure of this._lintResult.failures) {
-        const buildFolderRelativeFilename: string = path.relative(
-          this._buildFolderPath,
-          tslintFailure.getFileName()
-        );
         const { line, character } = tslintFailure.getStartPosition().getLineAndCharacter();
         const formattedFailure: string = `(${tslintFailure.getRuleName()}) ${tslintFailure.getFailure()}`;
-        const errorObject: FileError = new FileError(
-          formattedFailure,
-          buildFolderRelativeFilename,
-          line + 1,
-          character + 1
-        );
+        const errorObject: FileError = new FileError(formattedFailure, {
+          absolutePath: tslintFailure.getFileName(),
+          projectFolder: this._buildFolderPath,
+          line: line + 1,
+          column: character + 1
+        });
         switch (tslintFailure.getRuleSeverity()) {
           case 'error': {
             this._scopedLogger.emitError(errorObject);

apps/heft/src/plugins/TypeScriptPlugin/Eslint.ts

@@ -12,7 +12,8 @@ import {
   ITerminalProvider,
   FileSystem,
   Path,
-  Async
+  Async,
+  FileError
 } from '@rushstack/node-core-library';
 import type * as TTypescript from 'typescript';
 import {
@@ -29,7 +30,6 @@ import { PerformanceMeasurer, PerformanceMeasurerAsync } from '../../utilities/P
 import { Tslint } from './Tslint';
 import { Eslint } from './Eslint';
 import { IScopedLogger } from '../../pluginFramework/logging/ScopedLogger';
-import { FileError } from '../../pluginFramework/logging/FileError';
 
 import { EmitFilesPatch, ICachedEmitModuleKind } from './EmitFilesPatch';
 import { HeftSession } from '../../pluginFramework/HeftSession';
@@ -736,12 +736,13 @@ export class TypeScriptBuilder extends SubprocessRunnerBase<ITypeScriptBuilderCo
     if (diagnostic.file) {
       const { line, character } = diagnostic.file.getLineAndCharacterOfPosition(diagnostic.start!);
       const message: string = ts.flattenDiagnosticMessageText(diagnostic.messageText, '\n');
-      const buildFolderRelativeFilename: string = path.relative(
-        this._configuration.buildFolder,
-        diagnostic.file.fileName
-      );
       const formattedMessage: string = `(TS${diagnostic.code}) ${message}`;
-      errorObject = new FileError(formattedMessage, buildFolderRelativeFilename, line + 1, character + 1);
+      errorObject = new FileError(formattedMessage, {
+        absolutePath: diagnostic.file.fileName,
+        projectFolder: this._configuration.buildFolder,
+        line: line + 1,
+        column: character + 1
+      });
       diagnosticMessage = errorObject.toString();
     } else {
       diagnosticMessage = ts.flattenDiagnosticMessageText(diagnostic.messageText, '\n');

apps/heft/src/plugins/TypeScriptPlugin/Tslint.ts

@@ -15,7 +15,8 @@ export interface ISerializedErrorValue {
 }
 
 export interface ISerializedFileErrorValue extends ISerializedErrorValue {
-  filePath: string;
+  absolutePath: string;
+  projectFolder: string;
   line: number | undefined;
   column: number | undefined;
 }

apps/heft/src/plugins/TypeScriptPlugin/TypeScriptBuilder.ts

@@ -3,7 +3,7 @@
 
 import * as childProcess from 'child_process';
 import * as path from 'path';
-import { ITerminalProvider, ITerminal, Terminal } from '@rushstack/node-core-library';
+import { ITerminalProvider, ITerminal, Terminal, FileError } from '@rushstack/node-core-library';
 
 import {
   ISubprocessMessageBase,
@@ -21,7 +21,6 @@ import {
 } from './SubprocessCommunicationManagerBase';
 import { IScopedLogger } from '../../pluginFramework/logging/ScopedLogger';
 import { SubprocessLoggerManager } from './SubprocessLoggerManager';
-import { FileError } from '../../pluginFramework/logging/FileError';
 import { SubprocessTerminator } from './SubprocessTerminator';
 
 export interface ISubprocessInnerConfiguration {
@@ -344,7 +343,8 @@ export abstract class SubprocessRunnerBase<
             value: {
               errorMessage: arg.message,
               errorStack: arg.stack,
-              filePath: arg.filePath,
+              absolutePath: arg.absolutePath,
+              projectFolder: arg.projectFolder,
               line: arg.line,
               column: arg.column
             }
@@ -402,12 +402,12 @@ export abstract class SubprocessRunnerBase<
       case SupportedSerializableArgType.FileError: {
         const typedArg: ISubprocessApiCallArgWithValue<ISerializedFileErrorValue> =
           arg as ISubprocessApiCallArgWithValue<ISerializedFileErrorValue>;
-        const result: FileError = new FileError(
-          typedArg.value.errorMessage,
-          typedArg.value.filePath,
-          typedArg.value.line,
-          typedArg.value.column
-        );
+        const result: FileError = new FileError(typedArg.value.errorMessage, {
+          absolutePath: typedArg.value.absolutePath,
+          projectFolder: typedArg.value.projectFolder,
+          line: typedArg.value.line,
+          column: typedArg.value.column
+        });
         result.stack = typedArg.value.errorStack;
         return result;
       }