feat!: Restructure theme commands to match new design guidelines (#1270)

HubSpot · Nov 26, 2024 · 83feeab · 83feeab
1 parent d8bd3d6
commit 83feeab
Show file tree

Hide file tree

Showing 4 changed files with 20 additions and 20 deletions.
diff --git a/commands/theme.ts b/commands/theme.ts
@@ -8,7 +8,7 @@ const { i18n } = require('../lib/lang');
 
 const i18nKey = 'commands.theme';
 
-exports.command = 'theme';
+exports.command = ['theme', 'themes'];
 exports.describe = i18n(`${i18nKey}.describe`);
 
 exports.builder = yargs => {

diff --git a/commands/theme/generate-selectors.ts b/commands/theme/generate-selectors.ts
@@ -25,20 +25,20 @@ const THEME_PATH_REGEX = new RegExp(/=\s*.*(theme\.(\w|\.)*)/, 'i');
 
 const i18nKey = 'commands.theme.subcommands.generateSelectors';
 
-exports.command = 'generate-selectors <themePath>';
+exports.command = 'generate-selectors <path>';
 exports.describe = i18n(`${i18nKey}.describe`);
 
 exports.handler = options => {
-  const { themePath } = options;
+  const { path } = options;
 
-  const fieldsJsonPath = findFieldsJsonPath(themePath);
+  const fieldsJsonPath = findFieldsJsonPath(path);
   if (!fieldsJsonPath) {
     logger.error(i18n(`${i18nKey}.errors.fieldsNotFound`));
     process.exit(EXIT_CODES.ERROR);
   }
 
   let fieldsJson = JSON.parse(fs.readFileSync(fieldsJsonPath));
-  let cssString = combineThemeCss(themePath);
+  let cssString = combineThemeCss(path);
 
   /**
    * Creates map of HubL variable names to theme field paths
@@ -190,7 +190,7 @@ exports.handler = options => {
   }
 
   const selectorsMap = generateSelectorsMap(fieldsJson);
-  const selectorsPath = `${themePath}/editor-preview.json`;
+  const selectorsPath = `${path}/editor-preview.json`;
 
   fs.writeFileSync(
     selectorsPath,
@@ -199,15 +199,15 @@ exports.handler = options => {
 
   logger.success(
     i18n(`${i18nKey}.success`, {
-      themePath,
+      themePath: path,
       selectorsPath,
     })
   );
 };
 
 exports.builder = yargs => {
-  yargs.positional('themePath', {
-    describe: i18n(`${i18nKey}.positionals.themePath.describe`),
+  yargs.positional('path', {
+    describe: i18n(`${i18nKey}.positionals.path.describe`),
     type: 'string',
   });
 

diff --git a/commands/theme/marketplace-validate.ts b/commands/theme/marketplace-validate.ts
@@ -18,11 +18,11 @@ const { i18n } = require('../../lib/lang');
 
 const i18nKey = 'commands.theme.subcommands.marketplaceValidate';
 
-exports.command = 'marketplace-validate <src>';
+exports.command = 'marketplace-validate <path>';
 exports.describe = i18n(`${i18nKey}.describe`);
 
 exports.handler = async options => {
-  const { src, derivedAccountId } = options;
+  const { path, derivedAccountId } = options;
 
   await loadAndValidateOptions(options);
 
@@ -32,15 +32,15 @@ exports.handler = async options => {
 
   SpinniesManager.add('marketplaceValidation', {
     text: i18n(`${i18nKey}.logs.validatingTheme`, {
-      path: src,
+      path,
     }),
   });
 
   const assetType = 'THEME';
   const validationId = await kickOffValidation(
     derivedAccountId,
     assetType,
-    src
+    path
   );
   await pollForValidationFinish(derivedAccountId, validationId);
 
@@ -61,8 +61,8 @@ exports.builder = yargs => {
   addAccountOptions(yargs);
   addUseEnvironmentOptions(yargs);
 
-  yargs.positional('src', {
-    describe: i18n(`${i18nKey}.positionals.src.describe`),
+  yargs.positional('path', {
+    describe: i18n(`${i18nKey}.positionals.path.describe`),
     type: 'string',
   });
   return yargs;

diff --git a/lang/en.lyaml b/lang/en.lyaml
@@ -856,7 +856,7 @@ en:
             update: "The secret \"{{ secretName }}\" was updated in the HubSpot account: {{ accountIdentifier }}"
             updateExplanation: "Existing serverless functions will start using this new value within 10 seconds."
     theme:
-      describe: "Commands for working with themes, including marketplace validation with the marketplace-validate subcommand."
+      describe: "Commands for managing themes."
       subcommands:
         generateSelectors:
           describe: "Automatically generates an editor-preview.json file for the given theme. The selectors this command generates are not perfect, so please edit editor-preview.json after running."
@@ -866,10 +866,10 @@ en:
             noSelectorsFound: "No selectors found."
           success: "Selectors generated for {{ themePath }}, please double check the selectors generated at {{ selectorsPath }} before uploading the theme."
           positionals:
-            themePath:
+            path:
               describe: "The path of the theme you'd like to generate an editor-preview.json for."
         marketplaceValidate:
-          describe: "Validate a theme for the marketplace"
+          describe: "Validate a theme for the marketplace."
           errors:
             invalidPath: "The path \"{{ path }}\" is not a path to a folder in the Design Manager"
           logs:
@@ -882,10 +882,10 @@ en:
               lineNumber: "Line number: {{ line }}"
             noErrors: "No errors"
           positionals:
-            src:
+            path:
               describe: "Path to the theme within the Design Manager."
         preview:
-          describe: "Upload and watch a theme directory on your computer for changes and start a local development server to preview theme changes on a site"
+          describe: "Upload and watch a theme directory on your computer for changes and start a local development server to preview theme changes on a site."
           errors:
             invalidPath: "The path \"{{ path }}\" is not a path to a directory"
             noThemeComponents: "Your project has no theme components available to preview."