Help command

.changeset/giant-carpets-poke.md

@@ -0,0 +1,5 @@
+---
+"create-eth": patch
+---
+
+cli: help command

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

@@ -16,6 +16,7 @@ export type ExternalExtension = {
 
 export type RawOptions = BaseOptions & {
   solidityFramework: SolidityFramework | "none" | null;
+  help: boolean;
 };
 
 type MergedOptions = BaseOptions & {

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

@@ -43,6 +43,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()),
@@ -60,6 +63,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;
 
   const solidityFramework = args["--solidity-framework"] ?? null;
@@ -82,6 +87,7 @@ export async function parseArgumentsIntoOptions(rawArgs: Args): Promise<RawOptio
     install: hasInstallRelatedFlag ? install || !skipInstall : null,
     dev,
     externalExtension: extension,
+    help,
     solidityFramework,
   };
 }

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

@@ -9,6 +9,7 @@ const defaultOptions: RawOptions = {
   install: true,
   dev: false,
   externalExtension: null,
+  help: false,
   solidityFramework: null,
 };
 

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 | --skip | --skip-install] [-s <solidity-framework> | --solidity-framework <solidity-framework>] [-e <extension> | --extension <extension>] [-h | --help]")}
+`);
+  console.log(` ${chalk.bold.blue("Options:")}
+    ${chalk.gray("-i, --install")}                Install packages
+    ${chalk.gray("--skip, --skip-install")}       Skip packages installation
+    ${chalk.gray("-s, --solidity-framework")}     Choose solidity framework
+    ${chalk.gray("-e, --extension")}              Add curated or third-party extension
+    ${chalk.gray("-h, --help")}                   Help
+    `);
+};