Merge pull request #7 from emartech/typescript

feat(typescript): transform codebase to Typescript

Author: sonicoder86

.gitignore

@@ -1,6 +1,7 @@
 
 # Created by https://www.gitignore.io/api/osx,node,linux,intellij+all,visualstudiocode
 package-lock.json
+dist
 ### Intellij+all ###
 # Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio and Webstorm
 # Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839

.npmignore

@@ -2,3 +2,4 @@
 node_modules
 .idea
 examples
+src

examples/express.js

@@ -1,7 +1,7 @@
 'use strict';
 
 const express = require('express');
-const logFactory = require('../index');
+const logFactory = require('../dist');
 const clsAdapter = require('@emartech/cls-adapter');
 const logger = logFactory('example');
 const port = 3000;

examples/index.js renamed to examples/index-js.js

@@ -1,7 +1,7 @@
 'use strict';
 
 process.env.DEBUG = 'redis';
-const logger = require('../index');
+const logger = require('../dist');
 
 const mongoLogger = logger('mongo');
 const redisLogger = logger('redis');

examples/index-ts.ts

@@ -0,0 +1,17 @@
+process.env.DEBUG = 'redis';
+import logger from '../dist';
+
+const mongoLogger = logger('mongo');
+const redisLogger = logger('redis');
+
+// simple info logging with enabled namespace
+redisLogger.info('connected', { domain: 'yahoo' });
+
+// not enabled
+mongoLogger.info('connected', { domain: 'google' });
+
+// error objects
+redisLogger.fromError('query', new Error('Unauthorized'), { problem: 'missmatch' });
+
+// displays as is
+console.log(JSON.stringify({ example: 'output' }));

examples/koa.js

@@ -1,7 +1,8 @@
 'use strict';
 
 const Koa = require('koa');
-const logFactory = require('../index');
+const logFactory = require('../dist');
+
 const clsAdapter = require('@emartech/cls-adapter');
 const logger = logFactory('example');
 const port = 3000;

index.js

@@ -2,11 +2,14 @@
   "name": "@emartech/json-logger",
   "version": "0.0.0",
   "description": "Tiny and fast json logger with namespace support",
-  "main": "index.js",
+  "main": "dist/index.js",
   "scripts": {
-    "test": "mocha ./src/ --recursive",
-    "test:watch": "mocha ./src/ --recursive --watch",
+    "test": "mocha --require ts-node/register ./src/ --recursive",
+    "test:watch": "mocha --require ts-node/register ./src/ --recursive --watch",
+    "build": "rm -rf dist && tsc --project ./tsconfig.json",
     "semantic-release": "CI=true semantic-release",
+    "example-js": "DEBUG=* node examples/index-js.js",
+    "example-ts": "DEBUG=* ts-node examples/index-ts.ts",
     "koa-example": "DEBUG=* node examples/koa.js",
     "express-example": "DEBUG=* node examples/express.js"
   },
@@ -29,13 +32,16 @@
   },
   "devDependencies": {
     "@emartech/cls-adapter": "1.3.0",
+    "@types/node": "18.7.2",
     "chai": "4.3.6",
     "express": "4.18.1",
     "koa": "2.13.4",
     "mocha": "10.0.0",
     "semantic-release": "15.5.0",
     "sinon": "14.0.0",
-    "sinon-chai": "3.7.0"
+    "sinon-chai": "3.7.0",
+    "ts-node": "10.9.1",
+    "typescript": "4.7.4"
   },
   "repository": {
     "type": "git",

package.json

@@ -1,8 +1,11 @@
-'use strict';
+import chalk from 'chalk';
 
-const chalk = require('chalk');
+interface Color {
+  number: number;
+  name: string;
+}
 
-const levels = {
+const levels: Record<string, Color> = {
   trace: {
     number: 10,
     name: 'TRACE'
@@ -31,9 +34,9 @@ const levels = {
 
 const availableLevels = Object.keys(levels);
 
-const coloredNames = {};
+const coloredNames: Record<string, string> = {};
 availableLevels.forEach((levelName) => {
   coloredNames[levels[levelName].number] = levels[levelName].name;
 });
 
-module.exports = { levels, availableLevels, coloredNames };
+export const config = { levels, availableLevels, coloredNames };

src/config.js renamed to src/config.ts

@@ -1,6 +1,6 @@
 'use strict';
 
-const isNamespaceEnabled = require('./enabled');
+const { isNamespaceEnabled } = require('./enabled');
 
 describe('isNamespaceAvailable', function() {
   it('should enable when variables only contain one', function() {

src/enabled/enabled.spec.js

@@ -1,10 +1,8 @@
-'use strict';
-
-function isNamespaceEnabled(availableNamespaces, namespace) {
-  availableNamespaces = availableNamespaces.split(/[\s,]+/);
+export function isNamespaceEnabled(availableNamespace: string, namespace: string) {
+  const availableNamespaces = availableNamespace.split(/[\s,]+/);
   let enabled = false;
-  const adds = [];
-  const skips = [];
+  const adds: RegExp[] = [];
+  const skips: RegExp[] = [];
 
   availableNamespaces.forEach(function(name) {
     if (!name) {
@@ -33,5 +31,3 @@ function isNamespaceEnabled(availableNamespaces, namespace) {
 
   return enabled;
 }
-
-module.exports = isNamespaceEnabled;

src/enabled/enabled.js renamed to src/enabled/enabled.ts

@@ -1,7 +1,7 @@
 'use strict';
 
-const debug = require('./debug');
-const ColorName = require('../output/color-name/color-name');
+const { debugFormatter } = require('./debug');
+const { ColorName } = require('../output/color-name/color-name');
 
 describe('debug formatter', function() {
   afterEach(function () {
@@ -11,6 +11,6 @@ describe('debug formatter', function() {
   it('should format line', function() {
     const logLine = { level: 10, time: new Date().toISOString(), name: 'redis', random: 15 };
 
-    expect(debug(logLine)).to.eql('\u001b[36mredis\u001b[39m TRACE +0ms random=15');
+    expect(debugFormatter(logLine)).to.eql('\u001b[36mredis\u001b[39m TRACE +0ms random=15');
   });
-});
+});

src/formatter/debug.js

@@ -0,0 +1,19 @@
+import { ColorName } from '../output/color-name/color-name';
+import { stringifyLevel } from '../output/stringify-level/stringify-level';
+import { FormatTime } from '../output/format-time/format-time';
+import { formatBody } from '../output/format-body/format-body';
+
+interface Log {
+  name: string;
+  level: string;
+}
+
+const formatTime = new FormatTime();
+export function debugFormatter(log: Log) {
+  return [
+    ColorName.addColor(log.name),
+    stringifyLevel(log.level),
+    formatTime.elapsedTime(),
+    formatBody(log)
+  ].join(' ');
+};

src/formatter/debug.spec.js

@@ -0,0 +1,9 @@
+import { jsonFormatter } from './json';
+import { logentriesFormatter } from './logentries';
+import { debugFormatter } from './debug';
+
+export const formatter = {
+  json: jsonFormatter,
+  debug: debugFormatter,
+  logentries: logentriesFormatter
+};

src/formatter/debug.ts

@@ -1,6 +1,6 @@
 'use strict';
 
-const jsonFormatter = require('./json');
+const { jsonFormatter } = require('./json');
 
 describe('json formatter', function() {
   it('should stringify object to json', function() {

src/formatter/index.js

@@ -0,0 +1,3 @@
+export function jsonFormatter(log: unknown) {
+  return JSON.stringify(log);
+}

src/formatter/index.ts

@@ -1,6 +1,6 @@
 'use strict';
 
-const logentriesFormatter = require('./logentries');
+const { logentriesFormatter } = require('./logentries');
 
 describe('logentries formatter', function() {
   it('should stringify single field to key value pairs', function() {

src/formatter/json.js

@@ -0,0 +1,24 @@
+'use strict';
+
+const isNumeric = (value: unknown) => !isNaN(parseFloat(value as string)) && isFinite(value as number);
+
+const isString = (value: unknown) => typeof value === 'string' || value instanceof String;
+
+const convertToTag = (value: unknown, key: string) => {
+  if (isString(value)) {
+    value = JSON.stringify(value);
+  } else if(isNumeric(value)) {
+    value = (value as number).toString();
+  } else {
+    value = '"' + JSON.stringify(value) + '"';
+  }
+
+  return key + '=' + value;
+};
+
+export function logentriesFormatter(data: Record<string, unknown>) {
+  return Object
+    .keys(data)
+    .map(key => convertToTag(data[key], key))
+    .join(' ');
+}

src/formatter/json.spec.js

@@ -1,7 +1,7 @@
 'use strict';
 
-const logFactory = require('../index');
-const Logger = require('./logger/logger');
+const logFactory = require('./index');
+const { Logger } = require('./logger/logger');
 
 describe('LogFactory', function() {
   beforeEach(function() {

src/formatter/json.ts

@@ -0,0 +1,25 @@
+import { Logger, LoggerConfig } from './logger/logger';
+export { Logger, LoggerConfig } from './logger/logger';
+import { Timer } from './timer/timer';
+export { Timer } from './timer/timer';
+import { isNamespaceEnabled } from './enabled/enabled';
+import { formatter } from './formatter';
+
+export function logFactory(namespace: string): Logger {
+  return new Logger(namespace, isNamespaceEnabled(
+    logFactory.getNamespaces(), namespace
+  ));
+}
+
+logFactory.Logger = Logger;
+logFactory.Timer = Timer;
+logFactory.getNamespaces = function(): string {
+  return process.env.DEBUG || '';
+};
+logFactory.configure = function(options: LoggerConfig): void {
+  Logger.configure(options);
+};
+logFactory.formatter = formatter;
+
+export default logFactory;
+module.exports = logFactory;