feat: basic help message

src/cli.ts

@@ -4,11 +4,17 @@ import { promptForMissingOptions } from "./utils/prompt-for-missing-options";
 import { renderIntroMessage } from "./utils/render-intro-message";
 import type { Args } from "./types";
 import chalk from "chalk";
+import { showHelpMessage } from "./utils/show-help-message";
 
 export async function cli(args: Args) {
   try {
     renderIntroMessage();
     const rawOptions = await parseArgumentsIntoOptions(args);
+    if (rawOptions.help) {
+      showHelpMessage();
+      return;
+    }
+
     const options = await promptForMissingOptions(rawOptions);
     await createProject(options);
   } catch (error: any) {

src/types.ts

@@ -8,6 +8,7 @@ export type RawOptions = {
   dev: boolean;
   extensions: Extension[] | null;
   externalExtension: ExternalExtension | null;
+  help: boolean;
 };
 
 export type ExternalExtension = {

src/utils/parse-arguments-into-options.ts

@@ -41,6 +41,9 @@ export async function parseArgumentsIntoOptions(rawArgs: Args): Promise<RawOptio
 
       "--extension": String,
       "-e": "--extension",
+
+      "--help": Boolean,
+      "-h": "--help",
     },
     {
       argv: rawArgs.slice(2).map(a => a.toLowerCase()),
@@ -53,6 +56,8 @@ export async function parseArgumentsIntoOptions(rawArgs: Args): Promise<RawOptio
 
   const dev = args["--dev"] ?? false; // info: use false avoid asking user
 
+  const help = args["--help"] ?? false;
+
   const project = args._[0] ?? null;
 
   // ToDo. Allow multiple
@@ -75,5 +80,6 @@ export async function parseArgumentsIntoOptions(rawArgs: Args): Promise<RawOptio
     dev,
     extensions: null, // TODO add extensions flags
     externalExtension: extension,
+    help,
   };
 }

src/utils/prompt-for-missing-options.ts

@@ -10,6 +10,7 @@ const defaultOptions: RawOptions = {
   dev: false,
   extensions: [],
   externalExtension: null,
+  help: false,
 };
 
 const invalidQuestionNames = ["project", "install"];
@@ -69,6 +70,7 @@ export async function promptForMissingOptions(options: RawOptions): Promise<Opti
     dev: options.dev ?? defaultOptions.dev,
     extensions: [],
     externalExtension: options.externalExtension,
+    help: options.help,
   };
 
   config.questions.forEach(question => {

src/utils/show-help-message.ts

@@ -0,0 +1,14 @@
+import chalk from "chalk";
+
+export const showHelpMessage = () => {
+  console.log(` ${chalk.bold.blue("Usage:")}
+    ${chalk.bold.green("npx create-eth<@version>")} ${chalk.gray("[-i | --install | -s | --skip | --skip-install] [-e <extension> | --extension <extension>] [--dev] [-h | --help]")}
+`);
+  console.log(` ${chalk.bold.blue("Options:")}
+    ${chalk.gray("-i, --install")}               Install packages
+    ${chalk.gray("-s, --skip, --skip-install")}  Skip packages installation
+    ${chalk.gray("-e, --extension")}             Add curated or third-party extension
+    ${chalk.gray("--dev")}                       Developer mode
+    ${chalk.gray("-h, --help")}                  Help
+    `);
+};