@guritso/terminal 1.2.1 → 1.2.2

package/.github/workflows/node.js.yml

@@ -16,7 +16,7 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [18.x, 20.x, 22.x]
+        node-version: [20.x, 22.x, 24.x]
         # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
 
     steps:

package/.github/workflows/npm-publish.yml

@@ -14,10 +14,10 @@ jobs:
       - uses: actions/checkout@v4
       - uses: actions/setup-node@v4
         with:
-          node-version: 22.x
+          node-version: 24.x
       - run: npm ci
-      - run: npm test
       - run: npm run build --if-present
+      - run: npm test
 
   publish-npm:
     needs: build
@@ -29,9 +29,10 @@ jobs:
       - uses: actions/checkout@v4
       - uses: actions/setup-node@v4
         with:
-          node-version: 22.x
+          node-version: 24.x
           registry-url: https://registry.npmjs.org/
       - run: npm ci
+      - run: npm run build --if-present
       - run: npm publish --provenance --access public
         env:
           NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}

package/README.md

@@ -2,6 +2,9 @@
 
 A terminal node utility for enhanced logging and error handling.
 
+[![Node.js CI](https://github.com/guritso/terminal/actions/workflows/node.js.yml/badge.svg)](https://github.com/guritso/terminal/actions/workflows/node.js.yml)
+[![NPM Package](https://github.com/guritso/terminal/actions/workflows/npm-publish.yml/badge.svg)](https://github.com/guritso/terminal/actions/workflows/npm-publish.yml)
+
 | example |
 | ------- |
 | ![example](./docs/guritso-terminal-preview.png) |

package/index.cjs

@@ -1 +1 @@
-module.exports = require("./lib/cjs/terminal.cjs");
+module.exports = require("./lib/dist/terminal.cjs");

package/lib/terminal.js

@@ -1,6 +1,6 @@
 /*!
  * Terminal
- * Copyright (c) 2024 @GuriTso
+ * Copyright (c) 2024 @guritso
  * @license MIT
  */
 
@@ -8,6 +8,7 @@
 
 import { color as co, getErrorNames, formatUrl } from "./utils.js";
 import { readFileSync } from "fs";
+import { resolve } from "path";
 
 /**
  * @typedef {Object} Terminal
@@ -24,31 +25,20 @@ import { readFileSync } from "fs";
  * @property {function(number): void} setVerbose
  * @property {function(any): boolean} isError
  * @property {Object} projectInfo
+ * @property {function(string): void} loadProjectInfo
  */
-
-/** @type {Terminal} */
 const terminal = {
   verbose: 2,
-  levels: {
-    info: co("%H100  INFO %H"),
-    fail: co("%H41  FAIL %H"),
-    pass: co("%H42  PASS %H"),
-  },
+   levels: {
+     info: co("%H47  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" };
-  }
-})();
+terminal.projectInfo = { name: "unknown", version: "unknown" };
 
 /**
  *  display the project info and host, port
@@ -57,15 +47,18 @@ terminal.projectInfo = (() => {
  * @param {number} port - The port number to display
  */
 terminal.start = function start(host, port) {
+  if (terminal.projectInfo.name === "unknown") {
+    terminal.loadProjectInfo();
+  }
   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` : "",
-  ];
+   const headLines = [
+     `\n%H46  name:%H%H33  ${projectInfo.name}`,
+     `%H%H31  ${projectInfo.version} %H\n`,
+     hostInfo?.url ? `%H43  host:%H %H36 ${hostInfo.url}%H\n` : "",
+     hostInfo?.port ? `%H45  port:%H %H31 ${hostInfo.port}%H\n` : "",
+   ];
 
   for (const line of headLines) {
     stdout.write(co(line));
@@ -78,6 +71,8 @@ terminal.start = function start(host, port) {
  * @param {string} data
  */
 terminal.pass = function pass(data) {
+  if (data === null || data === undefined) return;
+
   const { verbose, levels } = terminal;
 
   if (verbose === 0) return;
@@ -125,6 +120,8 @@ terminal.log = function log(data) {
     }
   }
 };
+// cache
+let errorKeywords = []
 
 /**
  * Check if the data is an error
@@ -138,8 +135,10 @@ terminal.isError = (data) => {
   }
 
   if (typeof data === "string") {
-    const errorKeywords = getErrorNames().map((name) => name);
-    errorKeywords.push("Error:");
+    if (!errorKeywords.length) {
+      errorKeywords = getErrorNames().map((name) => name);
+      errorKeywords.push("Error:");
+    }
 
     return errorKeywords.some((keyword) => data.includes(keyword));
   }
@@ -201,4 +200,35 @@ terminal.setVerbose = (verbose) => {
   }
 };
 
+/**
+ * Restore terminal.log function
+ * @return {boolean} if true = sucess
+ */
+terminal.teardown = () => {
+  if (console.backup) {
+    console.error = console.backup;
+    delete console.backup;
+    return true;
+  }
+  return false;
+};
+
+/**
+ * Load project info from package.json
+ * @param {string} [pkgPath] - Optional path to package.json
+ */
+terminal.loadProjectInfo = (pkgPath) => {
+  try {
+    const path = pkgPath || resolve(process.cwd(), "package.json");
+    const pkgData = JSON.parse(readFileSync(path, "utf-8"));
+
+    terminal.projectInfo = {
+      name: pkgData.name || "unknown",
+      version: pkgData.version || "unknown"
+    };
+  } catch (error) {
+    terminal.projectInfo = { name: "unknown", version: "unknown" };
+  }
+};
+
 export default terminal;

package/lib/utils.js

@@ -1,6 +1,6 @@
 /*!
  * Terminal
- * Copyright (c) 2024 @GuriTso
+ * Copyright (c) 2024 @guritso
  * @license MIT
  */
 
@@ -25,7 +25,14 @@ function color(txt) {
 
     if (!n || !txt.includes(`%H${n}`) || isNaN(n)) continue;
 
-    const mo = `\x1b[${n}m${w.join(" ")}\x1b[0m`;
+    let code = n;
+    if (n >= 40 && n <= 47) {
+      code = `90;${n}`;
+    } else if (n >= 100 && n <= 107) {
+      code = `97;${n}`;
+    }
+
+    const mo = `\x1b[${code}m${w.join(" ")}\x1b[0m`;
 
     res = res.replace(a, mo);
   }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@guritso/terminal",
   "description": "A terminal node utility for enhanced logging and error handling",
-  "version": "1.2.1",
+  "version": "1.2.2",
   "main": "index.cjs",
   "module": "index.js",
   "types": "index.d.ts",
@@ -29,10 +29,10 @@
     "utility",
     "backend"
   ],
-  "author": "GuriTso",
+  "author": "guritso",
   "devDependencies": {
-    "jest": "^29.7.0",
-    "rollup": "^4.38.0"
+    "jest": "^30.2.0",
+    "rollup": "^4.55.3"
   },
   "directories": {
     "lib": "lib",

package/rollup.config.js

@@ -1,8 +1,8 @@
 export default {
   input: 'lib/terminal.js',
   output: {
-    file: 'lib/cjs/terminal.cjs',
+    file: 'lib/dist/terminal.cjs',
     format: 'cjs',
   },
-  external: ['fs', 'url']
+  external: ['fs', 'url', 'path']
 };

package/lib/cjs/terminal.cjs

@@ -1,291 +0,0 @@
-'use strict';
-
-var url = require('url');
-var fs = require('fs');
-
-/*!
- * Terminal
- * Copyright (c) 2024 @GuriTso
- * @license MIT
- */
-
-
-/**
- * This function is used to colorize the text
- * @param {string} txt - The text to colorize
- * @returns {string | any} - The colorized text
- * @example
- * color("Hello %H1 World") // "Hello \x1b[1mWorld\x1b[0m"
- * color("%h1 start here%H nothing here") // "\x1b[1m start here\x1b[0m nothing here"
- */
-function color(txt) {
-  if (typeof txt !== "string") return txt;
-
-  const arr = txt.split("%H");
-  let res = arr.join("");
-
-  for (const a of arr) {
-    const [n, ...w] = a.split(" ");
-
-    if (!n || !txt.includes(`%H${n}`) || isNaN(n)) continue;
-
-    const mo = `\x1b[${n}m${w.join(" ")}\x1b[0m`;
-
-    res = res.replace(a, mo);
-  }
-  return res;
-}
-/**
- * Get a list of common error names
- *
- * @returns {string[]}
- */
-function getErrorNames() {
-  return Object.getOwnPropertyNames(global).filter((name) => {
-    try {
-      return (
-        typeof global[name] === "function" &&
-        global[name].prototype instanceof Error
-      );
-    } catch (e) {
-      return false;
-    }
-  });
-}
-/**
- * Format the URL based on the provided host and port.
- *
- * @param {string} host - The host to format.
- * @param {number} port - The port to format.
- * @returns {string} - The formatted URL.
- */
-function formatUrl(host, port) {
-  const locals = ["localhost", "127.0.0.1", "0.0.0.0"];
-
-  try {
-    if (typeof host !== "string") {
-      return new Error("host must be a string");
-    }
-
-    const url$1 = new url.URL(host);
-
-    if (port && port !== url$1.port) {
-      url$1.port = port;
-    }
-
-    if (!url$1.protocol) {
-      url$1.protocol = "http:";
-    } else if (url$1.protocol !== "https:" && url$1.protocol !== "http:") {
-      url$1.protocol = "http:";
-    }
-
-    return { url: url$1.toString(), port: url$1.port };
-  } catch (error) {
-    if (locals.includes(host)) {
-      return formatUrl("http://localhost", port);
-    } else {
-      return error;
-    }
-  }
-}
-
-/*!
- * Terminal
- * Copyright (c) 2024 @GuriTso
- * @license MIT
- */
-
-
-/**
- * @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: color("%H100  INFO %H"),
-    fail: color("%H41  FAIL %H"),
-    pass: color("%H42  PASS %H"),
-  },
-};
-
-const { stdout } = process;
-
-terminal.projectInfo = (() => {
-  try {
-    const { name, version } = JSON.parse(
-      fs.readFileSync("./package.json", "utf-8")
-    );
-
-    return { name, version };
-  } catch (error) {
-    return { name: "unknown", version: "unknown" };
-  }
-})();
-
-/**
- *  display the project info and host, 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(color(line));
-  }
-};
-
-/**
- *  display successful messages
- *
- * @param {string} data
- */
-terminal.pass = function pass(data) {
-  const { verbose, levels } = terminal;
-
-  if (verbose === 0) return;
-
-  if (typeof data === "object") {
-    // skipcq: JS-0002
-    console.log(color(`\r%H1 ${levels.pass}%H`), data);
-  } else {
-    terminal.clear();
-    stdout.write(color(`\r%H1 ${levels.pass}%H ${String(data)}\n`));
-  }
-};
-
-/**
- *  display logs messages, error, info, etc.
- *
- * @param {any} data
- */
-terminal.log = function log(data) {
-  const { verbose, levels } = terminal;
-
-  let level = levels.info;
-
-  if (verbose === 0) return;
-
-  if (terminal.isError(data)) {
-    level = levels.fail;
-  }
-
-  if (verbose === 1 && stdout.isTTY) {
-    terminal.clear();
-
-    stdout.write(color(`\r%H1 ${level}%H ${String(data)}`));
-  } else {
-    if (level === terminal.levels.info) {
-      if (typeof data === "object") {
-        // skipcq: JS-0002
-        console.log(color(`%H1 ${level}%H`), data);
-      } else {
-        stdout.write(color(`%H1 ${level}%H ${String(data)}\n`));
-      }
-    } else {
-      // skipcq: JS-0002
-      console.log(color(`%H1 ${level}%H`), 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) => 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) => {
-  if (!isNaN(Number(verbose))) {
-    const verboseLevel = Number(verbose);
-
-    if (verboseLevel < 0) {
-      terminal.verbose = 0;
-    } else if (verboseLevel > 2) {
-      terminal.verbose = 2;
-    } else {
-      terminal.verbose = verboseLevel;
-    }
-  }
-};
-
-module.exports = terminal;