@tomjs/logger 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024-PRESENT Tom Gao<tom@tomgao.cc>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,25 @@
+# @tomjs/logger
+
+[![npm](https://img.shields.io/npm/v/@tomjs/logger)](https://www.npmjs.com/package/@tomjs/logger) ![node-current (scoped)](https://img.shields.io/logger/v/@tomjs/logger) ![NPM](https://img.shields.io/npm/l/@tomjs/logger) [![Docs](https://www.paka.dev/badges/v0/cute.svg)](https://www.paka.dev/npm/@tomjs/logger)
+
+**English** | [中文](./README.zh_CN.md)
+
+> logger for [tomjs](https://github.com/tomjs)
+
+## Install
+
+```bash
+# pnpm
+pnpm add @tomjs/logger
+
+# yarn
+yarn add @tomjs/logger
+
+# npm
+npm i @tomjs/logger
+```
+
+## Documentation
+
+- [API Documentation](https://paka.dev/npm/@tomjs/logger) provided by [paka.dev](https://paka.dev).
+- [index.d.ts](https://www.unpkg.com/browse/@tomjs/logger/dist/index.d.ts) provided by [unpkg.com](https://www.unpkg.com).

package/README.zh_CN.md

@@ -0,0 +1,25 @@
+# @tomjs/logger
+
+[![npm](https://img.shields.io/npm/v/@tomjs/logger)](https://www.npmjs.com/package/@tomjs/logger) ![node-current (scoped)](https://img.shields.io/logger/v/@tomjs/logger) ![NPM](https://img.shields.io/npm/l/@tomjs/logger) [![Docs](https://www.paka.dev/badges/v0/cute.svg)](https://www.paka.dev/npm/@tomjs/logger)
+
+[English](./README.md) | **中文**
+
+> [tomjs](https://github.com/tomjs) 的日志库
+
+## 安装
+
+```bash
+# pnpm
+pnpm add @tomjs/logger
+
+# yarn
+yarn add @tomjs/logger
+
+# npm
+npm i @tomjs/logger
+```
+
+## 文档
+
+- [paka.dev](https://paka.dev) 提供的 [API文档](https://paka.dev/npm/@tomjs/logger).
+- [unpkg.com](https://www.unpkg.com/) 提供的 [index.d.ts](https://www.unpkg.com/browse/@tomjs/logger/dist/index.d.ts).

package/dist/index.d.mts

@@ -0,0 +1,75 @@
+/**
+ * log tool
+ */
+declare class Logger {
+    private _opts;
+    private _logDir?;
+    private _debug;
+    constructor(opts?: LoggerOptions);
+    private initLogDir;
+    private format;
+    private _writeLog;
+    private _log;
+    /**
+     * set debug mode or not
+     */
+    enableDebug(debug: boolean): void;
+    /**
+     * like console.log
+     */
+    log(...args: any[]): void;
+    /**
+     * write log to file
+     */
+    write(...args: any[]): void;
+    /**
+     * only show in debug mode
+     */
+    debug(...args: any[]): void;
+    /**
+     * add the specified red prefix or error symbol before the log content
+     */
+    error(...args: any[]): void;
+    /**
+     * add the specified blue prefix or info symbol before the log content
+     */
+    info(...args: any[]): void;
+    /**
+     * add the specified green prefix or success symbol before the log content
+     */
+    success(...args: any[]): void;
+    /**
+     * add the specified yellow prefix or warning symbol before the log content
+     */
+    warning(...args: any[]): void;
+}
+export { Logger }
+export default Logger;
+
+export declare interface LoggerOptions {
+    /**
+     * log prefix
+     */
+    prefix?: string;
+    /**
+     * enable debug mode
+     * @default false
+     */
+    debug?: boolean;
+    /**
+     * show time in log
+     * @default false
+     */
+    time?: boolean;
+    /**
+     * specify the log directory name
+     */
+    directory?: string;
+    /**
+     * specify the log cleanup period
+     * @default 30
+     */
+    cleanup?: number;
+}
+
+export { }

package/dist/index.d.ts

@@ -0,0 +1,75 @@
+/**
+ * log tool
+ */
+declare class Logger {
+    private _opts;
+    private _logDir?;
+    private _debug;
+    constructor(opts?: LoggerOptions);
+    private initLogDir;
+    private format;
+    private _writeLog;
+    private _log;
+    /**
+     * set debug mode or not
+     */
+    enableDebug(debug: boolean): void;
+    /**
+     * like console.log
+     */
+    log(...args: any[]): void;
+    /**
+     * write log to file
+     */
+    write(...args: any[]): void;
+    /**
+     * only show in debug mode
+     */
+    debug(...args: any[]): void;
+    /**
+     * add the specified red prefix or error symbol before the log content
+     */
+    error(...args: any[]): void;
+    /**
+     * add the specified blue prefix or info symbol before the log content
+     */
+    info(...args: any[]): void;
+    /**
+     * add the specified green prefix or success symbol before the log content
+     */
+    success(...args: any[]): void;
+    /**
+     * add the specified yellow prefix or warning symbol before the log content
+     */
+    warning(...args: any[]): void;
+}
+export { Logger }
+export default Logger;
+
+export declare interface LoggerOptions {
+    /**
+     * log prefix
+     */
+    prefix?: string;
+    /**
+     * enable debug mode
+     * @default false
+     */
+    debug?: boolean;
+    /**
+     * show time in log
+     * @default false
+     */
+    time?: boolean;
+    /**
+     * specify the log directory name
+     */
+    directory?: string;
+    /**
+     * specify the log cleanup period
+     * @default 30
+     */
+    cleanup?: number;
+}
+
+export { }

package/dist/index.js

@@ -0,0 +1,120 @@
+"use strict";
+Object.defineProperties(exports, { __esModule: { value: true }, [Symbol.toStringTag]: { value: "Module" } });
+const fs = require("node:fs");
+const os = require("node:os");
+const path = require("node:path");
+const chalk = require("chalk");
+const dayjs = require("dayjs");
+const logSymbols = require("log-symbols");
+const stripAnsi = require("strip-ansi");
+class Logger {
+  constructor(opts) {
+    this._opts = {};
+    this._debug = false;
+    this._opts = Object.assign({}, opts);
+    this.initLogDir();
+  }
+  initLogDir() {
+    const { directory, cleanup } = this._opts;
+    if (!directory) {
+      return;
+    }
+    const logDir = path.join(os.homedir(), ".tomjs", directory);
+    this._logDir = logDir;
+    if (!fs.existsSync(logDir)) {
+      fs.mkdirSync(logDir, { recursive: true });
+    }
+    fs.readdirSync(logDir).forEach((s) => {
+      if (dayjs(s.substring(0, 8)).isBefore(
+        dayjs().endOf("day").subtract(Math.max(1, cleanup ?? 30), "day")
+      )) {
+        fs.rmSync(path.join(logDir, s), { force: true });
+      }
+    });
+  }
+  format(...args) {
+    return args.map((s) => typeof s === "object" ? JSON.stringify(s) : s || "").join(" ");
+  }
+  _writeLog(...args) {
+    if (!this._logDir) {
+      return;
+    }
+    const logFile = path.join(this._logDir, `${dayjs().format("YYYYMMDD")}.log`);
+    fs.appendFileSync(
+      logFile,
+      `${dayjs().format("YYYY-MM-DD HH:mm:ss.SSS")} ${stripAnsi(this.format(...args))}
+`
+    );
+  }
+  _log(...args) {
+    this._writeLog(...args);
+    let list = [...args];
+    if (this._opts.time) {
+      list = [dayjs().format("HH:mm:ss"), ...list];
+    }
+    console.log(list.map((s) => typeof s === "object" ? "%o" : "%s").join(" "), ...list);
+  }
+  /**
+   * set debug mode or not
+   */
+  enableDebug(debug) {
+    this._debug = debug ?? true;
+  }
+  /**
+   * like console.log
+   */
+  log(...args) {
+    this._log(...args);
+  }
+  /**
+   * write log to file
+   */
+  write(...args) {
+    this._writeLog(...args);
+  }
+  /**
+   * only show in debug mode
+   */
+  debug(...args) {
+    if (this._debug) {
+      this._log(
+        ...args.map((s) => {
+          if (typeof s !== "object") {
+            return chalk.gray(s);
+          }
+          return s;
+        })
+      );
+    }
+  }
+  /**
+   * add the specified red prefix or error symbol before the log content
+   */
+  error(...args) {
+    const { prefix } = this._opts;
+    this._log(prefix ? chalk.red(prefix) : logSymbols.error, ...args);
+  }
+  /**
+   * add the specified blue prefix or info symbol before the log content
+   */
+  info(...args) {
+    const { prefix } = this._opts;
+    this._log(prefix ? chalk.blue(prefix) : logSymbols.info, ...args);
+  }
+  /**
+   * add the specified green prefix or success symbol before the log content
+   */
+  success(...args) {
+    const { prefix } = this._opts;
+    this._log(prefix ? chalk.green(prefix) : logSymbols.success, ...args);
+  }
+  /**
+   * add the specified yellow prefix or warning symbol before the log content
+   */
+  warning(...args) {
+    const { prefix } = this._opts;
+    this._log(prefix ? chalk.yellow(prefix) : logSymbols.warning, ...args);
+  }
+}
+exports.Logger = Logger;
+exports.default = Logger;

package/dist/index.mjs

@@ -0,0 +1,120 @@
+import fs from "node:fs";
+import os from "node:os";
+import path from "node:path";
+import chalk from "chalk";
+import dayjs from "dayjs";
+import logSymbols from "log-symbols";
+import stripAnsi from "strip-ansi";
+class Logger {
+  constructor(opts) {
+    this._opts = {};
+    this._debug = false;
+    this._opts = Object.assign({}, opts);
+    this.initLogDir();
+  }
+  initLogDir() {
+    const { directory, cleanup } = this._opts;
+    if (!directory) {
+      return;
+    }
+    const logDir = path.join(os.homedir(), ".tomjs", directory);
+    this._logDir = logDir;
+    if (!fs.existsSync(logDir)) {
+      fs.mkdirSync(logDir, { recursive: true });
+    }
+    fs.readdirSync(logDir).forEach((s) => {
+      if (dayjs(s.substring(0, 8)).isBefore(
+        dayjs().endOf("day").subtract(Math.max(1, cleanup ?? 30), "day")
+      )) {
+        fs.rmSync(path.join(logDir, s), { force: true });
+      }
+    });
+  }
+  format(...args) {
+    return args.map((s) => typeof s === "object" ? JSON.stringify(s) : s || "").join(" ");
+  }
+  _writeLog(...args) {
+    if (!this._logDir) {
+      return;
+    }
+    const logFile = path.join(this._logDir, `${dayjs().format("YYYYMMDD")}.log`);
+    fs.appendFileSync(
+      logFile,
+      `${dayjs().format("YYYY-MM-DD HH:mm:ss.SSS")} ${stripAnsi(this.format(...args))}
+`
+    );
+  }
+  _log(...args) {
+    this._writeLog(...args);
+    let list = [...args];
+    if (this._opts.time) {
+      list = [dayjs().format("HH:mm:ss"), ...list];
+    }
+    console.log(list.map((s) => typeof s === "object" ? "%o" : "%s").join(" "), ...list);
+  }
+  /**
+   * set debug mode or not
+   */
+  enableDebug(debug) {
+    this._debug = debug ?? true;
+  }
+  /**
+   * like console.log
+   */
+  log(...args) {
+    this._log(...args);
+  }
+  /**
+   * write log to file
+   */
+  write(...args) {
+    this._writeLog(...args);
+  }
+  /**
+   * only show in debug mode
+   */
+  debug(...args) {
+    if (this._debug) {
+      this._log(
+        ...args.map((s) => {
+          if (typeof s !== "object") {
+            return chalk.gray(s);
+          }
+          return s;
+        })
+      );
+    }
+  }
+  /**
+   * add the specified red prefix or error symbol before the log content
+   */
+  error(...args) {
+    const { prefix } = this._opts;
+    this._log(prefix ? chalk.red(prefix) : logSymbols.error, ...args);
+  }
+  /**
+   * add the specified blue prefix or info symbol before the log content
+   */
+  info(...args) {
+    const { prefix } = this._opts;
+    this._log(prefix ? chalk.blue(prefix) : logSymbols.info, ...args);
+  }
+  /**
+   * add the specified green prefix or success symbol before the log content
+   */
+  success(...args) {
+    const { prefix } = this._opts;
+    this._log(prefix ? chalk.green(prefix) : logSymbols.success, ...args);
+  }
+  /**
+   * add the specified yellow prefix or warning symbol before the log content
+   */
+  warning(...args) {
+    const { prefix } = this._opts;
+    this._log(prefix ? chalk.yellow(prefix) : logSymbols.warning, ...args);
+  }
+}
+export {
+  Logger,
+  Logger as default
+};

package/package.json

@@ -0,0 +1,54 @@
+{
+  "name": "@tomjs/logger",
+  "version": "1.0.0",
+  "description": "logger for `node.js`",
+  "keywords": [
+    "node",
+    "utils"
+  ],
+  "author": {
+    "name": "Tom Gao",
+    "email": "tom@tomgao.cc"
+  },
+  "license": "MIT",
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "require": {
+        "default": "./dist/index.js",
+        "types": "./dist/index.d.ts"
+      },
+      "import": {
+        "default": "./dist/index.mjs",
+        "types": "./dist/index.d.mts"
+      }
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "engines": {
+    "node": ">=16"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/tomjs/utils.git",
+    "directory": "packages/logger"
+  },
+  "dependencies": {
+    "chalk": "^4.1.2",
+    "dayjs": "^1.11.11",
+    "log-symbols": "^4.1.0",
+    "strip-ansi": "^6.0.1"
+  },
+  "scripts": {
+    "build": "vite build",
+    "test": "vitest"
+  }
+}