rename sandbox format to config-format

aws-amplify · Nov 14, 2023 · ece9635 · ece9635
1 parent 4d691a4
commit ece9635
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 5 deletions.
diff --git a/.changeset/serious-apricots-love.md b/.changeset/serious-apricots-love.md
@@ -0,0 +1,5 @@
+---
+'@aws-amplify/backend-cli': patch
+---
+
+Rename sandbox format to config-format
diff --git a/packages/cli/src/commands/sandbox/sandbox_command.test.ts b/packages/cli/src/commands/sandbox/sandbox_command.test.ts
@@ -104,7 +104,7 @@ 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, /--config-format/);
     assert.match(output, /--config-out-dir/);
     assert.equal(mockHandleProfile.mock.callCount(), 0);
   });

diff --git a/packages/cli/src/commands/sandbox/sandbox_command.ts b/packages/cli/src/commands/sandbox/sandbox_command.ts
@@ -19,7 +19,7 @@ type SandboxCommandOptionsCamelCase = {
   dirToWatch: string | undefined;
   exclude: string[] | undefined;
   name: string | undefined;
-  format: ClientConfigFormat | undefined;
+  configFormat: ClientConfigFormat | undefined;
   configOutDir: string | undefined;
   profile: string | undefined;
 };
@@ -83,7 +83,7 @@ export class SandboxCommand
     const clientConfigLifecycleHandler = new ClientConfigLifecycleHandler(
       this.clientConfigGeneratorAdapter,
       args['config-out-dir'],
-      args.format
+      args['config-format']
     );
     const eventHandlers = this.sandboxEventHandlerCreator?.({
       sandboxName: this.sandboxName,
@@ -97,7 +97,7 @@ export class SandboxCommand
     const watchExclusions = args.exclude ?? [];
     const clientConfigWritePath = await getClientConfigPath(
       args['config-out-dir'],
-      args.format
+      args['config-format']
     );
     watchExclusions.push(clientConfigWritePath);
     await sandbox.start({
@@ -138,7 +138,7 @@ export class SandboxCommand
           array: false,
           global: false,
         })
-        .option('format', {
+        .option('config-format', {
           describe: 'Client config output format',
           type: 'string',
           array: false,