Show an error message if useWorkspaces=false when trying to use subspaces

octogonz · octogonz · commit bb953993e7d4 · 2024-05-09T20:08:01.000-07:00
diff --git a/libraries/rush-lib/assets/rush-init/rush.json b/libraries/rush-lib/assets/rush-init/rush.json
@@ -339,7 +339,7 @@
        * and "nonbrowser-approved-packages.json" files.  The value must be one of the
        * strings from the "reviewCategories" defined above.
        */
-      /*[LINE "HYPOTHETICAL"]*/ "reviewCategory": "production",
+      "reviewCategory": "production",
 
       /**
        * A list of Rush project names that are to be installed from NPM
diff --git a/libraries/rush-lib/src/api/Subspace.ts b/libraries/rush-lib/src/api/Subspace.ts
@@ -67,18 +67,23 @@ export class Subspace {
    */
   public getPnpmOptions(): PnpmOptionsConfiguration | undefined {
     if (!this._cachedPnpmOptionsInitialized) {
+      // Calculate these outside the try/catch block since their error messages shouldn't be annotated:
+      const subspaceConfigFolder: string = this.getSubspaceConfigFolder();
+      const subspaceTempFolder: string = this.getSubspaceTempFolder();
       try {
         this._cachedPnpmOptions = PnpmOptionsConfiguration.loadFromJsonFileOrThrow(
-          `${this.getSubspaceConfigFolder()}/${RushConstants.pnpmConfigFilename}`,
-          this.getSubspaceTempFolder()
+          `${subspaceConfigFolder}/${RushConstants.pnpmConfigFilename}`,
+          subspaceTempFolder
         );
         this._cachedPnpmOptionsInitialized = true;
       } catch (e) {
         if (FileSystem.isNotExistError(e as Error)) {
           this._cachedPnpmOptions = undefined;
           this._cachedPnpmOptionsInitialized = true;
         } else {
-          throw new Error(`The subspace has an invalid pnpm-config.json file: ${this.subspaceName}`);
+          throw new Error(
+            `The subspace "${this.subspaceName}" has an invalid pnpm-config.json file:\n` + e.message
+          );
         }
       }
     }
@@ -91,6 +96,12 @@ export class Subspace {
       let subspaceConfigFolder: string;
 
       if (rushConfiguration.subspacesFeatureEnabled) {
+        if (!rushConfiguration.pnpmOptions.useWorkspaces) {
+          throw new Error(
+            `The Rush subspaces feature is enabled.  You must set useWorkspaces=true in pnpm-config.json.`
+          );
+        }
+
         // If this subspace doesn't have a configuration folder, check if it is in the project folder itself
         // if the splitWorkspaceCompatibility option is enabled in the subspace configuration
 
