@guritso/terminal 1.0.4 → 1.0.6

package/LICENSE

@@ -631,8 +631,8 @@ to attach them to the start of each source file to most effectively
 state the exclusion of warranty; and each file should have at least
 the "copyright" line and a pointer to where the full notice is found.
 
-    <one line to give the program's name and a brief idea of what it does.>
-    Copyright (C) <year>  <name of author>
+    @guri/terminal enhanced terminal logging for node apps
+    Copyright (C) 2024 Guritso
 
     This program is free software: you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
@@ -652,7 +652,7 @@ Also add information on how to contact you by electronic and paper mail.
   If the program does terminal interaction, make it output a short
 notice like this when it starts in an interactive mode:
 
-    @guri/terminal  Copyright (C) 2024  GuriTsuki
+    @guri/terminal  Copyright (C) 2024  Guritso
     This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
     This is free software, and you are welcome to redistribute it
     under certain conditions; type `show c' for details.

package/README.md

@@ -1,4 +1,4 @@
-# @guri/terminal
+# @guritso/terminal
 
 A terminal node utility for logging and error handling.
 
@@ -8,14 +8,14 @@ A terminal node utility for logging and error handling.
 
 ## Installation
 
-To install the package, use the following command:
+To install the package:
 
 ```bash
-npm install github:GuriTsuki/terminal
+npm install @guritso/terminal
 # or
-pnpm install github:GuriTsuki/terminal
+pnpm install @guritso/terminal
 # or
-yarn add @guri/terminal@github:GuriTsuki/terminal
+yarn add @guritso/terminal
 ```
 
 ## Usage
@@ -23,24 +23,32 @@ yarn add @guri/terminal@github:GuriTsuki/terminal
 To use the package, import it into your project:
 
 ```javascript
-import terminal from '@guri/terminal';
+import terminal from '@guritso/terminal';
 // Setup the terminal (this is necessary to use the console.error function)
 terminal.setup();
+
 // Start the terminal with a your project's specific host and port ( both are optional) its only used for the project info
 terminal.start('http://localhost', 3000);
+
 // Log an information message
 terminal.log('This is an info message');
+
 // Log a success message
 terminal.pass('This is a success message');
-// Log an error message (it detects if the data is an error and display it with the terminal.error function)
+
+// Log an error message (it detects if the data is an error and display it with the fail log level)
 terminal.log(new Error('This is an error message'));
 ```
 
-## API
+## Methods
 
-### `terminal.start(host, port)`
+### `terminal.setup()`
+
+Sets up the console.error to use the terminal.log function. Every error message will be displayed with the fail log level even if you don't use the terminal.log function.
 
-Displays the project info and the host and port.
+### `terminal.start(host, port)` (optional)
+
+Displays the project info and the host and port. if you want to display the project info on start of your app, this is a nice way to do it.
 
 - `host` (string): The host to display.
 - `port` (number): The port number to display.
@@ -59,13 +67,12 @@ Displays a log message.
 
 ### `terminal.setVerbose(verbose)`
 
-Sets the verbose level. (0 = no output, 1 = same line output (does't apply for pass), 2 = new line output)
+Sets the verbose level. (0 = no output (does't apply for start()), 1 = same line output (does't apply for pass), 2 = new line output)
 
 - `verbose` (number): The verbose level.
 
-### `terminal.setup()`
 
-Sets up the console.error to use the terminal.log function.
+## Methods
 
 ## License
 

package/index.d.ts

@@ -1,5 +1,5 @@
 import terminal from "./index.js";
 
-declare module "@guri/terminal" {
+declare module "@guritso/terminal" {
   export default terminal;
 }

package/index.js

@@ -25,9 +25,9 @@ import { readFileSync } from "fs";
 const terminal = {
   verbose: 2,
   levels: {
-    info: co("%H100  info:%H"),
-    fail: co("%H41  fail:%H"),
-    pass: co("%H42  pass:%H"),
+    info: co("%H100  INFO:%H"),
+    fail: co("%H41  FAIL:%H"),
+    pass: co("%H42  PASS:%H"),
   },
 };
 
@@ -139,10 +139,22 @@ terminal.isError = (data) => {
  * Setup the console.error to use the terminal.log function
  */
 terminal.setup = function setup() {
-  // backup the original console.error
-  console.backup = console.error;
+  if (typeof console === "object" && console.error) {
+    
+    if (typeof console.backup === "function") {
+      return false
+    }
+    
+    // backup the original console.error
+    console.backup = console.error;
+  } else {
+    throw new Error("console.error is not found");
+  }
+
   // replace the console.error with the terminal.log
   console.error = terminal.log;
+
+  return true
 };
 
 terminal.clear = function clear() {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@guritso/terminal",
   "description": "A terminal node utility for logging and error handling",
-  "version": "1.0.4",
+  "version": "1.0.6",
   "type": "module",
   "main": "index.js",
   "license": "GPL-3.0",
@@ -10,7 +10,7 @@
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/GuriTsuki/terminal.git"
+    "url": "git+https://github.com/guritso/terminal.git"
   },
   "keywords": [
     "terminal",
@@ -19,7 +19,7 @@
     "cli",
     "utility"
   ],
-  "author": "GuriTsuki",
+  "author": "GuriTso",
   "devDependencies": {
     "jest": "^29.7.0"
   },
@@ -28,7 +28,7 @@
   },
   "types": "./index.d.ts",
   "bugs": {
-    "url": "https://github.com/GuriTsuki/terminal/issues"
+    "url": "https://github.com/guritso/terminal/issues"
   },
-  "homepage": "https://github.com/GuriTsuki/terminal#readme"
+  "homepage": "https://github.com/guritso/terminal#readme"
 }

package/tests/terminal.test.js

@@ -5,7 +5,6 @@ import terminal from "../index.js";
 describe("Terminal Module", () => {
   beforeEach(() => {
     jest.resetAllMocks();
-    terminal.setup();
   });
 
   describe("start", () => {
@@ -29,7 +28,7 @@ describe("Terminal Module", () => {
         .mockImplementation(() => true);
       terminal.pass("Operation successful");
 
-      expect(mockWrite).toHaveBeenCalledWith(expect.stringContaining("pass"));
+      expect(mockWrite).toHaveBeenCalledWith(expect.stringContaining("PASS"));
       mockWrite.mockRestore();
     });
   });
@@ -54,7 +53,7 @@ describe("Terminal Module", () => {
         .mockImplementation(() => true);
 
       terminal.log("Info message");
-      expect(mockWrite).toHaveBeenCalledWith(expect.stringContaining("info"));
+      expect(mockWrite).toHaveBeenCalledWith(expect.stringContaining("INFO"));
       mockWrite.mockRestore();
     });
 
@@ -65,7 +64,7 @@ describe("Terminal Module", () => {
         .mockImplementation(() => true);
 
       terminal.log("Error: Something went wrong");
-      expect(mockWrite).toHaveBeenCalledWith(expect.stringContaining("fail"));
+      expect(mockWrite).toHaveBeenCalledWith(expect.stringContaining("FAIL"));
       mockWrite.mockRestore();
     });
 
@@ -106,6 +105,36 @@ describe("Terminal Module", () => {
 
       console.error = originalError;
     });
+
+    it("should backup the original console.error", () => {
+      const originalError = console.error;
+
+      terminal.setup();
+
+      expect(console.backup).toBe(originalError);
+
+      console.error = originalError;
+    });
+
+    it("should not replace console.error if console.backup exists", () => {
+      console.backup = jest.fn();
+      const originalError = console.error;
+      const result = terminal.setup();
+
+      expect(result).toBe(false);
+      expect(console.error).toBe(originalError);
+
+      delete console.backup;
+    });
+
+    it("should throw an error if console.error is not found", () => {
+      const originalConsole = global.console;
+      global.console = { log: jest.fn() };
+
+      expect(() => terminal.setup()).toThrow("console.error is not found");
+
+      global.console = originalConsole;
+    });
   });
 
   describe("clear", () => {

package/log.js

@@ -1,56 +0,0 @@
-import terminal from "./index.js";
-
-
-terminal.log(
-  terminal.projectInfo
-);
-
-terminal.setup();
-terminal.setVerbose(1);
-terminal.start("ftp://example.com", 3000);
-terminal.start("localhost", 3000);
-terminal.start("localhost");
-terminal.start({ host: "localhost" }, 3000);
-terminal.start("http://localhost:3000");
-terminal.start("http://localhost", "5ç688o");
-terminal.start("https://localhost");
-terminal.start("http://127.0.0.1", 3000);
-terminal.start("http://127.0.0.1:3000");
-terminal.start("http://127.0.0.1");
-terminal.start("https://127.0.0.1");
-terminal.start("http://192.168.0.1", 3000);
-terminal.start("http://192.168.0.1:3000");
-terminal.start("http://192.168.0.1");
-terminal.start("https://192.168.0.1");
-terminal.start("http://www.google.com");
-terminal.start("http://example.com", 8080);
-terminal.start("http://example.com");
-terminal.start("https://example.com");
-terminal.start("http://www.example.com");
-terminal.start("http://test.com", 4000);
-terminal.start("http://test.com");
-terminal.start("https://test.com");
-terminal.start("http://www.test.com");
-terminal.start({
-  host: "localhost",
-  port: 3000,
-});
-terminal.log("This is a log message");
-terminal.pass("This is a pass message");
-terminal.pass("This is a pass message");
-terminal.pass("This is a pass message");
-
-terminal.pass("This is a pass message");
-terminal.log("This is a log message");
-
-terminal.setVerbose(2);
-
-terminal.start("http://localhost:3000");
-terminal.log("loaded routes!");
-terminal.pass("server online!");
-
-const error = new Error("failed to load users");
-
-error.stack = error.stack.replace("/israel/Documentos/", "/guri/projects/");
-
-terminal.log(error);