@guritso/terminal 1.0.5 → 1.1.0

package/README.md

@@ -26,21 +26,29 @@ To use the package, import it into your project:
 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.js

@@ -1,164 +1 @@
-"use strict";
-
-import { color as co, getErrorNames, formatUrl } from "./utils.js";
-import { readFileSync } from "fs";
-
-
-/**
- * @typedef {Object} Terminal
- * @property {number} verbose
- * @property {Object} levels
- * @property {string} levels.info
- * @property {string} levels.fail
- * @property {string} levels.pass
- * @property {function(string, number): void} start
- * @property {function(string): void} pass
- * @property {function(string): void} log
- * @property {function(): void} setup
- * @property {function(): void} clear
- * @property {function(number): void} setVerbose
- * @property {function(any): boolean} isError
- * @property {Object} projectInfo
- */
-
-/** @type {Terminal} */
-const terminal = {
-  verbose: 2,
-  levels: {
-    info: co("%H100  info:%H"),
-    fail: co("%H41  fail:%H"),
-    pass: co("%H42  pass:%H"),
-  },
-};
-
-const { stdout } = process;
-
-terminal.projectInfo = (() => {
-  try {
-    const { name, version } = JSON.parse(
-      readFileSync("./package.json", "utf-8")
-    );
-
-    return { name, version };
-  } catch (error) {
-    return { name: "unknown", version: "unknown" };
-  }
-})();
-
-/**
- *  display the project info and the port
- *
- * @param {string} host - The host to display
- * @param {number} port - The port number to display
- */
-terminal.start = function start(host, port) {
-  const projectInfo = terminal.projectInfo;
-  const hostInfo = formatUrl(host, port);
-
-  const headLines = [
-    `\n%H46  name:%H%H44  ${projectInfo.name} `,
-    `%H105  version:%H%H41  ${projectInfo.version} %H\n`,
-    hostInfo?.url ? `%H43  host:%H95  ${hostInfo.url}\n` : "",
-    hostInfo?.port ? `%H45  port:%H94  ${hostInfo.port}\n` : "",
-  ];
-
-  for (const line of headLines) {
-    stdout.write(co(line));
-  }
-};
-
-/**
- *  display the online message
- *
- * @param {string} data
- */
-terminal.pass = function pass(data) {
-  terminal.clear();
-  stdout.write(co(`\r%H1 ${terminal.levels.pass}%H ${data}\n`));
-};
-
-/**
- *  display logs messages
- *
- * @param {string} data
- */
-terminal.log = function log(data) {
-  const { verbose, levels } = terminal;
-
-  let level = levels.info;
-
-  if (Number(verbose) === 0) return;
-
-  if (terminal.isError(data)) {
-    level = levels.fail;
-  }
-
-  if (Number(verbose) === 1 && stdout.isTTY) {
-    terminal.clear();
-
-    stdout.write(co(`\r%H1 ${level}%H ${data}`));
-  } else {
-    stdout.write(co(`%H1 ${level}%H `));
-
-    if (level === terminal.levels.info) {
-      if (typeof data === "object") {
-        // skipcq: JS-0002
-        console.log(data);
-      } else {
-        stdout.write(`${co(data)}\n`);
-      }
-    } else {
-      // skipcq: JS-0002
-      console.log(data);
-    }
-  }
-};
-
-/**
- * Check if the data is an error
- *
- * @param {any} data
- * @returns {boolean}
- */
-terminal.isError = (data) => {
-  if (data instanceof Error) {
-    return true;
-  }
-
-  if (typeof data === "string") {
-    const errorKeywords = getErrorNames().map((name) => `Error: ${name}`);
-    errorKeywords.push("Error:");
-
-    return errorKeywords.some((keyword) => data.includes(keyword));
-  }
-
-  return false;
-};
-
-/**
- * Setup the console.error to use the terminal.log function
- */
-terminal.setup = function setup() {
-  // backup the original console.error
-  console.backup = console.error;
-  // replace the console.error with the terminal.log
-  console.error = terminal.log;
-};
-
-terminal.clear = function clear() {
-  if (stdout.isTTY) {
-    stdout.clearLine();
-  }
-};
-
-/**
- * Set the verbose level
- *
- * @param {number} verbose - The verbose level
- */
-terminal.setVerbose = function setVerbose(verbose) {
-  terminal.verbose = verbose;
-};
-
-
-export default terminal;
+module.exports = require('./lib/terminal.js');

package/lib/terminal.js

@@ -0,0 +1,190 @@
+/*!
+ * Terminal
+ * Copyright (c) 2024 @GuriTso
+ * @license GPL-3.0
+ */
+
+"use strict";
+
+const getErrorNames = require("./utils").getErrorNames;
+const formatUrl = require("./utils").formatUrl;
+const co = require("./utils").color;
+const { readFileSync } = require("fs");
+
+/**
+ * @typedef {Object} Terminal
+ * @property {number} verbose
+ * @property {Object} levels
+ * @property {string} levels.info
+ * @property {string} levels.fail
+ * @property {string} levels.pass
+ * @property {function(string, number): void} start
+ * @property {function(string): void} pass
+ * @property {function(string): void} log
+ * @property {function(): void} setup
+ * @property {function(): void} clear
+ * @property {function(number): void} setVerbose
+ * @property {function(any): boolean} isError
+ * @property {Object} projectInfo
+ */
+
+/** @type {Terminal} */
+const terminal = {
+  verbose: 2,
+  levels: {
+    info: co("%H100  INFO:%H"),
+    fail: co("%H41  FAIL:%H"),
+    pass: co("%H42  PASS:%H"),
+  },
+};
+
+const { stdout } = process;
+
+terminal.projectInfo = (() => {
+  try {
+    const { name, version } = JSON.parse(
+      readFileSync("./package.json", "utf-8")
+    );
+
+    return { name, version };
+  } catch (error) {
+    return { name: "unknown", version: "unknown" };
+  }
+})();
+
+/**
+ *  display the project info and the port
+ *
+ * @param {string} host - The host to display
+ * @param {number} port - The port number to display
+ */
+terminal.start = function start(host, port) {
+  const projectInfo = terminal.projectInfo;
+  const hostInfo = formatUrl(host, port);
+
+  const headLines = [
+    `\n%H46  name:%H%H44  ${projectInfo.name} `,
+    `%H105  version:%H%H41  ${projectInfo.version} %H\n`,
+    hostInfo?.url ? `%H43  host:%H95  ${hostInfo.url}\n` : "",
+    hostInfo?.port ? `%H45  port:%H94  ${hostInfo.port}\n` : "",
+  ];
+
+  for (const line of headLines) {
+    stdout.write(co(line));
+  }
+};
+
+/**
+ *  display the online message
+ *
+ * @param {string} data
+ */
+terminal.pass = function pass(data) {
+  terminal.clear();
+  stdout.write(co(`\r%H1 ${terminal.levels.pass}%H ${data}\n`));
+};
+
+/**
+ *  display logs messages
+ *
+ * @param {string} data
+ */
+terminal.log = function log(data) {
+  const { verbose, levels } = terminal;
+
+  let level = levels.info;
+
+  if (Number(verbose) === 0) return;
+
+  if (terminal.isError(data)) {
+    level = levels.fail;
+  }
+
+  if (Number(verbose) === 1 && stdout.isTTY) {
+    terminal.clear();
+
+    stdout.write(co(`\r%H1 ${level}%H ${data}`));
+  } else {
+    stdout.write(co(`%H1 ${level}%H `));
+
+    if (level === terminal.levels.info) {
+      if (typeof data === "object") {
+        // skipcq: JS-0002
+        console.log(data);
+      } else {
+        stdout.write(`${co(data)}\n`);
+      }
+    } else {
+      // skipcq: JS-0002
+      console.log(data);
+    }
+  }
+};
+
+/**
+ * Check if the data is an error
+ *
+ * @param {any} data
+ * @returns {boolean}
+ */
+terminal.isError = (data) => {
+  if (data instanceof Error) {
+    return true;
+  }
+
+  if (typeof data === "string") {
+    const errorKeywords = getErrorNames().map((name) => `Error: ${name}`);
+    errorKeywords.push("Error:");
+
+    return errorKeywords.some((keyword) => data.includes(keyword));
+  }
+
+  return false;
+};
+
+/**
+ * Setup the console.error to use the terminal.log function
+ *
+ * @returns {boolean} - true if the setup was successful, false otherwise
+ */
+terminal.setup = () => {
+  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
+};
+
+/**
+ * Clear the terminal
+ */
+terminal.clear = () => {
+  if (stdout.isTTY) {
+    stdout.clearLine();
+    return true
+  }
+
+  return false
+};
+
+/**
+ * Set the verbose level
+ *
+ * @param {number} verbose - The verbose level
+ */
+terminal.setVerbose = (verbose) => {
+  terminal.verbose = verbose;
+};
+
+module.exports = terminal;

package/{utils.js → lib/utils.js}

@@ -1,3 +1,11 @@
+/*!
+ * Terminal
+ * Copyright (c) 2024 @GuriTso
+ * @license GPL-3.0
+ */
+
+const { URL } = require("url");
+
 /**
  * This function is used to colorize the text
  * @param {string} txt - The text to colorize
@@ -6,7 +14,7 @@
  * color("Hello %H1 World") // "Hello \x1b[1mWorld\x1b[0m"
  * color("%h1 start here%H nothing here") // "\x1b[1m start here\x1b[0m nothing here"
  */
-export const color = (txt) => {
+function color(txt) {
   if (typeof txt !== "string") return txt;
 
   const arr = txt.split("%H");
@@ -29,7 +37,7 @@ export const color = (txt) => {
  *
  * @returns {string[]}
  */
-export const getErrorNames = () => {
+function getErrorNames() {
   return Object.getOwnPropertyNames(global).filter((name) => {
     try {
       return (
@@ -49,7 +57,7 @@ export const getErrorNames = () => {
  * @param {number} port - The port to format.
  * @returns {string} - The formatted URL.
  */
-export const formatUrl = (host, port) => {
+function formatUrl(host, port) {
   const locals = ["localhost", "127.0.0.1", "0.0.0.0"];
 
   try {
@@ -78,3 +86,8 @@ export const formatUrl = (host, port) => {
     }
   }
 };
+
+exports.color = color;
+exports.getErrorNames = getErrorNames;
+exports.formatUrl = formatUrl;
+

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@guritso/terminal",
   "description": "A terminal node utility for logging and error handling",
-  "version": "1.0.5",
-  "type": "module",
-  "main": "index.js",
+  "version": "1.1.0",
+  "main": "index.cjs",
+  "module": "index.js",
   "license": "GPL-3.0",
   "scripts": {
-    "test": "node --experimental-vm-modules node_modules/jest/bin/jest.js"
+    "test": "jest"
   },
   "repository": {
     "type": "git",
@@ -24,9 +24,9 @@
     "jest": "^29.7.0"
   },
   "directories": {
+    "lib": "lib",
     "test": "tests"
   },
-  "types": "./index.d.ts",
   "bugs": {
     "url": "https://github.com/guritso/terminal/issues"
   },

package/tests/terminal.test.js

@@ -1,11 +1,8 @@
-import { jest } from "@jest/globals";
-
-import terminal from "../index.js";
+const terminal = require("../index.js");
 
 describe("Terminal Module", () => {
   beforeEach(() => {
     jest.resetAllMocks();
-    terminal.setup();
   });
 
   describe("start", () => {
@@ -29,7 +26,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 +51,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 +62,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 +103,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/index.d.ts

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

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);