feat: creating custom help string (#103)

* feat: creating custom help string

* feat: removed topic and changed to flag

* test: removing code smells

* test:fixing issues with test

* test: fixing lint issues

* refactor: extended the library intead

* refactor: lint fixes

* Revert "Merge remote-tracking branch 'upstream/master' into new-help-string"

This reverts commit 8993abb, reversing
changes made to e3debf2.

Author: Souvikns

.eslintrc

@@ -184,7 +184,7 @@
   },
   "overrides": [
     {
-      "files": ["*.spec.ts", "*.spec.tsx"],
+      "files": ["*.spec.ts", "*.spec.tsx", "src/help/command.ts"],
       "rules": {
         "no-undef": "off",
         "security/detect-non-literal-fs-filename": "off",
@@ -194,7 +194,8 @@
         "sonarjs/no-identical-functions": "off",
         "@typescript-eslint/no-non-null-assertion": "off",
         "@typescript-eslint/no-unused-vars": "off",
-        "no-use-before-define": "off"
+        "no-use-before-define": "off",
+        "sonarjs/cognitive-complexity": "off"
       }
     }
   ]

.github/workflows/automerge.yml

@@ -17,7 +17,7 @@ on:
   pull_request_review:
     types:
       - submitted
-
+  
 jobs:
 
   autoapprove:
@@ -44,16 +44,4 @@ jobs:
           MERGE_METHOD: "squash"
           MERGE_COMMIT_MESSAGE: "pull-request-title"
           MERGE_RETRIES: "20"
-          MERGE_RETRY_SLEEP: "30000"
-  
-  labelWhenApproved:
-    needs: [autoapprove]
-    name: Label when approved
-    runs-on: ubuntu-latest
-    steps:
-    - name: Label when approved
-      uses: pullreminders/label-when-approved-action@v1.0.7
-      env:
-        APPROVALS: "1"
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        ADD_LABEL: "autoapproved"
+          MERGE_RETRY_SLEEP: "30000"

.github/workflows/autoupdate.yml

@@ -10,7 +10,3 @@
 /tmp
 /yarn.lock
 node_modules
-
-asyncapi.json
-asyncapi.yaml
-asyncapi.yml

.gitignore

@@ -1 +1 @@
-sonar.exclusions=src/commands/**,src/models/SpecificationFile.ts
+sonar.exclusions=src/commands/**,src/models/SpecificationFile.ts,src/help/**

.sonarcloud.properties

@@ -23,6 +23,16 @@
 
 <!-- toc -->
 
+- [Requirements](#requirements)
+  * [Installation](#installation)
+- [Usage](#usage)
+- [API Reference](#api-reference)
+  * [`validate`](#validate)
+  * [`context`](#context)
+- [Contributing](#contributing)
+  * [Set up development environment](#set-up-development-environment)
+  * [Command Structure and Patterns](#command-structure-and-patterns)
+
 <!-- tocstop -->
 
 ## Requirements
@@ -59,19 +69,57 @@ We have well-documented help commands so just run:
 asyncapi --help 
 ```
 
-It should print something like:
 
+
+
+## API Reference
+
+### `validate`
+
+**USAGE**
+
+```
+asyncapi validate <spcPath | context-name> [options]
 ```
-All in one CLI for all AsyncAPI tools
 
-USAGE
-  $ asyncapi [COMMAND]
+If you already have your current context set, run the following command:
 
-COMMANDS
-  config    access configs
-  help      display help for asyncapi
-  new       creates a new asyncapi file
-  validate  validate asyncapi file
+```
+asyncapi validate
+```
+
+**OPTIONS** 
+
+```
+-h, --help Display help for command
+-w, --watch Enable watch mode (not implemented yet)
+```
+
+
+### `context`
+
+**Context** makes it easier for you to work with multiple AsyncAPI Files. You can add multiple different files to a context so that you don't have to pass the file as an input every time you use any command. You can also set a default context so that you don't have to pass in either file paths or context names as an input.
+
+**USAGE**
+
+```
+asyncapi context [options] [command]
+```
+
+**COMMANDS**
+
+|command|arguments|description|example|
+|-------|---------|-----------|-------|
+|`list`|`none` |lists all saved context|`asyncapi context list`|
+|`current`|`none`|set current context|`asyncapi context current`|
+|`use` | `<context-name>`| set any context from the list as current|`asyncapi context use test`|
+|`add`|`<context-name> <spec-file-path>`|add/update a context|`asyncapi context add root ./asyncapi.yml`|
+|`remove`|`<context-name>`|remove a context from the list|`asyncapi context remove root`|
+
+**OPTIONS**
+
+```
+-h, --help display help for command
 ```