fix: sandbox client config options

.changeset/dry-ladybugs-film.md

@@ -0,0 +1,5 @@
+---
+'@aws-amplify/backend-cli': patch
+---
+
+client config generation respects sandbox format option

.changeset/serious-apricots-love.md

@@ -0,0 +1,5 @@
+---
+'@aws-amplify/backend-cli': patch
+---
+
+Rename sandbox format to config-format

.changeset/strong-plums-explain.md

@@ -0,0 +1,5 @@
+---
+'@aws-amplify/backend-cli': patch
+---
+
+Change sandbox out-dir to config-out-dir and client config generation respects config-out-dir option

packages/cli/src/commands/sandbox/sandbox_command.test.ts

@@ -104,8 +104,8 @@ void describe('sandbox command', () => {
     assert.match(output, /--name/);
     assert.match(output, /--dir-to-watch/);
     assert.match(output, /--exclude/);
-    assert.match(output, /--format/);
-    assert.match(output, /--out-dir/);
+    assert.match(output, /--config-format/);
+    assert.match(output, /--config-out-dir/);
     assert.equal(mockHandleProfile.mock.callCount(), 0);
   });
 
@@ -251,4 +251,36 @@ void describe('sandbox command', () => {
       sandboxProfile
     );
   });
+
+  void it('fails if invalid config-out-dir is provided', async () => {
+    mock.method(fs, 'lstatSync', () => {
+      return {
+        isFile: () => false,
+        isDir: () => false,
+      };
+    });
+    const output = await commandRunner.runCommand(
+      'sandbox --config-out-dir nonExistentDir'
+    );
+    assert.match(output, /--config-out-dir nonExistentDir does not exist/);
+  });
+
+  void it('fails if a file is provided for config-out-dir', async (contextual) => {
+    mock.method(fs, 'lstatSync', () => {
+      return {
+        isFile: () => true,
+        isDir: () => false,
+      };
+    });
+    contextual.mock.method(fs, 'statSync', () => ({
+      isDirectory: () => false,
+    }));
+    const output = await commandRunner.runCommand(
+      'sandbox --config-out-dir existentFile'
+    );
+    assert.match(
+      output,
+      /--config-out-dir existentFile is not a valid directory/
+    );
+  });
 });

packages/cli/src/commands/sandbox/sandbox_command.ts

@@ -19,8 +19,8 @@ type SandboxCommandOptionsCamelCase = {
   dirToWatch: string | undefined;
   exclude: string[] | undefined;
   name: string | undefined;
-  format: ClientConfigFormat | undefined;
-  outDir: string | undefined;
+  configFormat: ClientConfigFormat | undefined;
+  configOutDir: string | undefined;
   profile: string | undefined;
 };
 
@@ -81,7 +81,9 @@ export class SandboxCommand
 
     // attaching event handlers
     const clientConfigLifecycleHandler = new ClientConfigLifecycleHandler(
-      this.clientConfigGeneratorAdapter
+      this.clientConfigGeneratorAdapter,
+      args['config-out-dir'],
+      args['config-format']
     );
     const eventHandlers = this.sandboxEventHandlerCreator?.({
       sandboxName: this.sandboxName,
@@ -94,8 +96,8 @@ export class SandboxCommand
     }
     const watchExclusions = args.exclude ?? [];
     const clientConfigWritePath = await getClientConfigPath(
-      args['out-dir'],
-      args.format
+      args['config-out-dir'],
+      args['config-format']
     );
     watchExclusions.push(clientConfigWritePath);
     await sandbox.start({
@@ -136,14 +138,14 @@ export class SandboxCommand
           array: false,
           global: false,
         })
-        .option('format', {
+        .option('config-format', {
           describe: 'Client config output format',
           type: 'string',
           array: false,
           choices: Object.values(ClientConfigFormat),
           global: false,
         })
-        .option('out-dir', {
+        .option('config-out-dir', {
           describe:
             'A path to directory where config is written. If not provided defaults to current process working directory.',
           type: 'string',
@@ -157,20 +159,10 @@ export class SandboxCommand
         })
         .check((argv) => {
           if (argv['dir-to-watch']) {
-            // make sure it's a real directory
-            let stats;
-            try {
-              stats = fs.statSync(argv['dir-to-watch'], {});
-            } catch (e) {
-              throw new Error(
-                `--dir-to-watch ${argv['dir-to-watch']} does not exist`
-              );
-            }
-            if (!stats.isDirectory()) {
-              throw new Error(
-                `--dir-to-watch ${argv['dir-to-watch']} is not a valid directory`
-              );
-            }
+            this.validateDirectory('dir-to-watch', argv['dir-to-watch']);
+          }
+          if (argv['config-out-dir']) {
+            this.validateDirectory('config-out-dir', argv['config-out-dir']);
           }
           if (argv.name) {
             const projectNameRegex = /^[a-zA-Z0-9-]{1,15}$/;
@@ -201,4 +193,16 @@ export class SandboxCommand
         await this.sandboxFactory.getInstance()
       ).delete({ name: this.sandboxName });
   };
+
+  validateDirectory = (option: string, dir: string) => {
+    let stats;
+    try {
+      stats = fs.statSync(dir, {});
+    } catch (e) {
+      throw new Error(`--${option} ${dir} does not exist`);
+    }
+    if (!stats.isDirectory()) {
+      throw new Error(`--${option} ${dir} is not a valid directory`);
+    }
+  };
 }