feat: support command-specific help and improve display quality (#52)

Author: Souvikns

README.md

@@ -13,31 +13,66 @@
 $ npm install --global @asyncapi/cli
 ```
 
+### Getting Started
+Go ahead and run command `asyncapi --help` to get complete help for using CLI. If having doubt about any particular command do run `asyncapi <command> --help` to get help for that command.  
+
 ### CLI
+Help string for all the supported commands
+
+- #### `asyncapi --help`
+```
+USAGE
+
+asyncapi [options] [command]
+
+OPTIONS
+
+-h, --help display help for command
+--version output the version number
+
+COMMANDS
+
+validate validate asyncapi file 
+context  Manage contexts
+```
+
+- #### `asyncapi validate --help`
 ```
-$ asyncapi --help
-
-Usage
-  $ asyncapi command options
-  
-Commands
-  validate 
-   Options
-     -c --context  context-name saved in the store
-     -w --watch Enable watchMode (not implemented yet)
-     -f --file File path of the specification file
-  
-  context
-    current show the current set context
-    list show the list of all stored contexts
-    remove <context-name> remove a context from the store
-    use <context-name> set any context from store as current
-    add <context-name> <filepath> add/update new context
-
-Examples
-  $ asyncapi context add dummy ./asyncapi.yml
-  $ asyncapi validate --context=dummy
-  $ asyncapi validate --file=./asyncapi.yml
+USAGE
+
+asyncapi validate [options]
+
+OPTIONS
+
+-h, --help display help for command
+-f, --file <spec-file-path> Path of the asyncapi file
+-c, --context <saved-context-name>  context name to use
+-w, --watch Enable Watch Mode (not implemented yet)
+```
+
+- #### `asyncapi context --help`
+```
+USAGE
+
+asyncapi context [options] [command] 
+
+Context is what makes it easier for you to work with multiple AsyncAPI files.
+You can add multiple different files to a contextThis way you do not have to pass 
+--file flag with path to the file every time but just --context flag with reference name
+You can also set a default context, so neither --file nor --context flags are needed.
+
+OPTIONS
+
+-h, --help display help for command 
+
+COMMANDS
+
+list list of all saved contexts 
+current see current context 
+use <context-name> set given context as default/current
+add <context-name> <spec-file-path> add/update context
+remove <context-name> remove a context
+
 ```
 
 > For now --context flag is requried to run validate command

src/CliModels.ts

@@ -1,4 +1,4 @@
-export type Command = string;
+export type Command = string | undefined;
 export type HelpMessage = string;
 export type Arguments = string[];
 
@@ -12,11 +12,13 @@ export class CliInput {
   private readonly _command: Command
   private readonly _options: Options
   private readonly _arguments: Arguments
+  private readonly _help: boolean | undefined
 
-  private constructor(command: Command, options: Options, args: Arguments) {
+  private constructor(command: Command, options: Options, args: Arguments, help?:boolean) {
     this._command = command;
     this._options = options;
     this._arguments = args;
+    this._help = help;
   }
 
   get command(): Command {
@@ -31,15 +33,19 @@ export class CliInput {
     return this._arguments;
   }
 
+  get help(): boolean | undefined {
+    return this._help;
+  }
+
   static createFromMeow(meowOutput: any): CliInput {
     const [command, ...args] = meowOutput.input;
     const { context, watch, file } = meowOutput.flags;
-    return new CliInput(command || 'help', { context, watch, file }, args);
+    return new CliInput(command, { context, watch, file }, args, meowOutput.flags.help);
   }
 
   static createSubCommand(cliInput: CliInput): CliInput {
     const [command, ...args] = cliInput.arguments;
-    return new CliInput(command || 'help', cliInput.options, args);
+    return new CliInput(command, cliInput.options, args);
   }
 }
 

src/CommandsRouter.tsx

@@ -2,13 +2,21 @@ import React from 'react';
 import Validate from './components/Validate/Validate';
 import { contextRouter } from './components/Context';
 import { CliInput } from './CliModels';
+import { CommandName, HelpMessageBuilder } from './help-message';
 
 const commandsDictionary = (cliInput: CliInput): Record<string, any> => ({
   validate: <Validate options={cliInput.options} />,
   context: contextRouter(cliInput)
 });
 
 export const commandsRouter = (cli: any): any => {
+  const helpMessage = new HelpMessageBuilder();
   const cliInput = CliInput.createFromMeow(cli);
+  if (!cliInput.command) {
+    return <helpMessage.HelpComponent />;
+  }
+  if (cliInput.help) {
+    return <helpMessage.HelpComponent command={cliInput.command as CommandName} />;
+  }
   return commandsDictionary(cliInput)[cliInput.command];
 };

src/cli.ts

@@ -5,28 +5,8 @@ import { render } from 'ink';
 import meow from 'meow';
 import { commandsRouter } from './CommandsRouter';
 
-const cli = meow(`
-	Usage
-	  $ asyncapi command options
-	  
-	Commands
-		validate 
-			Options
-				-c --context  context-name saved in the store
-				-w --watch Enable watchMode (not implemented yet)
-				-f --file File path of the specification file
-		context
-			current  show the current set context
-			list     show the list of all stored context
-			remove  <context-name> remove a context from the store
-			use <context-name>  set any context as current
-			add <context-name> <filepath> add/update new context
-
-	Examples
-		$ asyncapi context add dummy ./asyncapi.yml
-		$ asyncapi validate --context=dummy
-		$ asyncapi validate --file=./asyncapi.yml
-`, {
+const cli = meow({
+  autoHelp: false,
   flags: {
     context: {
       alias: 'c',
@@ -43,6 +23,9 @@ const cli = meow(`
       alias: 'f',
       type: 'string',
       isRequired: false
+    },
+    help: {
+      alias: 'h'
     }
   }
 });

src/components/Context/index.tsx

@@ -1,3 +1,4 @@
+/* eslint-disable @typescript-eslint/no-non-null-assertion */
 import React from 'react';
 
 import { ListContexts,AddContext,RemoveContext,ShowCurrentContext,SetCurrent } from './Context';
@@ -13,5 +14,5 @@ const commandDictionary = (cliInput: CliInput): Record<string, any> => ({
 
 export const contextRouter = (cliInput: CliInput): any => {
   const subCommand = CliInput.createSubCommand(cliInput);
-  return commandDictionary(subCommand)[subCommand.command];
+  return commandDictionary(subCommand)[subCommand.command!];
 };