From 973678fd8cda95f932dc04c7abc075486c86f769 Mon Sep 17 00:00:00 2001
From: Colton Padden <colton.padden@fastmail.com>
Date: Tue, 5 Oct 2021 11:20:35 -0400
Subject: [PATCH] use --path option instead of [path] argument in create-app

Signed-off-by: Colton Padden <colton.padden@fastmail.com>
---
 packages/create-app/src/createApp.ts | 11 +++++------
 packages/create-app/src/index.ts     |  7 +++++--
 2 files changed, 10 insertions(+), 8 deletions(-)

diff --git a/packages/create-app/src/createApp.ts b/packages/create-app/src/createApp.ts
index 0c1cd09d5b..4f0c141d86 100644
--- a/packages/create-app/src/createApp.ts
+++ b/packages/create-app/src/createApp.ts
@@ -120,12 +120,11 @@ export default async (cmd: Command): Promise<void> => {
   const templateDir = paths.resolveOwn('templates/default-app');
   const tempDir = resolvePath(os.tmpdir(), answers.name);
 
-  // Use `[path]` argument as applicaiton directory when specified, otherwise
+  // Use `--path` argument as applicaiton directory when specified, otherwise
   // create a directory using `answers.name`
-  const appDir =
-    cmd.args.length > 0
-      ? resolvePath(cmd.args[0])
-      : resolvePath(paths.targetDir, answers.name);
+  const appDir = cmd.path
+    ? resolvePath(cmd.path)
+    : resolvePath(paths.targetDir, answers.name);
 
   Task.log();
   Task.log('Creating the app...');
@@ -133,7 +132,7 @@ export default async (cmd: Command): Promise<void> => {
   try {
     // Directory must not already exist when using consructed path from
     // `answers.name`
-    if (cmd.args.length === 0) {
+    if (!cmd.path) {
       Task.section('Checking if the directory is available');
       await checkExists(paths.targetDir, answers.name);
     }
diff --git a/packages/create-app/src/index.ts b/packages/create-app/src/index.ts
index c603592207..1f37be56d2 100644
--- a/packages/create-app/src/index.ts
+++ b/packages/create-app/src/index.ts
@@ -29,8 +29,11 @@ const main = (argv: string[]) => {
   program
     .name('backstage-create-app')
     .version(version)
-    .description('Creates a new app in a new directory or specified [path]')
-    .usage('[path] [options]')
+    .description('Creates a new app in a new directory or specified path')
+    .option(
+      '--path [directory]',
+      'Location to store the app defaulting to a new folder with the app name',
+    )
     .option(
       '--skip-install',
       'Skip the install and builds steps after creating the app',