Catalyst 1744 refactor configuration variables

core/.gitignore

@@ -54,3 +54,5 @@ build-config.json
 # OpenNext
 .open-next
 .wrangler
+
+.bigcommerce

packages/catalyst/src/cli/commands/build.ts

@@ -21,14 +21,13 @@ export const build = new Command('build')
   .addOption(
     new Option(
       '--project-uuid <uuid>',
-      'Project UUID to be included in the deployment configuration.',
-    ).env('BIGCOMMERCE_PROJECT_UUID'),
+      'Project UUID to be included in the deployment configuration. Can also be set via the CATALYST_PROJECT_UUID environment variable.',
+    ).env('CATALYST_PROJECT_UUID'),
   )
   .addOption(
-    new Option('--framework <framework>', 'The framework to use for the build.').choices([
-      'nextjs',
-      'catalyst',
-    ]),
+    new Option('--framework <framework>', 'The framework to use for the build.')
+      .env('CATALYST_FRAMEWORK')
+      .choices(['nextjs', 'catalyst']),
   )
   .action(async (nextBuildOptions, options) => {
     const coreDir = process.cwd();
@@ -60,7 +59,7 @@ export const build = new Command('build')
 
         if (!projectUuid) {
           throw new Error(
-            'Project UUID is required. Please run `catalyst project create` or `catalyst project link` or this command again with --project-uuid <uuid>.',
+            'Project UUID is required. This can be set via the --project-uuid flag, the CATALYST_PROJECT_UUID environment variable, or the projectUuid property in the .bigcommerce/project.json file.',
           );
         }
 

packages/catalyst/src/cli/commands/deploy.spec.ts

@@ -306,19 +306,19 @@ test('--dry-run skips upload and deployment', async () => {
 
 test('reads from env options', () => {
   const envVariables = parseEnvironmentVariables([
-    'BIGCOMMERCE_STORE_HASH=123',
-    'BIGCOMMERCE_STOREFRONT_TOKEN=456',
+    'CATALYST_STORE_HASH=123',
+    'CATALYST_ACCESS_TOKEN=456',
   ]);
 
   expect(envVariables).toEqual([
     {
       type: 'secret',
-      key: 'BIGCOMMERCE_STORE_HASH',
+      key: 'CATALYST_STORE_HASH',
       value: '123',
     },
     {
       type: 'secret',
-      key: 'BIGCOMMERCE_STOREFRONT_TOKEN',
+      key: 'CATALYST_ACCESS_TOKEN',
       value: '456',
     },
   ]);

packages/catalyst/src/cli/commands/deploy.ts

@@ -282,18 +282,14 @@ export const deploy = new Command('deploy')
   .addOption(
     new Option(
       '--store-hash <hash>',
-      'BigCommerce store hash. Can be found in the URL of your store Control Panel.',
-    )
-      .env('BIGCOMMERCE_STORE_HASH')
-      .makeOptionMandatory(),
+      'BigCommerce store hash. Can be found in the URL of your store Control Panel. Can also be set via the CATALYST_STORE_HASH environment variable or the storeHash property in the .bigcommerce/project.json file.',
+    ).env('CATALYST_STORE_HASH'),
   )
   .addOption(
     new Option(
       '--access-token <token>',
-      'BigCommerce access token. Can be found after creating a store-level API account.',
-    )
-      .env('BIGCOMMERCE_ACCESS_TOKEN')
-      .makeOptionMandatory(),
+      'BigCommerce access token. Can be found after creating a store-level API account. Can also be set via the CATALYST_ACCESS_TOKEN environment variable or the accessToken property in the .bigcommerce/project.json file.',
+    ).env('CATALYST_ACCESS_TOKEN'),
   )
   .addOption(
     new Option('--api-host <host>', 'BigCommerce API host. The default is api.bigcommerce.com.')
@@ -303,8 +299,8 @@ export const deploy = new Command('deploy')
   .addOption(
     new Option(
       '--project-uuid <uuid>',
-      'BigCommerce intrastructure project UUID. Can be found via the BigCommerce API (GET /v3/infrastructure/projects).',
-    ).env('BIGCOMMERCE_PROJECT_UUID'),
+      'BigCommerce infrastructure project UUID. Can be found via the BigCommerce API (GET /v3/infrastructure/projects). Can also be set via the CATALYST_PROJECT_UUID environment variable or the projectUuid property in the .bigcommerce/project.json file.',
+    ).env('CATALYST_PROJECT_UUID'),
   )
   .addOption(
     new Option(
@@ -318,16 +314,24 @@ export const deploy = new Command('deploy')
     try {
       const config = getProjectConfig();
 
-      await telemetry.identify(options.storeHash);
-
+      const storeHash = options.storeHash ?? config.get('storeHash');
+      const accessToken = options.accessToken ?? config.get('accessToken');
       const projectUuid = options.projectUuid ?? config.get('projectUuid');
 
+      if (!storeHash || !accessToken) {
+        throw new Error(
+          'Store hash and access token are required. Can be set via the --store-hash and --access-token flags, the CATALYST_STORE_HASH and CATALYST_ACCESS_TOKEN environment variables, or the storeHash and accessToken properties in the .bigcommerce/project.json file.',
+        );
+      }
+
       if (!projectUuid) {
         throw new Error(
-          'Project UUID is required. Please run either `catalyst project link` or `catalyst project create` or this command again with --project-uuid <uuid>.',
+          'Project UUID is required. This can be set via the --project-uuid flag, the CATALYST_PROJECT_UUID environment variable, or the projectUuid property in the .bigcommerce/project.json file.',
         );
       }
 
+      await telemetry.identify(storeHash);
+
       await generateBundleZip();
 
       if (options.dryRun) {
@@ -341,8 +345,8 @@ export const deploy = new Command('deploy')
       }
 
       const uploadSignature = await generateUploadSignature(
-        options.storeHash,
-        options.accessToken,
+        storeHash,
+        accessToken,
         options.apiHost,
       );
 
@@ -353,18 +357,13 @@ export const deploy = new Command('deploy')
       const { deployment_uuid: deploymentUuid } = await createDeployment(
         projectUuid,
         uploadSignature.upload_uuid,
-        options.storeHash,
-        options.accessToken,
+        storeHash,
+        accessToken,
         options.apiHost,
         environmentVariables,
       );
 
-      await getDeploymentStatus(
-        deploymentUuid,
-        options.storeHash,
-        options.accessToken,
-        options.apiHost,
-      );
+      await getDeploymentStatus(deploymentUuid, storeHash, accessToken, options.apiHost);
     } catch (error) {
       consola.error(error);
       process.exit(1);