From 069934c62760d3bc00c1713ba183ee084c5386fc Mon Sep 17 00:00:00 2001
From: Patrik Oldsberg <poldsberg@gmail.com>
Date: Sat, 13 Nov 2021 15:02:08 +0100
Subject: [PATCH] cli: some more docs for create types

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
---
 packages/cli/src/lib/create/types.ts | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)

diff --git a/packages/cli/src/lib/create/types.ts b/packages/cli/src/lib/create/types.ts
index fd2e684e11..5a2460d0df 100644
--- a/packages/cli/src/lib/create/types.ts
+++ b/packages/cli/src/lib/create/types.ts
@@ -40,10 +40,31 @@ export type AnyOptions = Record<string, string>;
 export type Prompt<TOptions> = DistinctQuestion<TOptions> & { name: string };
 
 export interface Factory<TOptions extends AnyOptions> {
+  /**
+   * The name used for this factory.
+   */
   name: string;
+
+  /**
+   * A description that describes what this factory creates to the user.
+   */
   description: string;
+
+  /**
+   * An optional options discovery step that is run
+   * before the prompts to potentially fill in some of the options.
+   */
   optionsDiscovery?(): Promise<Partial<TOptions>>;
+
+  /**
+   * Inquirer prompts that will be filled in either interactively or
+   * through command line arguments.
+   */
   optionsPrompts?: ReadonlyArray<Prompt<TOptions>>;
+
+  /**
+   * The main method of the factory that handles creation.
+   */
   create(options: TOptions, context?: CreateContext): Promise<void>;
 }