feat: add readme for error hint (#4)

cnpm · Sep 6, 2022 · af5bf32 · af5bf32
1 parent 727ea1a
commit af5bf32
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 2 deletions.
diff --git a/package.json b/package.json
@@ -37,7 +37,7 @@
     "typescript": "^4.7.4"
   },
   "engines": {
-    "node": ">=14.20.0"
+    "node": ">=14.17.0"
   },
   "repository": {
     "type": "git",

diff --git a/src/index.ts b/src/index.ts
@@ -134,6 +134,10 @@ class ErrorRunner {
     });
 
     message = `${this.getPrefix(loglevel, code)}${message}`;
+
+    if (error.readme) {
+      message = `${message}\n${this.getPrefix(loglevel, code)}参考文档，了解更多：${error.readme}`;
+    }
     return message;
   }
 

diff --git a/test/index.test.ts b/test/index.test.ts
@@ -93,7 +93,7 @@ describe('test/index.test.ts', () => {
       const { code, message } = new Error1();
       await errorRunner.precheck(code, message);
       const errHint = await errorRunner.generate(code, message);
-      assert.strictEqual(errHint, '[@cnpmjs/errors]E02001: 当前运行 Node 版本为 v14.20.0');
+      assert.strictEqual(errHint, '[@cnpmjs/errors]E02001: 当前运行 Node 版本为 v14.20.0\n[@cnpmjs/errors]E02001: 参考文档，了解更多：aaa');
     });
   });