chore: Provide the filename of the package.json file where the error …

…occurred
microsoft · May 3, 2024 · 4c8d063 · 4c8d063
1 parent 0c41a82
commit 4c8d063
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 0 deletions.
diff --git a/common/changes/@microsoft/rush/chore-error-packageJSON-filename_2024-05-03-12-11.json b/common/changes/@microsoft/rush/chore-error-packageJSON-filename_2024-05-03-12-11.json
@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@microsoft/rush",
+      "comment": "Provide the filename of the error package.json file",
+      "type": "none"
+    }
+  ],
+  "packageName": "@microsoft/rush"
+}
diff --git a/libraries/rush-lib/src/api/RushConfigurationProject.ts b/libraries/rush-lib/src/api/RushConfigurationProject.ts
@@ -245,6 +245,11 @@ export class RushConfigurationProject {
       if (FileSystem.isNotExistError(error as Error)) {
         throw new Error(`Could not find package.json for ${packageName} at ${packageJsonFilename}`);
       }
+
+      // Encountered an error while loading the package.json file. Please append the error message with the corresponding file location.
+      if ((error as Error).name === 'SyntaxError') {
+        error.message = `${error.message}\nFilename: ${packageJsonFilename}`;
+      }
       throw error;
     }