chore: support user to define the location of assets folder when init a new subspace beside the default rush-init/assets folder

Author: Adrian Zhang

common/changes/@microsoft/rush/chore-support-users-to-provide-their-own-assets-file-for-init-subspace_2025-02-25-07-23.json

@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@microsoft/rush",
+      "comment": "suport users to provide their own assets when init a new subspace instead of always using the default one",
+      "type": "none"
+    }
+  ],
+  "packageName": "@microsoft/rush"
+}

libraries/rush-lib/assets/rush-init/common/config/rush/subspaces.json

@@ -11,6 +11,11 @@
    */
   "subspacesEnabled": false,
 
+  /**
+   * the starting assets folder you want to use when init a subspace
+   */
+  // "subspaceInitAssetsFolder": "",
+
   /**
    * (DEPRECATED) This is a temporary workaround for migrating from an earlier prototype
    * of this feature: https://github.com/microsoft/rushstack/pull/3481

libraries/rush-lib/src/api/SubspacesConfiguration.ts

@@ -25,6 +25,7 @@ export interface ISubspacesConfigurationJson {
   splitWorkspaceCompatibility?: boolean;
   preventSelectingAllSubspaces?: boolean;
   subspaceNames: string[];
+  subspaceInitAssetsFolder?: string;
 }
 
 /**
@@ -60,11 +61,17 @@ export class SubspacesConfiguration {
    */
   public readonly subspaceNames: ReadonlySet<string>;
 
+  /**
+   * rush-init Subspace assets location used during `rush init-subspace`
+   */
+  public readonly subspaceInitAssetsFolder?: string;
+
   private constructor(configuration: Readonly<ISubspacesConfigurationJson>, subspaceJsonFilePath: string) {
     this.subspaceJsonFilePath = subspaceJsonFilePath;
     this.subspacesEnabled = configuration.subspacesEnabled;
     this.splitWorkspaceCompatibility = !!configuration.splitWorkspaceCompatibility;
     this.preventSelectingAllSubspaces = !!configuration.preventSelectingAllSubspaces;
+    this.subspaceInitAssetsFolder = configuration.subspaceInitAssetsFolder;
     const subspaceNames: Set<string> = new Set();
     for (const subspaceName of configuration.subspaceNames) {
       SubspacesConfiguration.requireValidSubspaceName(subspaceName, this.splitWorkspaceCompatibility);

libraries/rush-lib/src/cli/actions/InitSubspaceAction.ts

@@ -9,6 +9,7 @@ import { type ISubspacesConfigurationJson, SubspacesConfiguration } from '../../
 import { Async, FileSystem, JsonFile } from '@rushstack/node-core-library';
 import { ConsoleTerminalProvider, Terminal } from '@rushstack/terminal';
 import { copyTemplateFileAsync } from '../../utilities/templateUtilities';
+import * as path from 'path';
 
 export class InitSubspaceAction extends BaseRushAction {
   private readonly _subspaceNameParameter: IRequiredCommandLineStringParameter;
@@ -58,7 +59,10 @@ export class InitSubspaceAction extends BaseRushAction {
     }
 
     const subspaceConfigPath: string = `${this.rushConfiguration.commonFolder}/config/subspaces/${newSubspaceName}`;
-    const assetsSubfolder: string = `${assetsFolderPath}/rush-init`;
+    const defaultAssetsSubfolder: string = `${assetsFolderPath}/rush-init`;
+    const userDefinedAssetsFolder: string | undefined = subspacesConfiguration.subspaceInitAssetsFolder
+      ? path.join(this.rushConfiguration.rushJsonFolder, subspacesConfiguration.subspaceInitAssetsFolder)
+      : undefined;
     const templateFilePaths: string[] = [
       '[dot]npmrc',
       '.pnpmfile.cjs',
@@ -70,9 +74,14 @@ export class InitSubspaceAction extends BaseRushAction {
     await Async.forEachAsync(
       templateFilePaths,
       async (templateFilePath) => {
-        const sourcePath: string = `${assetsSubfolder}/common/config/rush/${templateFilePath}`;
+        const defaultAssetSourcePath: string = `${defaultAssetsSubfolder}/common/config/rush/${templateFilePath}`;
         const destinationPath: string = `${subspaceConfigPath}/${templateFilePath.replace('[dot]', '.')}`;
-        await copyTemplateFileAsync(sourcePath, destinationPath, true);
+        await copyTemplateFileAsync(defaultAssetSourcePath, destinationPath, true);
+        if (userDefinedAssetsFolder) {
+          // if user provided their own assets file for subspace initiation
+          // we just copy and overwrite the default files
+          await copyTemplateFileAsync(userDefinedAssetsFolder, destinationPath, true);
+        }
       },
       { concurrency: 10 }
     );

libraries/rush-lib/src/schemas/subspaces.schema.json

@@ -27,6 +27,10 @@
       "items": {
         "type": "string"
       }
+    },
+    "subspaceInitAssetsFolder": {
+      "description": "Where assets located for init a new subspace",
+      "type": "string"
     }
   }
 }