Merge pull request #852 from scottmo/t/experience-sites-runtime/w-21313610/updateparam

@W-21313610 feat: match template param to existing tool

Author: iowillhoit

README.md

@@ -313,7 +313,7 @@ Generate an Experience Cloud site.
 
 ```
 USAGE
-  $ sf template generate digital-experience site -n <value> -t BuildYourOwnLWR [--json] [--flags-dir <value>] [-o <value>] [-p <value>] [-e
+  $ sf template generate digital-experience site -n <value> -t "Build Your Own (LWR)" [--json] [--flags-dir <value>] [-o <value>] [-p <value>] [-e
     <value>] [-d <value>]
 
 FLAGS
@@ -323,8 +323,8 @@ FLAGS
   -n, --name=<value>             (required) Name of the Experience Cloud site to generate.
   -o, --target-org=<value>       Username or alias of the target org.
   -p, --url-path-prefix=<value>  URL path prefix for the site; must contain only alphanumeric characters.
-  -t, --template=<option>        (required) Template to use when generating the site.
-                                 <options: BuildYourOwnLWR>
+  -t, --template-name=<option>   (required) Template to use when generating the site.
+                                 <options: Build Your Own (LWR)>
 
 GLOBAL FLAGS
   --flags-dir=<value>  Import flag values from a directory.
@@ -337,14 +337,14 @@ DESCRIPTION
   necessary metadata files, including DigitalExperienceConfig, DigitalExperienceBundle, Network, and CustomSite.
 
 EXAMPLES
-  Generate an Experience Cloud site using the BuildYourOwnLWR template. The site is called "mysite" and has the URL
-  path prefix "mysite":
+  Generate an Experience Cloud site using the Build Your Own (LWR) template. The site is called "mysite" and has the
+  URL path prefix "mysite":
 
-    $ sf template generate digital-experience site --template BuildYourOwnLWR --name mysite --url-path-prefix mysite
+    $ sf template generate digital-experience site --template-name "Build Your Own (LWR)" --name mysite --url-path-prefix mysite
 
   Generate an Experience Cloud site like the last example, but generate the files into the specified output directory:
 
-    $ sf template generate digital-experience site --template BuildYourOwnLWR --name mysite --url-path-prefix mysite \
+    $ sf template generate digital-experience site --template-name "Build Your Own (LWR)" --name mysite --url-path-prefix mysite \
       --output-dir force-app/main/default
 
 FLAG DESCRIPTIONS

command-snapshot.json

@@ -28,7 +28,16 @@
     "command": "template:generate:digital-experience:site",
     "flagAliases": [],
     "flagChars": ["d", "e", "n", "o", "p", "t"],
-    "flags": ["admin-email", "flags-dir", "json", "name", "output-dir", "target-org", "template", "url-path-prefix"],
+    "flags": [
+      "admin-email",
+      "flags-dir",
+      "json",
+      "name",
+      "output-dir",
+      "target-org",
+      "template-name",
+      "url-path-prefix"
+    ],
     "plugin": "@salesforce/plugin-templates"
   },
   {

messages/digitalExperienceSite.md

@@ -4,31 +4,32 @@ Generate an Experience Cloud site.
 
 # description
 
-Creates an Experience Cloud site with the specified template, name, and URL path prefix. The site includes all necessary metadata files, including DigitalExperienceConfig, DigitalExperienceBundle, Network, and CustomSite.
+Creates the metadata of an Experience Cloud site with the specified template, name, and URL path prefix. The output includes all the necessary metadata files, including DigitalExperienceConfig, DigitalExperienceBundle, Network, and CustomSite.
+Unlike `sf community create`, which builds the site directly in the org, this command generates only the local metadata.
 
 # examples
 
-- Generate an Experience Cloud site using the BuildYourOwnLWR template. The site is called "mysite" and has the URL path prefix "mysite":
+- Generate an Experience Cloud site using the Build Your Own (LWR) template. The site is called "mysite" and has the URL path prefix "mysite":
 
-  <%= config.bin %> <%= command.id %> --template BuildYourOwnLWR --name mysite --url-path-prefix mysite
+  <%= config.bin %> <%= command.id %> --template-name "Build Your Own (LWR)" --name mysite --url-path-prefix mysite
 
 - Generate an Experience Cloud site like the last example, but generate the files into the specified output directory:
 
-  <%= config.bin %> <%= command.id %> --template BuildYourOwnLWR --name mysite --url-path-prefix mysite --output-dir force-app/main/default
+  <%= config.bin %> <%= command.id %> --template-name "Build Your Own (LWR)" --name mysite --url-path-prefix mysite --output-dir force-app/main/default
 
 # flags.name.summary
 
 Name of the Experience Cloud site to generate.
 
-# flags.template.summary
+# flags.template-name.summary
 
 Template to use when generating the site.
 
-# flags.template.description
+# flags.template-name.description
 
 Supported templates:
 
-- BuildYourOwnLWR - Creates blazing-fast digital experiences, such as websites, microsites, and portals, using the Lightning Web Components programming model. Powered by Lightning Web Runtime (LWR), this customizable template delivers unparalleled site performance. For additional details, see this Salesforce Help topic: https://help.salesforce.com/s/articleView?id=experience.rss_build_your_own_lwr.htm.
+- Build Your Own (LWR) - Creates blazing-fast digital experiences, such as websites, microsites, and portals, using the Lightning Web Components programming model. Powered by Lightning Web Runtime (LWR), this customizable template delivers unparalleled site performance. For additional details, see this Salesforce Help topic: https://help.salesforce.com/s/articleView?id=experience.rss_build_your_own_lwr.htm.
 
 # flags.url-path-prefix.summary
 

src/commands/template/generate/digital-experience/site.ts

@@ -14,6 +14,14 @@ import { getCustomTemplates, runGenerator } from '../../../../utils/templateComm
 Messages.importMessagesDirectoryFromMetaUrl(import.meta.url);
 const messages = Messages.loadMessages('@salesforce/plugin-templates', 'digitalExperienceSite');
 
+/**
+ * Strips spaces and non-alphanumeric characters so display names map to template directories
+ * (e.g. "Build Your Own (LWR)" → "BuildYourOwnLWR").
+ */
+function normalizeTemplateName(name: string): string {
+  return name.replace(/[^a-zA-Z0-9]/g, '');
+}
+
 export default class GenerateSite extends SfCommand<CreateOutput> {
   public static readonly state = 'preview';
   public static readonly summary = messages.getMessage('summary');
@@ -26,10 +34,10 @@ export default class GenerateSite extends SfCommand<CreateOutput> {
       summary: messages.getMessage('flags.name.summary'),
       required: true,
     }),
-    template: Flags.string({
+    'template-name': Flags.string({
       char: 't',
-      summary: messages.getMessage('flags.template.summary'),
-      options: ['BuildYourOwnLWR'] as const,
+      summary: messages.getMessage('flags.template-name.summary'),
+      options: ['Build Your Own (LWR)'] as const,
       required: true,
     }),
     'url-path-prefix': Flags.string({
@@ -82,7 +90,7 @@ export default class GenerateSite extends SfCommand<CreateOutput> {
       sitename: flags.name,
       urlpathprefix: flags['url-path-prefix'],
       adminemail: adminEmail,
-      template: flags.template,
+      template: normalizeTemplateName(flags['template-name']),
       outputdir: outputDir,
     };
 

test/commands/template/generate/digital-experience/site.nut.ts

@@ -24,11 +24,11 @@ describe(COMMAND, () => {
     await session?.clean();
   });
 
-  describe('--template BuildYourOwnLWR', () => {
+  describe('--template-name "Build Your Own (LWR)"', () => {
     it('should create with all required files', () => {
       const outputDir = path.join(session.project.dir, 'force-app', 'main', 'default');
       execCmd(
-        `${COMMAND} --template BuildYourOwnLWR --name "123 @ Test Site" --url-path-prefix 123testsite --output-dir "${outputDir}"`,
+        `${COMMAND} --template-name "Build Your Own (LWR)" --name "123 @ Test Site" --url-path-prefix 123testsite --output-dir "${outputDir}"`,
         {
           ensureExitCode: 0,
         }
@@ -111,20 +111,24 @@ describe(COMMAND, () => {
 
   describe('parameter validation', () => {
     it('should throw error if missing site name', () => {
-      const stderr = execCmd(`${COMMAND} --template BuildYourOwnLWR --url-path-prefix test`).shellOutput.stderr;
+      const stderr = execCmd(`${COMMAND} --template-name "Build Your Own (LWR)" --url-path-prefix test`).shellOutput
+        .stderr;
       expect(stderr).to.contain('Missing required flag');
     });
 
-    it('should throw error if missing template', () => {
+    it('should throw error if missing template-name', () => {
       const stderr = execCmd(`${COMMAND} --name test --url-path-prefix test`).shellOutput.stderr;
       expect(stderr).to.contain('Missing required flag');
     });
 
     it('should default to empty string if url-path-prefix is not provided', () => {
       const outputDir = path.join(session.project.dir, 'force-app', 'main', 'default');
-      execCmd(`${COMMAND} --template BuildYourOwnLWR --name "DefaultPrefixSite" --output-dir "${outputDir}"`, {
-        ensureExitCode: 0,
-      });
+      execCmd(
+        `${COMMAND} --template-name "Build Your Own (LWR)" --name "DefaultPrefixSite" --output-dir "${outputDir}"`,
+        {
+          ensureExitCode: 0,
+        }
+      );
 
       const networkPath = path.join(outputDir, 'networks', 'DefaultPrefixSite.network-meta.xml');
       const networkContent = fs.readFileSync(networkPath, 'utf8');
@@ -140,9 +144,12 @@ describe(COMMAND, () => {
     });
 
     it('should default to force/main/default if output-dir is not provided', () => {
-      execCmd(`${COMMAND} --template BuildYourOwnLWR --name "DefaultDirSite" --url-path-prefix defaultdir`, {
-        ensureExitCode: 0,
-      });
+      execCmd(
+        `${COMMAND} --template-name "Build Your Own (LWR)" --name "DefaultDirSite" --url-path-prefix defaultdir`,
+        {
+          ensureExitCode: 0,
+        }
+      );
       const defaultOutputDir = path.join(session.project.dir, 'force-app', 'main', 'default');
       assert.file(path.join(defaultOutputDir, 'networks', 'DefaultDirSite.network-meta.xml'));
       assert.file(path.join(defaultOutputDir, 'sites', 'DefaultDirSite.site-meta.xml'));