fix: line mandatory (defaults to 1), column optional in FileError.getFormattedErrorMessage

Co-authored-by: dmichon-msft <26827560+dmichon-msft@users.noreply.github.com>
Agent-Logs-Url: https://github.com/microsoft/rushstack/sessions/e0b803db-46de-4bf5-a531-31105741fbf8

Author: Copilot

libraries/node-core-library/src/FileError.ts

@@ -50,7 +50,7 @@ const uuidFileError: string = '37a4c772-2dc8-4c66-89ae-262f8cc1f0c1';
 const baseFolderEnvVar: string = 'RUSHSTACK_FILE_ERROR_BASE_FOLDER';
 
 const unixProblemMatcherPattern: IProblemPattern = {
-  regexp: '^\\[[^\\]]+\\]\\s+(Error|Warning):\\s+([^:]+):(\\d+):(\\d+)\\s+-\\s+(?:\\(([^)]+)\\)\\s+)?(.*)$',
+  regexp: '^\\[[^\\]]+\\]\\s+(Error|Warning):\\s+([^:]+):(\\d+)(?::(\\d+))?\\s+-\\s+(?:\\(([^)]+)\\)\\s+)?(.*)$',
   severity: 1,
   file: 2,
   line: 3,
@@ -61,7 +61,7 @@ const unixProblemMatcherPattern: IProblemPattern = {
 
 const vsProblemMatcherPattern: IProblemPattern = {
   regexp:
-    '^\\[[^\\]]+\\]\\s+(Error|Warning):\\s+([^\\(]+)\\((\\d+),(\\d+)\\)\\s+-\\s+(?:\\(([^)]+)\\)\\s+)?(.*)$',
+    '^\\[[^\\]]+\\]\\s+(Error|Warning):\\s+([^\\(]+)\\((\\d+)(?:,(\\d+))?\\)\\s+-\\s+(?:\\(([^)]+)\\)\\s+)?(.*)$',
   severity: 1,
   file: 2,
   line: 3,
@@ -146,7 +146,7 @@ export class FileError extends Error {
       pathToFormat: this.absolutePath,
       message: this.message,
       line: this.line ?? 1,
-      column: this.column ?? 1
+      column: this.column
     });
   }
 

libraries/node-core-library/src/test/FileError.test.ts

@@ -29,7 +29,7 @@ describe(FileError.name, () => {
       absolutePath: `/path/to/project/path/to/file`,
       projectFolder: '/path/to/project'
     });
-    expect(error1.toString()).toMatchInlineSnapshot(`"path/to/file:1:1 - message"`);
+    expect(error1.toString()).toMatchInlineSnapshot(`"path/to/file:1 - message"`);
   });
 
   it('correctly performs Unix-style relative file path formatting', () => {
@@ -49,7 +49,7 @@ describe(FileError.name, () => {
       line: 5
     });
     expect(error2.getFormattedErrorMessage({ format: 'Unix' })).toMatchInlineSnapshot(
-      `"path/to/file:5:1 - message"`
+      `"path/to/file:5 - message"`
     );
 
     const error3: FileError = new FileError('message', {
@@ -59,15 +59,15 @@ describe(FileError.name, () => {
       column: 12
     });
     expect(error3.getFormattedErrorMessage({ format: 'Unix' })).toMatchInlineSnapshot(
-      `"path/to/file:1:1 - message"`
+      `"path/to/file:1:12 - message"`
     );
 
     const error4: FileError = new FileError('message', {
       absolutePath: '/path/to/project/path/to/file',
       projectFolder: '/path/to/project'
     });
     expect(error4.getFormattedErrorMessage({ format: 'Unix' })).toMatchInlineSnapshot(
-      `"path/to/file:1:1 - message"`
+      `"path/to/file:1 - message"`
     );
   });
 
@@ -93,8 +93,8 @@ describe(FileError.name, () => {
     // Because the file path is resolved on disk, the output will vary based on platform.
     // Only check that it ends as expected and is an absolute path.
     const error2Message: string = error2.getFormattedErrorMessage({ format: 'Unix' });
-    expect(error2Message).toMatch(/.+:5:1 - message$/);
-    const error2Path: string = error2Message.slice(0, error2Message.length - ':5:1 - message'.length);
+    expect(error2Message).toMatch(/.+:5 - message$/);
+    const error2Path: string = error2Message.slice(0, error2Message.length - ':5 - message'.length);
     expect(path.isAbsolute(error2Path)).toEqual(true);
 
     const error3: FileError = new FileError('message', {
@@ -106,8 +106,8 @@ describe(FileError.name, () => {
     // Because the file path is resolved on disk, the output will vary based on platform.
     // Only check that it ends as expected and is an absolute path.
     const error3Message: string = error3.getFormattedErrorMessage({ format: 'Unix' });
-    expect(error3Message).toMatch(/.+:1:1 - message$/);
-    const error3Path: string = error3Message.slice(0, error3Message.length - ':1:1 - message'.length);
+    expect(error3Message).toMatch(/.+:1:12 - message$/);
+    const error3Path: string = error3Message.slice(0, error3Message.length - ':1:12 - message'.length);
     expect(path.isAbsolute(error3Path)).toEqual(true);
 
     const error4: FileError = new FileError('message', {
@@ -117,8 +117,8 @@ describe(FileError.name, () => {
     // Because the file path is resolved on disk, the output will vary based on platform.
     // Only check that it ends as expected and is an absolute path.
     const error4Message: string = error4.getFormattedErrorMessage({ format: 'Unix' });
-    expect(error4Message).toMatch(/.+:1:1 - message$/);
-    const error4Path: string = error4Message.slice(0, error4Message.length - ':1:1 - message'.length);
+    expect(error4Message).toMatch(/.+:1 - message$/);
+    const error4Path: string = error4Message.slice(0, error4Message.length - ':1 - message'.length);
     expect(path.isAbsolute(error4Path)).toEqual(true);
   });
 
@@ -139,7 +139,7 @@ describe(FileError.name, () => {
       line: 5
     });
     expect(error2.getFormattedErrorMessage({ format: 'VisualStudio' })).toMatchInlineSnapshot(
-      `"path/to/file(5,1) - message"`
+      `"path/to/file(5) - message"`
     );
 
     const error3: FileError = new FileError('message', {
@@ -149,15 +149,15 @@ describe(FileError.name, () => {
       column: 12
     });
     expect(error3.getFormattedErrorMessage({ format: 'VisualStudio' })).toMatchInlineSnapshot(
-      `"path/to/file(1,1) - message"`
+      `"path/to/file(1,12) - message"`
     );
 
     const error4: FileError = new FileError('message', {
       absolutePath: '/path/to/project/path/to/file',
       projectFolder: '/path/to/project'
     });
     expect(error4.getFormattedErrorMessage({ format: 'VisualStudio' })).toMatchInlineSnapshot(
-      `"path/to/file(1,1) - message"`
+      `"path/to/file(1) - message"`
     );
   });
 
@@ -183,8 +183,8 @@ describe(FileError.name, () => {
     // Because the file path is resolved on disk, the output will vary based on platform.
     // Only check that it ends as expected and is an absolute path.
     const error2Message: string = error2.getFormattedErrorMessage({ format: 'VisualStudio' });
-    expect(error2Message).toMatch(/.+\(5,1\) - message$/);
-    const error2Path: string = error2Message.slice(0, error2Message.length - '(5,1) - message'.length);
+    expect(error2Message).toMatch(/.+\(5\) - message$/);
+    const error2Path: string = error2Message.slice(0, error2Message.length - '(5) - message'.length);
     expect(path.isAbsolute(error2Path)).toEqual(true);
 
     const error3: FileError = new FileError('message', {
@@ -196,8 +196,8 @@ describe(FileError.name, () => {
     // Because the file path is resolved on disk, the output will vary based on platform.
     // Only check that it ends as expected and is an absolute path.
     const error3Message: string = error3.getFormattedErrorMessage({ format: 'VisualStudio' });
-    expect(error3Message).toMatch(/.+\(1,1\) - message$/);
-    const error3Path: string = error3Message.slice(0, error3Message.length - '(1,1) - message'.length);
+    expect(error3Message).toMatch(/.+\(1,12\) - message$/);
+    const error3Path: string = error3Message.slice(0, error3Message.length - '(1,12) - message'.length);
     expect(path.isAbsolute(error3Path)).toEqual(true);
 
     const error4: FileError = new FileError('message', {
@@ -207,8 +207,8 @@ describe(FileError.name, () => {
     // Because the file path is resolved on disk, the output will vary based on platform.
     // Only check that it ends as expected and is an absolute path.
     const error4Message: string = error4.getFormattedErrorMessage({ format: 'VisualStudio' });
-    expect(error4Message).toMatch(/.+\(1,1\) - message$/);
-    const error4Path: string = error4Message.slice(0, error4Message.length - '(1,1) - message'.length);
+    expect(error4Message).toMatch(/.+\(1\) - message$/);
+    const error4Path: string = error4Message.slice(0, error4Message.length - '(1) - message'.length);
     expect(path.isAbsolute(error4Path)).toEqual(true);
   });
 });