@vladmandic/pilogger - npm Package Compare versions

Comparing version 0.2.18 to 0.3.1

package.json

 {
   "name": "@vladmandic/pilogger",
-  "version": "0.2.18",
+  "version": "0.3.1",
   "description": "Simple Logger for NodeJS",
@@ -10,5 +10,4 @@ "main": "dist/pilogger.js",
   "scripts": {
-    "start": "node ./src/pilogger.js",
     "build": "esbuild --outdir=dist --target=es2018 --platform=node --format=cjs --color=true --bundle src/pilogger.js",
-    "test": "node ./dist/pilogger.js"
+    "test": "node ./src/test.js"
   },
@@ -32,6 +31,6 @@ "repository": {
   "devDependencies": {
-    "chalk": "^4.1.1",
-    "dayjs": "^1.10.6",
-    "esbuild": "^0.12.16"
+    "chalk": "^4.1.2",
+    "dayjs": "^1.10.7",
+    "esbuild": "^0.12.26"
   }
 }

src/pilogger.js

@@ -11,13 +11,21 @@ const os = require('os');
 const ring = [];
-let dateFormat = 'YYYY-MM-DD HH:mm:ss';
-let ringLength = 100;
-let logStream = null;
-let logFile = null;
-let logFileOK = false;
-let accessStream = null;
-let accessFile = null;
-let accessFileOK = false;
-let clientStream = null;
-let clientFile = null;
-let clientFileOK = false;
+
+const options = {
+  dateFormat: 'YYYY-MM-DD HH:mm:ss',
+  ringLength: 100,
+  console: true,
+  // logFile: null,
+  // accessFile: null,
+  // clientFile: null,
+}
+
+const streams = {
+  logFile: false,
+  accessFile: false,
+  clientFile: false,
+  // logStream: null,
+  // accessStream: null,
+  // clientStream: null,
+}
+
 const tags = {
@@ -33,4 +41,7 @@ blank: '',
   state: ctx.magenta('STATE:'),
+  verbose: ctx.bgGray.yellowBright('VERB: '),
+  debug: ctx.bgGray.redBright('DEBUG:')
 };
-let inspectOptions = {
+
+let inspectOptions = { // options passed to nodejs console constructor
   showHidden: true,
@@ -47,2 +58,3 @@ depth: 5,
 };
+
 let logger = new Console({
@@ -52,3 +64,2 @@ stdout: process.stdout,
   ignoreErrors: true,
-  // groupIndentation: 2,
   inspectOptions,
@@ -58,7 +69,7 @@ });
 function setDateFormat(dt) {
-  dateFormat = dt;
+  options.dateFormat = dt;
 }
 
 function setRingLength() {
-  ringLength = 100;
+  options.ringLength = 100;
 }
@@ -76,14 +87,14 @@
 function print(...messages) {
-  const time = dayjs(Date.now()).format(dateFormat);
-  logger.log(time, ...messages);
+  const time = dayjs(Date.now()).format(options.dateFormat);
+  if (options.console) logger.log(time, ...messages);
 }
 
 function setLogFile(file) {
-  logFile = file;
-  logFileOK = true;
-  logStream = fs.createWriteStream(path.resolve(logFile), { flags: 'a' });
-  logStream.on('error', (e) => {
-    // @ts-ignore
-    print(tags.error, 'Cannot open application log', `${logFile}: ${e.code}`);
-    logFileOK = false;
+  if (typeof file !== 'string') return;
+  options.logFile = file;
+  streams.logFile = true;
+  streams.logStream = fs.createWriteStream(path.resolve(options.logFile || ''), { flags: 'a' });
+  if (streams.logStream) streams.logStream.on('error', (e) => {
+    print(tags.error, 'Cannot open application log', `${options.logFile}: ${e.code}`);
+    streams.logFile = false;
   });
@@ -93,9 +104,9 @@ }
 function setAccessFile(file) {
-  accessFile = file;
-  accessFileOK = true;
-  accessStream = fs.createWriteStream(path.resolve(accessFile), { flags: 'a' });
-  accessStream.on('error', (e) => {
-    // @ts-ignore
-    print(tags.error, 'Cannot open application log', `${logFile}: ${e.code}`);
-    accessFileOK = false;
+  if (typeof file !== 'string') return;
+  options.accessFile = file;
+  streams.accessFile = true;
+  streams.accessStream = fs.createWriteStream(path.resolve(options.accessFile), { flags: 'a' });
+  if (streams.accessStream) streams.accessStream.on('error', (e) => {
+    print(tags.error, 'Cannot open application log', `${options.logFile}: ${e.code}`);
+    streams.accessFile = false;
   });
@@ -105,9 +116,9 @@ }
 function setClientFile(file) {
-  clientFile = file;
-  clientFileOK = true;
-  clientStream = fs.createWriteStream(path.resolve(clientFile), { flags: 'a' });
-  clientStream.on('error', (e) => {
-    // @ts-ignore
-    print(tags.error, 'Cannot open application log', `${logFile}: ${e.code}`);
-    clientFileOK = false;
+  if (typeof file !== 'string') return;
+  options.clientFile = file;
+  streams.clientFile = true;
+  streams.clientStream = fs.createWriteStream(path.resolve(options.clientFile), { flags: 'a' });
+  if (streams.clientStream) streams.clientStream.on('error', (e) => {
+    print(tags.error, 'Cannot open application log', `${options.logFile}: ${e.code}`);
+    streams.clientFile = false;
   });
@@ -127,34 +138,34 @@ }
   elapsed = Math.round(elapsed / 1000000);
-  const time = dayjs(Date.now()).format(dateFormat);
-  logger.log(time, tags.timed, `${elapsed.toLocaleString()} ms`, ...messages);
-  if (logFileOK) logStream.write(`${tags.timed} ${time} ${elapsed.toLocaleString()} ms ${combineMessages(...messages)}\n`);
+  const time = dayjs(Date.now()).format(options.dateFormat);
+  if (options.console) logger.log(time, tags.timed, `${elapsed.toLocaleString()} ms`, ...messages);
+  if (streams.logFile) streams.logStream.write(`${tags.timed} ${time} ${elapsed.toLocaleString()} ms ${combineMessages(...messages)}\n`);
 }
 
 async function log(tag, ...messages) {
-  const time = dayjs(Date.now()).format(dateFormat);
+  const time = dayjs(Date.now()).format(options.dateFormat);
   if (tags[tag]) print(tags[tag], ...messages);
   else print(...messages);
-  if (logFileOK) logStream.write(`${time} ${tags[tag]} ${combineMessages(...messages)}\n`);
+  if (streams.logFile && streams.logStream) streams.logStream.write(`${time} ${tags[tag]} ${combineMessages(...messages)}\n`);
   ring.push({ tag, time, msg: combineMessages(...messages) });
-  if (ring.length > ringLength) ring.shift();
+  if (ring.length > options.ringLength) ring.shift();
 }
 
 async function access(...messages) {
-  const time = dayjs(Date.now()).format(dateFormat);
-  if (accessFileOK) accessStream.write(`${time} ${combineMessages(...messages)}\n`);
+  const time = dayjs(Date.now()).format(options.dateFormat);
+  if (streams.accessFile && streams.accessStream) streams.accessStream.write(`${time} ${combineMessages(...messages)}\n`);
 }
 
 async function client(...messages) {
-  const time = dayjs(Date.now()).format(dateFormat);
-  if (clientFileOK) clientStream.write(`${time} ${combineMessages(...messages)}\n`);
+  const time = dayjs(Date.now()).format(options.dateFormat);
+  if (streams.clientFile && streams.clientStream) streams.clientStream.write(`${time} ${combineMessages(...messages)}\n`);
 }
 
-function configure(options) {
-  if (!options) return;
-  if (options.dateFormat) dateFormat = options.dateFormat;
-  if (options.ringLength) ringLength = options.ringLength;
-  if (options.logFile) setLogFile(options.logFile);
-  if (options.accessFile) setAccessFile(options.accessFile);
-  if (options.clientFile) setClientFile(options.clientFile);
-  if (options.inspect) inspectOptions = { ...inspectOptions, ...options.inspect };
+function configure(userOptions) {
+  if (!userOptions) return;
+  if (userOptions.dateFormat) options.dateFormat = options.dateFormat;
+  if (userOptions.ringLength) options.ringLength = options.ringLength;
+  if (userOptions.logFile) setLogFile(options.logFile);
+  if (userOptions.accessFile) setAccessFile(options.accessFile);
+  if (userOptions.clientFile) setClientFile(options.clientFile);
+  if (userOptions.inspect) inspectOptions = { ...inspectOptions, ...userOptions.inspect };
   logger = new Console({
@@ -164,3 +175,2 @@ stdout: process.stdout,
     ignoreErrors: true,
-    // groupIndentation: 2,
     inspectOptions,
@@ -177,7 +187,17 @@ });
   log('info', 'User:', os.userInfo().username, 'Platform:', process.platform, 'Arch:', process.arch, 'Node:', process.version);
-  if (logFile && logFileOK) print(tags.state, 'Application log:', path.resolve(logFile));
-  if (accessFile && accessFileOK) print(tags.state, 'Access log:', path.resolve(logFile));
-  if (clientFile && clientFileOK) print(tags.state, 'Client log:', path.resolve(logFile));
+  if (options.logFile && streams.logFile) print(tags.state, 'Application log:', path.resolve(options.logFile));
+  if (options.accessFile && streams.accessFile) print(tags.state, 'Access log:', path.resolve(options.logFile));
+  if (options.clientFile && streams.clientFile) print(tags.state, 'Client log:', path.resolve(options.logFile));
 }
 
+function headerJson() {
+  const f = './package.json';
+  if (!fs.existsSync(f)) return;
+  const node = JSON.parse(fs.readFileSync(f).toString());
+  process.title = node.name;
+  log('info', { application: node.name, version: node.version });
+  log('info', { user: os.userInfo().username, platform: process.platform, arch: process.arch, node: process.version });
+  if (options.logFile || options.accessFile || options.clientFile) print(tags.state, { log: path.resolve(options.logFile || ''), access: path.resolve(options.accessFile || ''), client: path.resolve(options.clientFile || '') });
+}
+
 function test() {
@@ -201,19 +221,18 @@ header();
 
-try {
-  if (require.main === module) test();
-} catch {
-  //
-}
+exports.ring = ring; // local ring buffer
+exports.header = header; // print basic header
+exports.headerJson = headerJson; // print basic header in json format
 
-// local ring buffer
-exports.ring = ring;
-// config items
+// options setters
 exports.ringLength = setRingLength;
 exports.dateFormat = setDateFormat;
-// simple replacement for logger.log
-exports.console = print;
-// log with timing
-exports.timed = timed;
-// simple logging to application log
-exports.logFile = setLogFile;
+exports.logFile = setLogFile; // simple logging to application log
+exports.accessFile = setAccessFile;
+exports.clientFile = setClientFile;
+exports.configure = configure; // configure log object
+exports.options = options;
+
+// actual log methods
+exports.console = print; // simple replacement for logger.log
+exports.timed = timed; // log with timing
 exports.blank = (...message) => log(...message);
@@ -226,11 +245,5 @@ exports.info = (...message) => log('info', ...message);
 exports.fatal = (...message) => log('fatal', ...message);
-// simple logging to access file
-exports.accessFile = setAccessFile;
-exports.access = (...message) => access(...message);
-// simple logging to client file
-exports.clientFile = setClientFile;
-exports.client = (...message) => client(...message);
-// configure log object
-exports.configure = configure;
-// print basic header
-exports.header = header;
+exports.verbose = (...message) => log('verbose', ...message);
+exports.debug = (...message) => log('debug', ...message);
+exports.access = (...message) => access(...message); // simple logging to access file
+exports.client = (...message) => client(...message); // simple logging to client file

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Dynamic require

Supply chain risk

Dynamic require can indicate the package is performing dangerous or unsafe dynamic code execution.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

83924

increased by4.08%

Number of package files

12

increased by9.09%

Lines of code

2215

increased by1.79%

Worsened metrics

Number of low supply chain risk alerts

4

increased by100%

No dependency changes