feat(exception): paint message and help values in pretiffy

jlenon7 · jlenon7 · commit 241f76771427 · 2022-04-27T18:19:00.000-03:00
diff --git a/index.d.ts b/index.d.ts
@@ -1,3 +1,12 @@
+/**
+ * @secjs/utils
+ *
+ * (c) João Lenon <lenonSec7@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
 export declare interface ExceptionJSON {
   code?: string
   name: string
@@ -115,7 +124,7 @@ export declare class Debug {
 export declare class Exception extends Error {
   constructor(content?: string, status?: number, code?: string, help?: string)
 
-  toJSON(stack: boolean): ExceptionJSON
+  toJSON(stack?: boolean): ExceptionJSON
 
   prettify(options?: {
     prefix?: string
diff --git a/index.js b/index.js
@@ -1,5 +1,5 @@
 /**
- * @secjs/esm
+ * @secjs/utils
  *
  * (c) João Lenon <lenonSec7@gmail.com>
  *
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@secjs/utils",
-  "version": "1.8.4",
+  "version": "1.8.5",
   "description": "Utils functions and classes for Node.js",
   "license": "MIT",
   "author": "João Lenon <lenon@athenna.io>",
diff --git a/src/Clean.js b/src/Clean.js
@@ -1,5 +1,5 @@
 /**
- * @secjs/esm
+ * @secjs/utils
  *
  * (c) João Lenon <lenonSec7@gmail.com>
  *
diff --git a/src/Config.js b/src/Config.js
@@ -1,5 +1,5 @@
 /**
- * @secjs/esm
+ * @secjs/utils
  *
  * (c) João Lenon <lenonSec7@gmail.com>
  *
diff --git a/src/Debug.js b/src/Debug.js
@@ -1,5 +1,5 @@
 /**
- * @secjs/esm
+ * @secjs/utils
  *
  * (c) João Lenon <lenonSec7@gmail.com>
  *
diff --git a/src/Exception.js b/src/Exception.js
@@ -1,5 +1,5 @@
 /**
- * @secjs/esm
+ * @secjs/utils
  *
  * (c) João Lenon <lenonSec7@gmail.com>
  *
@@ -8,6 +8,7 @@
  */
 
 import Youch from 'youch'
+import chalk from 'chalk'
 import changeCase from 'change-case'
 import YouchTerminal from 'youch-terminal'
 
@@ -113,8 +114,16 @@ export class Exception extends Error {
       displayMainFrameOnly: false,
     })
 
+    const message = `${chalk.yellow.bold('MESSAGE')}\n   ${this.message}`
+    const help = ` ${chalk.green.bold('HELP')}\n   ${this.help}`
+
     this.name = this.code
-    this.message = `Message: ${this.message}\n Help: ${this.help}`
+
+    if (this.help) {
+      this.message = `${message}\n\n${help}`
+    } else {
+      this.message = `${message}`
+    }
 
     const jsonResponse = await new Youch(this, {}).toJSON()
 
diff --git a/src/Exceptions/ConfigNotNormalizedException.js b/src/Exceptions/ConfigNotNormalizedException.js
@@ -1,5 +1,5 @@
 /**
- * @secjs/esm
+ * @secjs/utils
  *
  * (c) João Lenon <lenonSec7@gmail.com>
  *
diff --git a/src/Exceptions/InvalidNumberException.js b/src/Exceptions/InvalidNumberException.js
@@ -1,5 +1,5 @@
 /**
- * @secjs/esm
+ * @secjs/utils
  *
  * (c) João Lenon <lenonSec7@gmail.com>
  *
diff --git a/src/Exceptions/InvalidUuidException.js b/src/Exceptions/InvalidUuidException.js
@@ -1,5 +1,5 @@
 /**
- * @secjs/esm
+ * @secjs/utils
  *
  * (c) João Lenon <lenonSec7@gmail.com>
  *
diff --git a/src/Exceptions/NodeExecException.js b/src/Exceptions/NodeExecException.js
@@ -1,5 +1,5 @@
 /**
- * @secjs/esm
+ * @secjs/utils
  *
  * (c) João Lenon <lenonSec7@gmail.com>
  *
diff --git a/src/Exceptions/NotFoundFileException.js b/src/Exceptions/NotFoundFileException.js
@@ -1,5 +1,5 @@
 /**
- * @secjs/esm
+ * @secjs/utils
  *
  * (c) João Lenon <lenonSec7@gmail.com>
  *
diff --git a/src/Exceptions/NotFoundFolderException.js b/src/Exceptions/NotFoundFolderException.js
@@ -1,5 +1,5 @@
 /**
- * @secjs/esm
+ * @secjs/utils
  *
  * (c) João Lenon <lenonSec7@gmail.com>
  *
diff --git a/src/Exceptions/OrdinalNanException.js b/src/Exceptions/OrdinalNanException.js
@@ -1,5 +1,5 @@
 /**
- * @secjs/esm
+ * @secjs/utils
  *
  * (c) João Lenon <lenonSec7@gmail.com>
  *
diff --git a/src/Exceptions/RecursiveConfigException.js b/src/Exceptions/RecursiveConfigException.js
@@ -1,5 +1,5 @@
 /**
- * @secjs/esm
+ * @secjs/utils
  *
  * (c) João Lenon <lenonSec7@gmail.com>
  *
diff --git a/src/Exceptions/RouteMatchException.js b/src/Exceptions/RouteMatchException.js
@@ -1,5 +1,5 @@
 /**
- * @secjs/esm
+ * @secjs/utils
  *
  * (c) João Lenon <lenonSec7@gmail.com>
  *
diff --git a/src/Exec.js b/src/Exec.js
@@ -1,5 +1,5 @@
 /**
- * @secjs/esm
+ * @secjs/utils
  *
  * (c) João Lenon <lenonSec7@gmail.com>
  *
@@ -12,6 +12,7 @@ import { Transform } from 'node:stream'
 import { request as requestHttp } from 'node:http'
 import { request as requestHttps } from 'node:https'
 import { exec as childProcessExec } from 'node:child_process'
+
 import { File } from '#src/File'
 import { Options } from '#src/Options'
 import { NodeExecException } from '#src/Exceptions/NodeExecException'
diff --git a/src/File.js b/src/File.js
@@ -1,5 +1,5 @@
 /**
- * @secjs/esm
+ * @secjs/utils
  *
  * (c) João Lenon <lenonSec7@gmail.com>
  *
diff --git a/src/Folder.js b/src/Folder.js
@@ -1,5 +1,5 @@
 /**
- * @secjs/esm
+ * @secjs/utils
  *
  * (c) João Lenon <lenonSec7@gmail.com>
  *
diff --git a/src/Is.js b/src/Is.js
@@ -1,5 +1,5 @@
 /**
- * @secjs/esm
+ * @secjs/utils
  *
  * (c) João Lenon <lenonSec7@gmail.com>
  *
diff --git a/src/Json.js b/src/Json.js
@@ -1,5 +1,5 @@
 /**
- * @secjs/esm
+ * @secjs/utils
  *
  * (c) João Lenon <lenonSec7@gmail.com>
  *
diff --git a/src/Number.js b/src/Number.js
@@ -1,5 +1,5 @@
 /**
- * @secjs/esm
+ * @secjs/utils
  *
  * (c) João Lenon <lenonSec7@gmail.com>
  *
diff --git a/src/Options.js b/src/Options.js
@@ -1,5 +1,5 @@
 /**
- * @secjs/esm
+ * @secjs/utils
  *
  * (c) João Lenon <lenonSec7@gmail.com>
  *
diff --git a/src/Parser.js b/src/Parser.js
@@ -1,5 +1,5 @@
 /**
- * @secjs/esm
+ * @secjs/utils
  *
  * (c) João Lenon <lenonSec7@gmail.com>
  *
diff --git a/src/Path.js b/src/Path.js
@@ -1,5 +1,5 @@
 /**
- * @secjs/esm
+ * @secjs/utils
  *
  * (c) João Lenon <lenonSec7@gmail.com>
  *
diff --git a/src/Route.js b/src/Route.js
@@ -1,5 +1,5 @@
 /**
- * @secjs/esm
+ * @secjs/utils
  *
  * (c) João Lenon <lenonSec7@gmail.com>
  *
diff --git a/src/String.js b/src/String.js
@@ -1,5 +1,5 @@
 /**
- * @secjs/esm
+ * @secjs/utils
  *
  * (c) João Lenon <lenonSec7@gmail.com>
  *
diff --git a/src/Uuid.js b/src/Uuid.js
@@ -1,5 +1,5 @@
 /**
- * @secjs/esm
+ * @secjs/utils
  *
  * (c) João Lenon <lenonSec7@gmail.com>
  *
diff --git a/tests/Stubs/config/app.js b/tests/Stubs/config/app.js
@@ -1,5 +1,5 @@
 /**
- * @secjs/esm
+ * @secjs/utils
  *
  * (c) João Lenon <lenonSec7@gmail.com>
  *
diff --git a/tests/Stubs/config/database.js b/tests/Stubs/config/database.js
@@ -1,5 +1,5 @@
 /**
- * @secjs/esm
+ * @secjs/utils
  *
  * (c) João Lenon <lenonSec7@gmail.com>
  *
diff --git a/tests/Stubs/config/notNormalized.js b/tests/Stubs/config/notNormalized.js
@@ -1,5 +1,5 @@
 /**
- * @secjs/esm
+ * @secjs/utils
  *
  * (c) João Lenon <lenonSec7@gmail.com>
  *
diff --git a/tests/Stubs/config/recursiveOne.js b/tests/Stubs/config/recursiveOne.js
@@ -1,5 +1,5 @@
 /**
- * @secjs/esm
+ * @secjs/utils
  *
  * (c) João Lenon <lenonSec7@gmail.com>
  *
diff --git a/tests/Stubs/config/recursiveTwo.js b/tests/Stubs/config/recursiveTwo.js
@@ -1,5 +1,5 @@
 /**
- * @secjs/esm
+ * @secjs/utils
  *
  * (c) João Lenon <lenonSec7@gmail.com>
  *
diff --git a/tests/Unit/CleanTest.js b/tests/Unit/CleanTest.js
@@ -1,5 +1,5 @@
 /**
- * @secjs/esm
+ * @secjs/utils
  *
  * (c) João Lenon <lenonSec7@gmail.com>
  *
diff --git a/tests/Unit/ConfigTest.js b/tests/Unit/ConfigTest.js
@@ -1,5 +1,5 @@
 /**
- * @secjs/esm
+ * @secjs/utils
  *
  * (c) João Lenon <lenonSec7@gmail.com>
  *
diff --git a/tests/Unit/DebugTest.js b/tests/Unit/DebugTest.js
@@ -1,5 +1,5 @@
 /**
- * @secjs/esm
+ * @secjs/utils
  *
  * (c) João Lenon <lenonSec7@gmail.com>
  *
diff --git a/tests/Unit/ExceptionTest.js b/tests/Unit/ExceptionTest.js
@@ -1,5 +1,5 @@
 /**
- * @secjs/esm
+ * @secjs/utils
  *
  * (c) João Lenon <lenonSec7@gmail.com>
  *
diff --git a/tests/Unit/ExecTest.js b/tests/Unit/ExecTest.js
@@ -1,5 +1,5 @@
 /**
- * @secjs/esm
+ * @secjs/utils
  *
  * (c) João Lenon <lenonSec7@gmail.com>
  *
diff --git a/tests/Unit/FileTest.js b/tests/Unit/FileTest.js
@@ -1,5 +1,5 @@
 /**
- * @secjs/esm
+ * @secjs/utils
  *
  * (c) João Lenon <lenonSec7@gmail.com>
  *
diff --git a/tests/Unit/FolderTest.js b/tests/Unit/FolderTest.js
@@ -1,5 +1,5 @@
 /**
- * @secjs/esm
+ * @secjs/utils
  *
  * (c) João Lenon <lenonSec7@gmail.com>
  *
diff --git a/tests/Unit/IsTest.js b/tests/Unit/IsTest.js
@@ -1,5 +1,5 @@
 /**
- * @secjs/esm
+ * @secjs/utils
  *
  * (c) João Lenon <lenonSec7@gmail.com>
  *
diff --git a/tests/Unit/JsonTest.js b/tests/Unit/JsonTest.js
@@ -1,5 +1,5 @@
 /**
- * @secjs/esm
+ * @secjs/utils
  *
  * (c) João Lenon <lenonSec7@gmail.com>
  *
diff --git a/tests/Unit/NumberTest.js b/tests/Unit/NumberTest.js
@@ -1,5 +1,5 @@
 /**
- * @secjs/esm
+ * @secjs/utils
  *
  * (c) João Lenon <lenonSec7@gmail.com>
  *
diff --git a/tests/Unit/ParserTest.js b/tests/Unit/ParserTest.js
@@ -1,5 +1,5 @@
 /**
- * @secjs/esm
+ * @secjs/utils
  *
  * (c) João Lenon <lenonSec7@gmail.com>
  *
diff --git a/tests/Unit/PathTest.js b/tests/Unit/PathTest.js
@@ -1,5 +1,5 @@
 /**
- * @secjs/esm
+ * @secjs/utils
  *
  * (c) João Lenon <lenonSec7@gmail.com>
  *
diff --git a/tests/Unit/RouteTest.js b/tests/Unit/RouteTest.js
@@ -1,5 +1,5 @@
 /**
- * @secjs/esm
+ * @secjs/utils
  *
  * (c) João Lenon <lenonSec7@gmail.com>
  *
diff --git a/tests/Unit/StringTest.js b/tests/Unit/StringTest.js
@@ -1,5 +1,5 @@
 /**
- * @secjs/esm
+ * @secjs/utils
  *
  * (c) João Lenon <lenonSec7@gmail.com>
  *
diff --git a/tests/Unit/UuidTest.js b/tests/Unit/UuidTest.js
@@ -1,5 +1,5 @@
 /**
- * @secjs/esm
+ * @secjs/utils
  *
  * (c) João Lenon <lenonSec7@gmail.com>
  *

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`/**`
`2`		`- * @secjs/esm`
	`2`	`+ * @secjs/utils`
`3`	`3`	`*`
`4`	`4`	`* (c) João Lenon <[email protected]>`
`5`	`5`	`*`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@secjs/utils",`
`3`		`- "version": "1.8.4",`
	`3`	`+ "version": "1.8.5",`
`4`	`4`	`"description": "Utils functions and classes for Node.js",`
`5`	`5`	`"license": "MIT",`
`6`	`6`	`"author": "João Lenon <[email protected]>",`