docs: add help doc

plantain-00 · May 5, 2020 · 2fdd8da · 2fdd8da
1 parent 91f4ff1
commit 2fdd8da
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 4 deletions.
diff --git a/.type-coverage/result.json b/.type-coverage/result.json
@@ -79,9 +79,9 @@
       "anys": []
     },
     "packages/cli/src/index.ts": {
-      "hash": "39b0d90288726f0a7ee6474931ebf15528890c92",
-      "correctCount": 160,
-      "totalCount": 160,
+      "hash": "63dc238ed233b9c453553d676387627cf18fde3f",
+      "correctCount": 172,
+      "totalCount": 172,
       "anys": []
     },
     "packages/cli/src/lib.d.ts": {

diff --git a/README.md b/README.md
@@ -38,6 +38,7 @@ name | type | description
 `--ignore-catch` | boolean? | [ignore catch](#ignore-catch)
 `--cache` | boolean? | [enable cache](#enable-cache)
 `--ignore-files` | string[]? | [ignore files](#ignore-files)
+`-h`, `--help` | boolean? | show help
 
 ### strict mode
 

diff --git a/packages/cli/src/index.ts b/packages/cli/src/index.ts
@@ -25,6 +25,7 @@ function printHelp() {
 --ignore-catch  boolean?  ignore catch
 --cache         boolean?  enable cache
 --ignore-files  string[]? ignore files
+-h,--help       boolean?  show help
   `)
 }
 
@@ -39,7 +40,7 @@ async function executeCommandLine() {
 
   if (argv.h || argv.help) {
     printHelp()
-    return process.exit(0)
+    process.exit(0)
   }
 
   suppressError = argv.suppressError