@jeffchi/logger 1.0.0

package/lib/index.d.ts

@@ -0,0 +1,2 @@
+import { ILogger, ILogOptions } from './interface';
+export declare const loggerWithTags: (tags: string | string[], options?: ILogOptions) => ILogger;

package/lib/index.js

@@ -0,0 +1,42 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.loggerWithTags = void 0;
+const date_fns_1 = require("date-fns");
+const interface_1 = require("./interface");
+const utils_1 = require("./utils");
+const defOptions = {
+    date: true,
+    env: interface_1.LogMode.ALL,
+};
+const loggerWithTags = (tags, options) => {
+    if (!Array.isArray(tags)) {
+        tags = [tags];
+    }
+    const { env, ...mergedOptions } = { ...defOptions, ...(options || {}) };
+    const debug = (...rest) => {
+        const prefix = (0, utils_1.buildOutputPreffix)(tags, mergedOptions);
+        (0, utils_1.checkEnv)(env || interface_1.LogMode.ALL) && console.debug(prefix, ...rest);
+    };
+    const info = (...rest) => {
+        const prefix = (0, utils_1.buildOutputPreffix)(tags, mergedOptions);
+        (0, utils_1.checkEnv)(env || interface_1.LogMode.ALL) && console.info(prefix, ...rest);
+    };
+    const log = (...rest) => {
+        const prefix = (0, utils_1.buildOutputPreffix)(tags, mergedOptions);
+        (0, utils_1.checkEnv)(env || interface_1.LogMode.ALL) && console.log(...prefix, ...rest);
+        (0, utils_1.checkPlatform)().then((write) => write?.(`logs/${(0, date_fns_1.format)(Date.now(), 'yyyy-MM-dd')}.log`, [...prefix, ...rest.map(JSON.stringify), '\n'].join(' '), { flag: 'a' }, utils_1.noop));
+    };
+    const warn = (...rest) => {
+        const prefix = (0, utils_1.buildOutputPreffix)(tags, mergedOptions);
+        (0, utils_1.checkEnv)(env || interface_1.LogMode.ALL) && console.warn(prefix, ...rest);
+    };
+    const error = (msg) => {
+        const prefix = (0, utils_1.buildOutputPreffix)(tags, mergedOptions);
+        if ((0, utils_1.checkEnv)(env || interface_1.LogMode.ALL)) {
+            console.warn(prefix);
+            throw new Error(msg);
+        }
+    };
+    return { debug, info, log, warn, error };
+};
+exports.loggerWithTags = loggerWithTags;

package/lib/interface.d.ts

@@ -0,0 +1,32 @@
+/**
+ * 日志输出打印的模式
+ * @default LogMode.ALL
+ */
+export declare enum LogMode {
+    ALL = "all",
+    PRODUCTION = "production",
+    DEVELOPMENET = "development",
+    NONE = "none"
+}
+/** 日志输入配置选项 */
+export interface ILogOptions {
+    /**
+     * 是否支持输出时间戳及时间戳格式
+     *
+     * 字符串格式参见: https://github.com/date-fns/date-fns/blob/main/src/format/index.ts
+     * @default true - 'MMM dd, yyyy HH:mm:ss.SSS'
+     */
+    date?: boolean | string;
+    /**
+     * 日志输出条件,默认全部输出
+     * @default 'all'
+     */
+    env?: LogMode;
+}
+export interface ILogger {
+    debug: (...rest: any[]) => void;
+    info: (...rest: any[]) => void;
+    log: (...rest: any[]) => void;
+    warn: (...rest: any[]) => void;
+    error: (msg: string) => void;
+}

package/lib/interface.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LogMode = void 0;
+/**
+ * 日志输出打印的模式
+ * @default LogMode.ALL
+ */
+var LogMode;
+(function (LogMode) {
+    LogMode["ALL"] = "all";
+    LogMode["PRODUCTION"] = "production";
+    LogMode["DEVELOPMENET"] = "development";
+    LogMode["NONE"] = "none";
+})(LogMode = exports.LogMode || (exports.LogMode = {}));

package/lib/utils.d.ts

@@ -0,0 +1,8 @@
+/// <reference types="node" />
+import { ILogOptions, LogMode } from './interface';
+export declare const isUndefined: (v: any) => boolean;
+export declare const isString: (v: any) => boolean;
+export declare const buildOutputPreffix: (tags: string[], options: ILogOptions) => (string | Date)[];
+export declare const checkEnv: (env: LogMode) => boolean;
+export declare const checkPlatform: () => Promise<typeof import("fs").writeFile>;
+export declare const noop: () => undefined;

package/lib/utils.js

@@ -0,0 +1,57 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.noop = exports.checkPlatform = exports.checkEnv = exports.buildOutputPreffix = exports.isString = exports.isUndefined = void 0;
+const date_fns_1 = require("date-fns");
+const toString = (v) => Object.prototype.toString.call(v);
+const isUndefined = (v) => v === undefined;
+exports.isUndefined = isUndefined;
+const isString = (v) => typeof v === 'string' || toString(v) === '[object String]';
+exports.isString = isString;
+const buildOutputPreffix = (tags, options) => {
+    const prefix = [];
+    const { date } = options;
+    if (date) {
+        let now = new Date();
+        if ((0, exports.isString)(date)) {
+            now = (0, date_fns_1.format)(now, date);
+        }
+        prefix.unshift(now);
+    }
+    if (tags.length) {
+        prefix.unshift(tags.map((t) => `[${t.toUpperCase()}]`).join(' '));
+    }
+    return prefix;
+};
+exports.buildOutputPreffix = buildOutputPreffix;
+const checkEnv = (env) => (env === 'all' || process.env.NODE_ENV === env) && console !== undefined;
+exports.checkEnv = checkEnv;
+const checkPlatform = () => Promise.resolve().then(() => __importStar(require('fs'))).then((fs) => {
+    // fs.opendir('logs')
+    return fs?.writeFile;
+});
+exports.checkPlatform = checkPlatform;
+const noop = () => void 0;
+exports.noop = noop;

package/package.json

@@ -0,0 +1,54 @@
+{
+  "name": "@jeffchi/logger",
+  "version": "1.0.0",
+  "main": "dist/index.js",
+  "types": "lib/index.d.ts",
+  "description": "A log print output javascript tool library that can be used at the front and back ends",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/poechiang/jeffchi-logger.git"
+  },
+  "bugs": {
+    "url": "https://github.com/poechiang/jeffchi-logger/issues"
+  },
+  "homepage": "https://github.com/poechiang/jeffchi-logger#readme",
+  "keywords": [
+    "typescript",
+    "javascript",
+    "logger",
+    "log",
+    "warn",
+    "info",
+    "error",
+    "debug"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "prepare": "npm run build",
+    "format": "prettier --write \"src/**/*.ts\" \"src/**/*.js\"",
+    "lint": "tslint -p tsconfig.json",
+    "test": "jest --config jestconfig.json",
+    "prepublishOnly": "npm run test && npm run lint",
+    "preversion": "npm run lint",
+    "version": "npm run format && git add -A src",
+    "postversion": "git push && git push --tags"
+  },
+  "author": "jeffery·chiang",
+  "license": "MIT",
+  "files": [
+    "lib/**/*"
+  ],
+  "peerDependencies": {
+    "date-fns": "^2.29.3"
+  },
+  "devDependencies": {
+    "@types/jest": "^29.2.5",
+    "@types/node": "^18.11.18",
+    "jest": "^29.3.1",
+    "prettier": "^2.8.2",
+    "ts-jest": "^29.0.5",
+    "tslint": "^6.1.3",
+    "tslint-config-prettier": "^1.18.0",
+    "typescript": "^4.9.4"
+  }
+}