[0.76] Introducing --list option to init-windows (#13991)

* Introducing `--list` option to `init-windows` (#13986) * Added --list option to init-windows * Change files * Remove unnecessary indentation * Indicate the default template * Change files --------- Co-authored-by: Tatiana Kapos <[email protected]>
microsoft · Oct 18, 2024 · c147dcb · c147dcb
1 parent 8bf9607
commit c147dcb
Show file tree

Hide file tree

Showing 4 changed files with 33 additions and 0 deletions.
diff --git a/change/@react-native-windows-cli-c88dbeae-73cb-4394-b26a-9eed7864646c.json b/change/@react-native-windows-cli-c88dbeae-73cb-4394-b26a-9eed7864646c.json
@@ -0,0 +1,7 @@
+{
+  "type": "prerelease",
+  "comment": "Introducing `--list` option to `init-windows` (#13986)",
+  "packageName": "@react-native-windows/cli",
+  "email": "[email protected]",
+  "dependentChangeType": "patch"
+}
diff --git a/packages/@react-native-windows/cli/src/commands/initWindows/initWindows.ts b/packages/@react-native-windows/cli/src/commands/initWindows/initWindows.ts
@@ -125,11 +125,29 @@ export class InitWindows {
     return name;
   }
 
+  protected printTemplateList() {
+    if (this.templates.size === 0) {
+      console.log('\nNo templates found.\n');
+      return;
+    }
+
+    for (const [key, value] of this.templates.entries()) {
+      const defaultLabel = value.isDefault ? chalk.yellow('[Default] ') : '';
+      console.log(`\n${key} - ${value.name}\n    ${defaultLabel}${value.description}`);      
+    }
+    console.log(`\n`)
+  }
+
   public async run(spinner: Ora) {
     await this.loadTemplates();
 
     spinner.info();
 
+    if (this.options.list) {
+      this.printTemplateList();
+      return;
+    }
+
     this.options.template ??= this.getDefaultTemplateName();
 
     spinner.info(`Using template '${this.options.template}'...`);
@@ -259,6 +277,7 @@ function optionSanitizer(key: keyof InitOptions, value: any): any {
     case 'template':
     case 'overwrite':
     case 'telemetry':
+    case 'list':
       return value === undefined ? false : value; // Return value
   }
 }

diff --git a/packages/@react-native-windows/cli/src/commands/initWindows/initWindowsOptions.ts b/packages/@react-native-windows/cli/src/commands/initWindows/initWindowsOptions.ts
@@ -13,6 +13,7 @@ export interface InitOptions {
   namespace?: string;
   overwrite?: boolean;
   telemetry?: boolean;
+  list?: boolean;
 }
 
 export const initOptions: CommandOption[] = [
@@ -46,4 +47,9 @@ export const initOptions: CommandOption[] = [
     description:
       'Disables sending telemetry that allows analysis of usage and failures of the react-native-windows CLI',
   },
+  {
+    name: '--list',
+    description:
+      'Shows a list with all available templates with their descriptions.',
+  },
 ];
diff --git a/packages/@react-native-windows/cli/src/e2etest/initWindows.test.ts b/packages/@react-native-windows/cli/src/e2etest/initWindows.test.ts
@@ -25,6 +25,7 @@ function validateOptionName(
     case 'namespace':
     case 'overwrite':
     case 'telemetry':
+    case 'list':
       return true;
   }
   throw new Error(