From 7cb4df775c21658650789f094575f7f796804278 Mon Sep 17 00:00:00 2001 From: Marcelo Oblan Date: Wed, 26 Oct 2022 21:02:28 +0800 Subject: [PATCH 1/4] update package details --- package.json | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/package.json b/package.json index c998c67..51e1ac7 100644 --- a/package.json +++ b/package.json @@ -3,11 +3,19 @@ "version": "1.0.0", "description": "Nodejs storage log", "main": "index.js", + "repository": { + "type": "git", + "url": "git+https://github.com/marcelooblan2016/mrx-plogger.git" + }, "scripts": { "test": "echo \"Error: no test specified\" && exit 1" }, "author": "marx", "license": "ISC", + "bugs": { + "url": "https://github.com/marcelooblan2016/mrx-plogger.git/issues" + }, + "homepage": "https://github.com/marcelooblan2016/mrx-plogger.git#readme", "dependencies": { "fs-extra": "^9.1.0", "moment": "^2.29.4" From 9c79742c742260a2febc5c29bf97da78ef7ff46c Mon Sep 17 00:00:00 2001 From: Marcelo Oblan Date: Wed, 26 Oct 2022 22:07:34 +0800 Subject: [PATCH 2/4] convert into typescript, test --- .gitignore | 3 +- dist/index.js | 68 +++++++++ index.js | 35 ----- package-lock.json | 341 +++++++++++++++++++++++++++++++++++++++++++++ package.json | 14 +- src/fs-extra.d.ts | 1 + src/global.d.ts | 6 + src/index.ts | 48 +++++++ src/moment.d.ts | 1 + test/storageLog.js | 10 ++ tsconfig.json | 18 +++ 11 files changed, 505 insertions(+), 40 deletions(-) create mode 100644 dist/index.js delete mode 100644 index.js create mode 100644 src/fs-extra.d.ts create mode 100644 src/global.d.ts create mode 100644 src/index.ts create mode 100644 src/moment.d.ts create mode 100644 test/storageLog.js create mode 100644 tsconfig.json diff --git a/.gitignore b/.gitignore index 40b878d..7be00e5 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,2 @@ -node_modules/ \ No newline at end of file +node_modules/ +test/*.log \ No newline at end of file diff --git a/dist/index.js b/dist/index.js new file mode 100644 index 0000000..387cc2c --- /dev/null +++ b/dist/index.js @@ -0,0 +1,68 @@ +"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; +}; +var __importDefault = (this && this.__importDefault) || function (mod) { + return (mod && mod.__esModule) ? mod : { "default": mod }; +}; +Object.defineProperty(exports, "__esModule", { value: true }); +exports.plogger = void 0; +const fs = __importStar(require("fs-extra")); +const moment_1 = __importDefault(require("moment")); +class plogger { + constructor(options) { + var _a; + this.logFileName = options.logFileName; + this.dateFormat = (_a = options.dateFormat) !== null && _a !== void 0 ? _a : `YYYY-MM-DD hh:mm:ssA`; + } + /** + * Write message to the log file with details + * Sample: [2022-10-05 11:03:44] local.INFO: YV4A22RL4M1768603 + * @param string message + * @param string prefix + * @return boolean + */ + log(message, prefix = 'INFO') { + try { + let content = [ + `[${(0, moment_1.default)().format(this.dateFormat)}]`, + `${prefix}:`, + typeof message == 'object' ? JSON.stringify(message) : message, + ].join(" "); + fs.appendFileSync(this.logFileName, `${content}\n`); + return true; + } + catch (error) { } + return false; + } + /** + * Shortcuts for: info, error, warning + * @param string message + * @param string prefix + * @return boolean + **/ + info(message, prefix = 'INFO') { return this.log(message, prefix); } + error(message, prefix = 'ERROR') { return this.log(message, prefix); } + warning(message, prefix = 'WARNING') { return this.log(message, prefix); } +} +exports.plogger = plogger; diff --git a/index.js b/index.js deleted file mode 100644 index 9ebd7e8..0000000 --- a/index.js +++ /dev/null @@ -1,35 +0,0 @@ -const fs = require('fs-extra'); -const { type } = require('jquery'); -const moment = require('moment'); - -class Plogger { - constructor (options) { - this.logFileName = options[`logFileName`]; - this.dateFormat = options[`dateFormat`] ?? `YYYY-MM-DD hh:mm:ssA`; - } - /** - * Write message to the log file with details - * Sample: [2022-10-05 11:03:44] local.INFO: YV4A22RL4M1768603 - * @param {*} message - * @param {*} prefix - * @return boolean - */ - log (message, prefix = 'INFO') { - try { - let content = [ - `[${moment().format(this.dateFormat)}]`, - `${prefix}:`, - typeof message == 'object' ? JSON.stringify(message) : message, - ].join(" "); - - fs.appendFileSync(this.logFileName, `${content}\n`); - return true; - } catch (error) { return false; } - } - - info (message, prefix = 'INFO') { return this.log(message, prefix); } - error (message, prefix = 'ERROR') { return this.log(message, prefix); } - warning (message, prefix = 'WARNING') { return this.log(message, prefix); } -} - -module.exports = Plogger; \ No newline at end of file diff --git a/package-lock.json b/package-lock.json index dd716dd..b771063 100644 --- a/package-lock.json +++ b/package-lock.json @@ -10,8 +10,114 @@ "dependencies": { "fs-extra": "^9.1.0", "moment": "^2.29.4" + }, + "devDependencies": { + "@types/lodash": "^4.14.178", + "ts-node": "^10.4.0", + "typescript": "^4.5.2" + } + }, + "node_modules/@cspotcode/source-map-support": { + "version": "0.8.1", + "resolved": "https://registry.npmjs.org/@cspotcode/source-map-support/-/source-map-support-0.8.1.tgz", + "integrity": "sha512-IchNf6dN4tHoMFIn/7OE8LWZ19Y6q/67Bmf6vnGREv8RSbBVb9LPJxEcnwrcwX6ixSvaiGoomAUvu4YSxXrVgw==", + "dev": true, + "dependencies": { + "@jridgewell/trace-mapping": "0.3.9" + }, + "engines": { + "node": ">=12" + } + }, + "node_modules/@jridgewell/resolve-uri": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/@jridgewell/resolve-uri/-/resolve-uri-3.1.0.tgz", + "integrity": "sha512-F2msla3tad+Mfht5cJq7LSXcdudKTWCVYUgw6pLFOOHSTtZlj6SWNYAp+AhuqLmWdBO2X5hPrLcu8cVP8fy28w==", + "dev": true, + "engines": { + "node": ">=6.0.0" + } + }, + "node_modules/@jridgewell/sourcemap-codec": { + "version": "1.4.14", + "resolved": "https://registry.npmjs.org/@jridgewell/sourcemap-codec/-/sourcemap-codec-1.4.14.tgz", + "integrity": "sha512-XPSJHWmi394fuUuzDnGz1wiKqWfo1yXecHQMRf2l6hztTO+nPru658AyDngaBe7isIxEkRsPR3FZh+s7iVa4Uw==", + "dev": true + }, + "node_modules/@jridgewell/trace-mapping": { + "version": "0.3.9", + "resolved": "https://registry.npmjs.org/@jridgewell/trace-mapping/-/trace-mapping-0.3.9.tgz", + "integrity": "sha512-3Belt6tdc8bPgAtbcmdtNJlirVoTmEb5e2gC94PnkwEW9jI6CAHUeoG85tjWP5WquqfavoMtMwiG4P926ZKKuQ==", + "dev": true, + "dependencies": { + "@jridgewell/resolve-uri": "^3.0.3", + "@jridgewell/sourcemap-codec": "^1.4.10" + } + }, + "node_modules/@tsconfig/node10": { + "version": "1.0.9", + "resolved": "https://registry.npmjs.org/@tsconfig/node10/-/node10-1.0.9.tgz", + "integrity": "sha512-jNsYVVxU8v5g43Erja32laIDHXeoNvFEpX33OK4d6hljo3jDhCBDhx5dhCCTMWUojscpAagGiRkBKxpdl9fxqA==", + "dev": true + }, + "node_modules/@tsconfig/node12": { + "version": "1.0.11", + "resolved": "https://registry.npmjs.org/@tsconfig/node12/-/node12-1.0.11.tgz", + "integrity": "sha512-cqefuRsh12pWyGsIoBKJA9luFu3mRxCA+ORZvA4ktLSzIuCUtWVxGIuXigEwO5/ywWFMZ2QEGKWvkZG1zDMTag==", + "dev": true + }, + "node_modules/@tsconfig/node14": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/@tsconfig/node14/-/node14-1.0.3.tgz", + "integrity": "sha512-ysT8mhdixWK6Hw3i1V2AeRqZ5WfXg1G43mqoYlM2nc6388Fq5jcXyr5mRsqViLx/GJYdoL0bfXD8nmF+Zn/Iow==", + "dev": true + }, + "node_modules/@tsconfig/node16": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/@tsconfig/node16/-/node16-1.0.3.tgz", + "integrity": "sha512-yOlFc+7UtL/89t2ZhjPvvB/DeAr3r+Dq58IgzsFkOAvVC6NMJXmCGjbptdXdR9qsX7pKcTL+s87FtYREi2dEEQ==", + "dev": true + }, + "node_modules/@types/lodash": { + "version": "4.14.186", + "resolved": "https://registry.npmjs.org/@types/lodash/-/lodash-4.14.186.tgz", + "integrity": "sha512-eHcVlLXP0c2FlMPm56ITode2AgLMSa6aJ05JTTbYbI+7EMkCEE5qk2E41d5g2lCVTqRe0GnnRFurmlCsDODrPw==", + "dev": true + }, + "node_modules/@types/node": { + "version": "18.11.6", + "resolved": "https://registry.npmjs.org/@types/node/-/node-18.11.6.tgz", + "integrity": "sha512-j3CEDa2vd96K0AXF8Wur7UucACvnjkk8hYyQAHhUNciabZLDl9nfAEVUSwmh245OOZV15bRA3Y590Gi5jUcDJg==", + "dev": true, + "peer": true + }, + "node_modules/acorn": { + "version": "8.8.1", + "resolved": "https://registry.npmjs.org/acorn/-/acorn-8.8.1.tgz", + "integrity": "sha512-7zFpHzhnqYKrkYdUjF1HI1bzd0VygEGX8lFk4k5zVMqHEoES+P+7TKI+EvLO9WVMJ8eekdO0aDEK044xTXwPPA==", + "dev": true, + "bin": { + "acorn": "bin/acorn" + }, + "engines": { + "node": ">=0.4.0" } }, + "node_modules/acorn-walk": { + "version": "8.2.0", + "resolved": "https://registry.npmjs.org/acorn-walk/-/acorn-walk-8.2.0.tgz", + "integrity": "sha512-k+iyHEuPgSw6SbuDpGQM+06HQUa04DZ3o+F6CSzXMvvI5KMvnaEqXe+YVe555R9nn6GPt404fos4wcgpw12SDA==", + "dev": true, + "engines": { + "node": ">=0.4.0" + } + }, + "node_modules/arg": { + "version": "4.1.3", + "resolved": "https://registry.npmjs.org/arg/-/arg-4.1.3.tgz", + "integrity": "sha512-58S9QDqG0Xx27YwPSt9fJxivjYl432YCwfDMfZ+71RAqUrZef7LrKQZ3LHLOwCS4FLNBplP533Zx895SeOCHvA==", + "dev": true + }, "node_modules/at-least-node": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/at-least-node/-/at-least-node-1.0.0.tgz", @@ -20,6 +126,21 @@ "node": ">= 4.0.0" } }, + "node_modules/create-require": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/create-require/-/create-require-1.1.1.tgz", + "integrity": "sha512-dcKFX3jn0MpIaXjisoRvexIJVEKzaq7z2rZKxf+MSr9TkdmHmsU4m2lcLojrj/FHl8mk5VxMmYA+ftRkP/3oKQ==", + "dev": true + }, + "node_modules/diff": { + "version": "4.0.2", + "resolved": "https://registry.npmjs.org/diff/-/diff-4.0.2.tgz", + "integrity": "sha512-58lmxKSA4BNyLz+HHMUzlOEpg09FV+ev6ZMe3vJihgdxzgcwZ8VoEEPmALCZG9LmqfVoNMMKpttIYTVG6uDY7A==", + "dev": true, + "engines": { + "node": ">=0.3.1" + } + }, "node_modules/fs-extra": { "version": "9.1.0", "resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-9.1.0.tgz", @@ -50,6 +171,12 @@ "graceful-fs": "^4.1.6" } }, + "node_modules/make-error": { + "version": "1.3.6", + "resolved": "https://registry.npmjs.org/make-error/-/make-error-1.3.6.tgz", + "integrity": "sha512-s8UhlNe7vPKomQhC1qFelMokr/Sc3AgNbso3n74mVPA5LTZwkB9NlXf4XPamLxJE8h0gh73rM94xvwRT2CVInw==", + "dev": true + }, "node_modules/moment": { "version": "2.29.4", "resolved": "https://registry.npmjs.org/moment/-/moment-2.29.4.tgz", @@ -58,6 +185,62 @@ "node": "*" } }, + "node_modules/ts-node": { + "version": "10.9.1", + "resolved": "https://registry.npmjs.org/ts-node/-/ts-node-10.9.1.tgz", + "integrity": "sha512-NtVysVPkxxrwFGUUxGYhfux8k78pQB3JqYBXlLRZgdGUqTO5wU/UyHop5p70iEbGhB7q5KmiZiU0Y3KlJrScEw==", + "dev": true, + "dependencies": { + "@cspotcode/source-map-support": "^0.8.0", + "@tsconfig/node10": "^1.0.7", + "@tsconfig/node12": "^1.0.7", + "@tsconfig/node14": "^1.0.0", + "@tsconfig/node16": "^1.0.2", + "acorn": "^8.4.1", + "acorn-walk": "^8.1.1", + "arg": "^4.1.0", + "create-require": "^1.1.0", + "diff": "^4.0.1", + "make-error": "^1.1.1", + "v8-compile-cache-lib": "^3.0.1", + "yn": "3.1.1" + }, + "bin": { + "ts-node": "dist/bin.js", + "ts-node-cwd": "dist/bin-cwd.js", + "ts-node-esm": "dist/bin-esm.js", + "ts-node-script": "dist/bin-script.js", + "ts-node-transpile-only": "dist/bin-transpile.js", + "ts-script": "dist/bin-script-deprecated.js" + }, + "peerDependencies": { + "@swc/core": ">=1.2.50", + "@swc/wasm": ">=1.2.50", + "@types/node": "*", + "typescript": ">=2.7" + }, + "peerDependenciesMeta": { + "@swc/core": { + "optional": true + }, + "@swc/wasm": { + "optional": true + } + } + }, + "node_modules/typescript": { + "version": "4.8.4", + "resolved": "https://registry.npmjs.org/typescript/-/typescript-4.8.4.tgz", + "integrity": "sha512-QCh+85mCy+h0IGff8r5XWzOVSbBO+KfeYrMQh7NJ58QujwcE22u+NUSmUxqF+un70P9GXKxa2HCNiTTMJknyjQ==", + "dev": true, + "bin": { + "tsc": "bin/tsc", + "tsserver": "bin/tsserver" + }, + "engines": { + "node": ">=4.2.0" + } + }, "node_modules/universalify": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/universalify/-/universalify-2.0.0.tgz", @@ -65,14 +248,127 @@ "engines": { "node": ">= 10.0.0" } + }, + "node_modules/v8-compile-cache-lib": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/v8-compile-cache-lib/-/v8-compile-cache-lib-3.0.1.tgz", + "integrity": "sha512-wa7YjyUGfNZngI/vtK0UHAN+lgDCxBPCylVXGp0zu59Fz5aiGtNXaq3DhIov063MorB+VfufLh3JlF2KdTK3xg==", + "dev": true + }, + "node_modules/yn": { + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/yn/-/yn-3.1.1.tgz", + "integrity": "sha512-Ux4ygGWsu2c7isFWe8Yu1YluJmqVhxqK2cLXNQA5AcC3QfbGNpM7fu0Y8b/z16pXLnFxZYvWhd3fhBY9DLmC6Q==", + "dev": true, + "engines": { + "node": ">=6" + } } }, "dependencies": { + "@cspotcode/source-map-support": { + "version": "0.8.1", + "resolved": "https://registry.npmjs.org/@cspotcode/source-map-support/-/source-map-support-0.8.1.tgz", + "integrity": "sha512-IchNf6dN4tHoMFIn/7OE8LWZ19Y6q/67Bmf6vnGREv8RSbBVb9LPJxEcnwrcwX6ixSvaiGoomAUvu4YSxXrVgw==", + "dev": true, + "requires": { + "@jridgewell/trace-mapping": "0.3.9" + } + }, + "@jridgewell/resolve-uri": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/@jridgewell/resolve-uri/-/resolve-uri-3.1.0.tgz", + "integrity": "sha512-F2msla3tad+Mfht5cJq7LSXcdudKTWCVYUgw6pLFOOHSTtZlj6SWNYAp+AhuqLmWdBO2X5hPrLcu8cVP8fy28w==", + "dev": true + }, + "@jridgewell/sourcemap-codec": { + "version": "1.4.14", + "resolved": "https://registry.npmjs.org/@jridgewell/sourcemap-codec/-/sourcemap-codec-1.4.14.tgz", + "integrity": "sha512-XPSJHWmi394fuUuzDnGz1wiKqWfo1yXecHQMRf2l6hztTO+nPru658AyDngaBe7isIxEkRsPR3FZh+s7iVa4Uw==", + "dev": true + }, + "@jridgewell/trace-mapping": { + "version": "0.3.9", + "resolved": "https://registry.npmjs.org/@jridgewell/trace-mapping/-/trace-mapping-0.3.9.tgz", + "integrity": "sha512-3Belt6tdc8bPgAtbcmdtNJlirVoTmEb5e2gC94PnkwEW9jI6CAHUeoG85tjWP5WquqfavoMtMwiG4P926ZKKuQ==", + "dev": true, + "requires": { + "@jridgewell/resolve-uri": "^3.0.3", + "@jridgewell/sourcemap-codec": "^1.4.10" + } + }, + "@tsconfig/node10": { + "version": "1.0.9", + "resolved": "https://registry.npmjs.org/@tsconfig/node10/-/node10-1.0.9.tgz", + "integrity": "sha512-jNsYVVxU8v5g43Erja32laIDHXeoNvFEpX33OK4d6hljo3jDhCBDhx5dhCCTMWUojscpAagGiRkBKxpdl9fxqA==", + "dev": true + }, + "@tsconfig/node12": { + "version": "1.0.11", + "resolved": "https://registry.npmjs.org/@tsconfig/node12/-/node12-1.0.11.tgz", + "integrity": "sha512-cqefuRsh12pWyGsIoBKJA9luFu3mRxCA+ORZvA4ktLSzIuCUtWVxGIuXigEwO5/ywWFMZ2QEGKWvkZG1zDMTag==", + "dev": true + }, + "@tsconfig/node14": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/@tsconfig/node14/-/node14-1.0.3.tgz", + "integrity": "sha512-ysT8mhdixWK6Hw3i1V2AeRqZ5WfXg1G43mqoYlM2nc6388Fq5jcXyr5mRsqViLx/GJYdoL0bfXD8nmF+Zn/Iow==", + "dev": true + }, + "@tsconfig/node16": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/@tsconfig/node16/-/node16-1.0.3.tgz", + "integrity": "sha512-yOlFc+7UtL/89t2ZhjPvvB/DeAr3r+Dq58IgzsFkOAvVC6NMJXmCGjbptdXdR9qsX7pKcTL+s87FtYREi2dEEQ==", + "dev": true + }, + "@types/lodash": { + "version": "4.14.186", + "resolved": "https://registry.npmjs.org/@types/lodash/-/lodash-4.14.186.tgz", + "integrity": "sha512-eHcVlLXP0c2FlMPm56ITode2AgLMSa6aJ05JTTbYbI+7EMkCEE5qk2E41d5g2lCVTqRe0GnnRFurmlCsDODrPw==", + "dev": true + }, + "@types/node": { + "version": "18.11.6", + "resolved": "https://registry.npmjs.org/@types/node/-/node-18.11.6.tgz", + "integrity": "sha512-j3CEDa2vd96K0AXF8Wur7UucACvnjkk8hYyQAHhUNciabZLDl9nfAEVUSwmh245OOZV15bRA3Y590Gi5jUcDJg==", + "dev": true, + "peer": true + }, + "acorn": { + "version": "8.8.1", + "resolved": "https://registry.npmjs.org/acorn/-/acorn-8.8.1.tgz", + "integrity": "sha512-7zFpHzhnqYKrkYdUjF1HI1bzd0VygEGX8lFk4k5zVMqHEoES+P+7TKI+EvLO9WVMJ8eekdO0aDEK044xTXwPPA==", + "dev": true + }, + "acorn-walk": { + "version": "8.2.0", + "resolved": "https://registry.npmjs.org/acorn-walk/-/acorn-walk-8.2.0.tgz", + "integrity": "sha512-k+iyHEuPgSw6SbuDpGQM+06HQUa04DZ3o+F6CSzXMvvI5KMvnaEqXe+YVe555R9nn6GPt404fos4wcgpw12SDA==", + "dev": true + }, + "arg": { + "version": "4.1.3", + "resolved": "https://registry.npmjs.org/arg/-/arg-4.1.3.tgz", + "integrity": "sha512-58S9QDqG0Xx27YwPSt9fJxivjYl432YCwfDMfZ+71RAqUrZef7LrKQZ3LHLOwCS4FLNBplP533Zx895SeOCHvA==", + "dev": true + }, "at-least-node": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/at-least-node/-/at-least-node-1.0.0.tgz", "integrity": "sha512-+q/t7Ekv1EDY2l6Gda6LLiX14rU9TV20Wa3ofeQmwPFZbOMo9DXrLbOjFaaclkXKWidIaopwAObQDqwWtGUjqg==" }, + "create-require": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/create-require/-/create-require-1.1.1.tgz", + "integrity": "sha512-dcKFX3jn0MpIaXjisoRvexIJVEKzaq7z2rZKxf+MSr9TkdmHmsU4m2lcLojrj/FHl8mk5VxMmYA+ftRkP/3oKQ==", + "dev": true + }, + "diff": { + "version": "4.0.2", + "resolved": "https://registry.npmjs.org/diff/-/diff-4.0.2.tgz", + "integrity": "sha512-58lmxKSA4BNyLz+HHMUzlOEpg09FV+ev6ZMe3vJihgdxzgcwZ8VoEEPmALCZG9LmqfVoNMMKpttIYTVG6uDY7A==", + "dev": true + }, "fs-extra": { "version": "9.1.0", "resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-9.1.0.tgz", @@ -98,15 +394,60 @@ "universalify": "^2.0.0" } }, + "make-error": { + "version": "1.3.6", + "resolved": "https://registry.npmjs.org/make-error/-/make-error-1.3.6.tgz", + "integrity": "sha512-s8UhlNe7vPKomQhC1qFelMokr/Sc3AgNbso3n74mVPA5LTZwkB9NlXf4XPamLxJE8h0gh73rM94xvwRT2CVInw==", + "dev": true + }, "moment": { "version": "2.29.4", "resolved": "https://registry.npmjs.org/moment/-/moment-2.29.4.tgz", "integrity": "sha512-5LC9SOxjSc2HF6vO2CyuTDNivEdoz2IvyJJGj6X8DJ0eFyfszE0QiEd+iXmBvUP3WHxSjFH/vIsA0EN00cgr8w==" }, + "ts-node": { + "version": "10.9.1", + "resolved": "https://registry.npmjs.org/ts-node/-/ts-node-10.9.1.tgz", + "integrity": "sha512-NtVysVPkxxrwFGUUxGYhfux8k78pQB3JqYBXlLRZgdGUqTO5wU/UyHop5p70iEbGhB7q5KmiZiU0Y3KlJrScEw==", + "dev": true, + "requires": { + "@cspotcode/source-map-support": "^0.8.0", + "@tsconfig/node10": "^1.0.7", + "@tsconfig/node12": "^1.0.7", + "@tsconfig/node14": "^1.0.0", + "@tsconfig/node16": "^1.0.2", + "acorn": "^8.4.1", + "acorn-walk": "^8.1.1", + "arg": "^4.1.0", + "create-require": "^1.1.0", + "diff": "^4.0.1", + "make-error": "^1.1.1", + "v8-compile-cache-lib": "^3.0.1", + "yn": "3.1.1" + } + }, + "typescript": { + "version": "4.8.4", + "resolved": "https://registry.npmjs.org/typescript/-/typescript-4.8.4.tgz", + "integrity": "sha512-QCh+85mCy+h0IGff8r5XWzOVSbBO+KfeYrMQh7NJ58QujwcE22u+NUSmUxqF+un70P9GXKxa2HCNiTTMJknyjQ==", + "dev": true + }, "universalify": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/universalify/-/universalify-2.0.0.tgz", "integrity": "sha512-hAZsKq7Yy11Zu1DE0OzWjw7nnLZmJZYTDZZyEFHZdUhV8FkH5MCfoU1XMaxXovpyW5nq5scPqq0ZDP9Zyl04oQ==" + }, + "v8-compile-cache-lib": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/v8-compile-cache-lib/-/v8-compile-cache-lib-3.0.1.tgz", + "integrity": "sha512-wa7YjyUGfNZngI/vtK0UHAN+lgDCxBPCylVXGp0zu59Fz5aiGtNXaq3DhIov063MorB+VfufLh3JlF2KdTK3xg==", + "dev": true + }, + "yn": { + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/yn/-/yn-3.1.1.tgz", + "integrity": "sha512-Ux4ygGWsu2c7isFWe8Yu1YluJmqVhxqK2cLXNQA5AcC3QfbGNpM7fu0Y8b/z16pXLnFxZYvWhd3fhBY9DLmC6Q==", + "dev": true } } } diff --git a/package.json b/package.json index 51e1ac7..98bc2e7 100644 --- a/package.json +++ b/package.json @@ -1,15 +1,12 @@ { "name": "mrx-plogger", - "version": "1.0.0", + "version": "1.0.1", "description": "Nodejs storage log", "main": "index.js", "repository": { "type": "git", "url": "git+https://github.com/marcelooblan2016/mrx-plogger.git" }, - "scripts": { - "test": "echo \"Error: no test specified\" && exit 1" - }, "author": "marx", "license": "ISC", "bugs": { @@ -19,5 +16,14 @@ "dependencies": { "fs-extra": "^9.1.0", "moment": "^2.29.4" + }, + "devDependencies": { + "@types/lodash": "^4.14.178", + "ts-node": "^10.4.0", + "typescript": "^4.5.2" + }, + "scripts": { + "start": "tsc", + "watch": "tsc -w" } } diff --git a/src/fs-extra.d.ts b/src/fs-extra.d.ts new file mode 100644 index 0000000..b76278b --- /dev/null +++ b/src/fs-extra.d.ts @@ -0,0 +1 @@ +declare module "fs-extra" \ No newline at end of file diff --git a/src/global.d.ts b/src/global.d.ts new file mode 100644 index 0000000..aa3bcae --- /dev/null +++ b/src/global.d.ts @@ -0,0 +1,6 @@ + + +interface constructorOptions { + logFileName: string; + dateFormat?: string; +} \ No newline at end of file diff --git a/src/index.ts b/src/index.ts new file mode 100644 index 0000000..3bbfbc1 --- /dev/null +++ b/src/index.ts @@ -0,0 +1,48 @@ + +import * as fs from 'fs-extra'; +import moment from 'moment' + +class plogger { + private logFileName: string; + private dateFormat: string; + + constructor (options: constructorOptions) { + this.logFileName = options.logFileName; + this.dateFormat = options.dateFormat ?? `YYYY-MM-DD hh:mm:ssA`; + } + /** + * Write message to the log file with details + * Sample: [2022-10-05 11:03:44] local.INFO: YV4A22RL4M1768603 + * @param string message + * @param string prefix + * @return boolean + */ + public log (message: string, prefix: string = 'INFO') { + try { + let content: string = [ + `[${moment().format(this.dateFormat)}]`, + `${prefix}:`, + typeof message == 'object' ? JSON.stringify(message) : message, + ].join(" "); + + fs.appendFileSync(this.logFileName, `${content}\n`); + + return true; + } catch (error) {} + + return false; + } + /** + * Shortcuts for: info, error, warning + * @param string message + * @param string prefix + * @return boolean + **/ + public info (message: string, prefix: string = 'INFO') { return this.log(message, prefix); } + public error (message: string, prefix: string = 'ERROR') { return this.log(message, prefix); } + public warning (message: string, prefix: string = 'WARNING') { return this.log(message, prefix); } +} + +export { + plogger +} \ No newline at end of file diff --git a/src/moment.d.ts b/src/moment.d.ts new file mode 100644 index 0000000..c27a66a --- /dev/null +++ b/src/moment.d.ts @@ -0,0 +1 @@ +declare module "moment" \ No newline at end of file diff --git a/test/storageLog.js b/test/storageLog.js new file mode 100644 index 0000000..861bcf4 --- /dev/null +++ b/test/storageLog.js @@ -0,0 +1,10 @@ +const {plogger} = require('../dist/index'); + +( async () => { + // create a logfile within the same folder + let ploggerIniatiated = new plogger({logFileName: 'test.log'}); + ploggerIniatiated.log("test hello0"); + ploggerIniatiated.info("test hello1"); + ploggerIniatiated.warning("test hello2"); + ploggerIniatiated.error("test hello3"); +})() \ No newline at end of file diff --git a/tsconfig.json b/tsconfig.json new file mode 100644 index 0000000..945e8c5 --- /dev/null +++ b/tsconfig.json @@ -0,0 +1,18 @@ +{ + "compilerOptions": { + "baseUrl": "./src", + "target": "es6", + "module": "commonjs", + "outDir": "./dist", + "rootDir": "./src", + "strict": true, + "moduleResolution": "node", + "esModuleInterop": true, + "allowJs": true + }, + "exclude":[ + "./node_modules", + "./dist", + "./test" + ] +} \ No newline at end of file From c6adea74652c550d9fad855570655c74bfd155aa Mon Sep 17 00:00:00 2001 From: Marcelo Oblan Date: Wed, 26 Oct 2022 22:14:27 +0800 Subject: [PATCH 3/4] readme added --- README.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..fa29c41 --- /dev/null +++ b/README.md @@ -0,0 +1,26 @@ +# MrxPlogger +Nodejs storage log +# Installation +```bash +npm i mrx-plogger +``` +## Usage +```bash + const {plogger} = require('../dist/index'); +( async () => { + // create a logfile within the same folder + let ploggerIniatiated = new plogger({logFileName: 'test.log'}); + ploggerIniatiated.log("test hello0"); + ploggerIniatiated.info("test hello1"); + ploggerIniatiated.warning("test hello2"); + ploggerIniatiated.error("test hello3"); +})() +``` +## Output +```bash +[2022-10-26 10:06:39PM] INFO: test hello0 +[2022-10-26 10:06:39PM] INFO: test hello1 +[2022-10-26 10:06:39PM] WARNING: test hello2 +[2022-10-26 10:06:39PM] ERROR: test hello3 + +``` \ No newline at end of file From 6588f55a22a32e8fd409838d858e0bf406b076b6 Mon Sep 17 00:00:00 2001 From: Marcelo Oblan Date: Wed, 26 Oct 2022 22:15:59 +0800 Subject: [PATCH 4/4] update readme --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index fa29c41..63e49d8 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ npm i mrx-plogger ``` ## Usage ```bash - const {plogger} = require('../dist/index'); + const {plogger} = require('mrx-plogger'); ( async () => { // create a logfile within the same folder let ploggerIniatiated = new plogger({logFileName: 'test.log'});