@guritso/terminal 1.2.1 → 1.2.3

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/{cjs → dist}/terminal.cjs

@@ -2,10 +2,11 @@
 
 var url = require('url');
 var fs = require('fs');
+var path = require('path');
 
 /*!
  * Terminal
- * Copyright (c) 2024 @GuriTso
+ * Copyright (c) 2024 @guritso
  * @license MIT
  */
 
@@ -29,7 +30,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);
   }
@@ -91,7 +99,7 @@ function formatUrl(host, port) {
 
 /*!
  * Terminal
- * Copyright (c) 2024 @GuriTso
+ * Copyright (c) 2024 @guritso
  * @license MIT
  */
 
@@ -111,31 +119,20 @@ function formatUrl(host, port) {
  * @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: color("%H100  INFO %H"),
-    fail: color("%H41  FAIL %H"),
-    pass: color("%H42  PASS %H"),
-  },
+   levels: {
+     info: color("%H47  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" };
-  }
-})();
+terminal.projectInfo = { name: "unknown", version: "unknown" };
 
 /**
  *  display the project info and host, port
@@ -144,15 +141,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(color(line));
@@ -165,6 +165,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;
@@ -212,6 +214,8 @@ terminal.log = function log(data) {
     }
   }
 };
+// cache
+let errorKeywords = [];
 
 /**
  * Check if the data is an error
@@ -225,8 +229,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));
   }
@@ -288,4 +294,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$1 = pkgPath || path.resolve(process.cwd(), "package.json");
+    const pkgData = JSON.parse(fs.readFileSync(path$1, "utf-8"));
+
+    terminal.projectInfo = {
+      name: pkgData.name || "unknown",
+      version: pkgData.version || "unknown"
+    };
+  } catch (error) {
+    terminal.projectInfo = { name: "unknown", version: "unknown" };
+  }
+};
+
 module.exports = terminal;

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.3",
   "main": "index.cjs",
   "module": "index.js",
   "types": "index.d.ts",
@@ -29,17 +29,21 @@
     "utility",
     "backend"
   ],
-  "author": "GuriTso",
+  "author": "guritso",
   "devDependencies": {
-    "jest": "^29.7.0",
-    "rollup": "^4.38.0"
-  },
-  "directories": {
-    "lib": "lib",
-    "test": "tests"
+    "jest": "^30.2.0",
+    "rollup": "^4.55.3"
   },
+  "files": [
+    "index.js",
+    "index.cjs",
+    "index.d.ts",
+    "lib/",
+    "README.md",
+    "LICENSE"
+  ],
   "bugs": {
     "url": "https://github.com/guritso/terminal/issues"
   },
   "homepage": "https://github.com/guritso/terminal#readme"
-}
+}

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

@@ -1,31 +0,0 @@
-# This workflow will do a clean installation of node dependencies, cache/restore them, build the source code and run tests across different versions of node
-# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-nodejs
-
-name: Node.js CI
-
-on:
-  push:
-    branches: [ "main" ]
-  pull_request:
-    branches: [ "main" ]
-
-jobs:
-  build:
-
-    runs-on: ubuntu-latest
-
-    strategy:
-      matrix:
-        node-version: [18.x, 20.x, 22.x]
-        # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
-
-    steps:
-    - uses: actions/checkout@v4
-    - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v4
-      with:
-        node-version: ${{ matrix.node-version }}
-        cache: 'npm'
-    - run: npm ci
-    - run: npm run build --if-present
-    - run: npm test

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

@@ -1,37 +0,0 @@
-# This workflow will run tests using node and then publish a package to GitHub Packages when a release is created
-# For more information see: https://docs.github.com/en/actions/publishing-packages/publishing-nodejs-packages
-
-name: Node.js Package
-
-on:
-  release:
-    types: [created]
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-node@v4
-        with:
-          node-version: 22.x
-      - run: npm ci
-      - run: npm test
-      - run: npm run build --if-present
-
-  publish-npm:
-    needs: build
-    runs-on: ubuntu-latest
-    permissions:
-      contents: read
-      id-token: write
-    steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-node@v4
-        with:
-          node-version: 22.x
-          registry-url: https://registry.npmjs.org/
-      - run: npm ci
-      - run: npm publish --provenance --access public
-        env:
-          NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}

package/rollup.config.js

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

package/tests/terminal.test.js

@@ -1,215 +0,0 @@
-const terminal = require("../index.cjs");
-
-const levels = terminal.levels;
-
-describe("Terminal Module", () => {
-  beforeEach(() => {
-    jest.resetAllMocks();
-  });
-
-  describe("start", () => {
-    it("should write project information and port to stdout", () => {
-      const mockWrite = jest
-        .spyOn(process.stdout, "write")
-        .mockImplementation(() => true);
-      terminal.projectInfo = { name: "test-project", version: "1.0.0" };
-
-      terminal.start("localhost", 3000);
-
-      expect(mockWrite).toHaveBeenCalled();
-      mockWrite.mockRestore();
-    });
-  });
-
-  describe("pass", () => {
-    it("should write success message to stdout", () => {
-      const mockWrite = jest
-        .spyOn(process.stdout, "write")
-        .mockImplementation(() => true);
-      terminal.pass("Operation successful");
-
-      expect(mockWrite).toHaveBeenCalledWith(expect.stringContaining("PASS"));
-      mockWrite.mockRestore();
-    });
-
-    it("should use console.log instead of stdout.write when verbose is 2 and msg is an object", () => {
-      terminal.setVerbose(2);
-      const mockLog = jest.spyOn(console, "log").mockImplementation(() => true);
-      const mockWrite = jest
-        .spyOn(process.stdout, "write")
-        .mockImplementation(() => true);
-
-      const message = { key: "value" };
-      terminal.pass(message);
-
-      expect(mockLog).toHaveBeenCalledWith(expect.stringContaining(levels.pass), message);
-      expect(mockWrite).not.toHaveBeenCalled();
-
-      mockLog.mockRestore();
-      mockWrite.mockRestore();
-    });
-  });
-
-  describe("log", () => {
-    it("should do nothing if verbose is 0", () => {
-      terminal.setVerbose(0);
-      const mockWrite = jest
-        .spyOn(process.stdout, "write")
-        .mockImplementation(() => true);
-
-      terminal.log("This is a log message");
-      terminal.pass("This is a pass message");
-      expect(mockWrite).not.toHaveBeenCalled();
-
-      mockWrite.mockRestore();
-    });
-
-    it("should write info message to stdout when verbose is 2 and msg is a string", () => {
-      terminal.setVerbose(2);
-      const mockWrite = jest
-        .spyOn(process.stdout, "write")
-        .mockImplementation(() => true);
-
-      terminal.log("Info message");
-      expect(mockWrite).toHaveBeenCalledWith(expect.stringContaining("INFO"));
-      mockWrite.mockRestore();
-    });
-
-    it("should use console.log instead of stdout.write when verbose is 2 and msg is an error string", () => {
-      terminal.setVerbose(2);
-      const mockLog = jest.spyOn(console, "log").mockImplementation(() => true);
-      const mockWrite = jest
-        .spyOn(process.stdout, "write")
-        .mockImplementation(() => true);
-
-      const errorMessage = "Error: Something went wrong";
-
-      terminal.log(errorMessage);
-
-      expect(mockLog).toHaveBeenCalledWith(expect.stringContaining(levels.fail), errorMessage);
-      expect(mockWrite).not.toHaveBeenCalled();
-
-      mockLog.mockRestore();
-      mockWrite.mockRestore();
-    });
-
-    it("should use console.log instead of stdout.write when verbose is 2 and msg is an object", () => {
-      terminal.setVerbose(2);
-      const mockLog = jest.spyOn(console, "log").mockImplementation(() => true);
-      const mockWrite = jest
-        .spyOn(process.stdout, "write")
-        .mockImplementation(() => true);
-
-      const message = { key: "value" };
-      terminal.log(message);
-
-      expect(mockLog).toHaveBeenCalledWith(expect.stringContaining(levels.info), message);
-      expect(mockWrite).not.toHaveBeenCalled();
-
-      mockLog.mockRestore();
-      mockWrite.mockRestore();
-    });
-  });
-
-  describe("isError", () => {
-    it("should return true if the data is an instance of Error", () => {
-      const error = new Error("Test error");
-      expect(terminal.isError(error)).toBe(true);
-    });
-
-    it("should return true if the string contains an error keyword", () => {
-      expect(terminal.isError("Error: Test error")).toBe(true);
-    });
-
-    it("should return false for data that is not an error", () => {
-      expect(terminal.isError("This is a message")).toBe(false);
-      expect(terminal.isError({})).toBe(false);
-      expect(terminal.isError(123)).toBe(false);
-    });
-  });
-
-  describe("setup", () => {
-    it("should replace console.error with terminal.log", () => {
-      const originalError = console.error;
-      terminal.setup();
-
-      expect(console.error).toBe(terminal.log);
-
-      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", () => {
-    it("should call stdout.clearLine if stdout is TTY", () => {
-      const originalIsTTY = process.stdout.isTTY;
-      process.stdout.isTTY = true;
-
-      if (!process.stdout.clearLine) {
-        process.stdout.clearLine = jest.fn();
-      }
-
-      const mockClearLine = jest
-        .spyOn(process.stdout, "clearLine")
-        .mockImplementation(() => true);
-      terminal.clear();
-      expect(mockClearLine).toHaveBeenCalled();
-
-      mockClearLine.mockRestore();
-      process.stdout.isTTY = originalIsTTY;
-      delete process.stdout.clearLine;
-    });
-
-    it("should not call stdout.clearLine if stdout is not TTY", () => {
-      const originalIsTTY = process.stdout.isTTY;
-      process.stdout.isTTY = false;
-
-      process.stdout.clearLine = jest.fn();
-
-      const mockClearLine = jest.spyOn(process.stdout, "clearLine");
-
-      terminal.clear();
-      expect(mockClearLine).not.toHaveBeenCalled();
-
-      mockClearLine.mockRestore();
-      process.stdout.isTTY = originalIsTTY;
-      delete process.stdout.clearLine;
-    });
-  });
-
-  describe("setVerbose", () => {
-    it("should update the verbose level", () => {
-      terminal.setVerbose(1);
-      expect(terminal.verbose).toBe(1);
-    });
-  });
-});