fix(lint): add linting

EME-5173

Co-authored-by: Gabor Nemeth <[email protected]>

Author: sonicoder86

.eslintrc

@@ -0,0 +1,25 @@
+{
+  "env": {
+    "node": true,
+    "mocha": true,
+    "es6": true
+  },
+  "parser": "@typescript-eslint/parser",
+  "parserOptions": {
+    "ecmaFeatures": {
+      "impliedStrict": true
+    }
+  },
+  "globals": {
+    "expect": true
+  },
+  "rules": {
+    "security/detect-object-injection": 0,
+    "security/detect-non-literal-regexp": 0,
+    "no-unused-expressions": 0,
+    "func-style": 0
+  },
+  "extends": [
+    "emarsys"
+  ]
+}

package.json

@@ -4,8 +4,9 @@
   "description": "Tiny and fast json logger with namespace support",
   "main": "dist/index.js",
   "scripts": {
-    "test": "mocha --require ts-node/register ./src/ --recursive",
-    "test:watch": "mocha --require ts-node/register ./src/ --recursive --watch",
+    "test": "mocha --require ts-node/register ./src --recursive",
+    "test:watch": "mocha --require ts-node/register ./src --recursive --watch",
+    "lint": "eslint ./src/**/*.{ts,js}",
     "build": "rm -rf dist && tsc --project ./tsconfig.json",
     "semantic-release": "CI=true semantic-release",
     "example-js": "DEBUG=* node examples/index-js.js",
@@ -33,7 +34,12 @@
   "devDependencies": {
     "@emartech/cls-adapter": "1.3.0",
     "@types/node": "18.7.2",
+    "@typescript-eslint/parser": "5.35.1",
     "chai": "4.3.6",
+    "eslint": "7.21.0",
+    "eslint-config-emarsys": "5.1.0",
+    "eslint-plugin-no-only-tests": "2.4.0",
+    "eslint-plugin-security": "1.4.0",
     "express": "4.18.1",
     "koa": "2.13.4",
     "mocha": "10.0.0",

src/enabled/enabled.spec.js

@@ -1,5 +1,3 @@
-'use strict';
-
 const { isNamespaceEnabled } = require('./enabled');
 
 describe('isNamespaceAvailable', function() {

src/formatter/debug.spec.js

@@ -1,10 +1,8 @@
-'use strict';
-
 const { debugFormatter } = require('./debug');
 const { ColorName } = require('../output/color-name/color-name');
 
 describe('debug formatter', function() {
-  afterEach(function () {
+  afterEach(function() {
     ColorName.reset();
   });
 

src/formatter/json.spec.js

@@ -1,5 +1,3 @@
-'use strict';
-
 const { jsonFormatter } = require('./json');
 
 describe('json formatter', function() {

src/formatter/logentries.spec.js

@@ -1,5 +1,3 @@
-'use strict';
-
 const { logentriesFormatter } = require('./logentries');
 
 describe('logentries formatter', function() {

src/formatter/logentries.ts

@@ -1,13 +1,11 @@
-'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)) {
+  } else if (isNumeric(value)) {
     value = (value as number).toString();
   } else {
     value = '"' + JSON.stringify(value) + '"';

src/logger/logger.spec.js

@@ -1,16 +1,13 @@
-'use strict';
-
 const { Logger } = require('./logger');
 const { jsonFormatter } = require('../formatter/json');
 const { consoleOutput } = require('../output/console');
 
 describe('Logger', function() {
   let logger;
-  let outputStub;
 
   beforeEach(function() {
     logger = new Logger('mongo', true);
-    outputStub = this.sandbox.stub(Logger.config, 'output');
+    this.sandbox.stub(Logger.config, 'output');
   });
 
   afterEach(function() {
@@ -214,20 +211,20 @@ describe('Logger', function() {
       expect(logArguments.error_data.length).to.eql(3004);
     });
 
-    describe('when not an Error instance is passed as error', function () {
+    describe('when not an Error instance is passed as error', function() {
       [
         { type: 'custom object', value: {} },
         { type: 'string', value: 'error' },
         { type: 'null', value: null },
         { type: 'number', value: 12 },
         { type: 'bool', value: true }
       ].forEach(({ type, value }) => {
-        it(`should not throw error when ${type} is passed as error`, function () {
+        it(`should not throw error when ${type} is passed as error`, function() {
           expect(() => logger.customError('error', 'hi', value, { details: 'here' })).to.not.throw();
         });
       });
 
-      it('should log error properties from custom error object', function () {
+      it('should log error properties from custom error object', function() {
         const errorObject = { name: 'Error', message: 'My custom error', stack: 'Stack', data: { value: 1 } };
 
         logger.customError('error', 'hi', errorObject, { details: 'here' });
@@ -240,7 +237,7 @@ describe('Logger', function() {
         expect(logArguments.error_data).to.eql(JSON.stringify(errorObject.data));
       });
 
-      it('should not log additional or missing error properties from custom error object', function () {
+      it('should not log additional or missing error properties from custom error object', function() {
         const errorObject = { color: 'color', value: 'value' };
 
         logger.customError('error', 'hi', errorObject, { details: 'here' });

src/logger/logger.ts

@@ -130,9 +130,9 @@ export class Logger {
       return;
     }
 
-    return stack.length > STACK_TRACE_LIMIT
-      ? stack.substring(0, STACK_TRACE_LIMIT) + ' ...'
-      : stack;
+    return stack.length > STACK_TRACE_LIMIT ?
+      stack.substring(0, STACK_TRACE_LIMIT) + ' ...' :
+      stack;
   }
 
   _shortenData(data: unknown) {
@@ -142,9 +142,9 @@ export class Logger {
 
     const stringifiedData: string = typeof data === 'object' ? JSON.stringify(data) : data as string;
 
-    return stringifiedData.length > DATA_LIMIT
-      ? stringifiedData.substring(0, DATA_LIMIT) + ' ...'
-      : stringifiedData;
+    return stringifiedData.length > DATA_LIMIT ?
+      stringifiedData.substring(0, DATA_LIMIT) + ' ...' :
+      stringifiedData;
   }
 
   _getErrorDetails(error: Error) {
@@ -163,7 +163,9 @@ export class Logger {
   }
 
   _getAxiosErrorDetails(error: AxiosError) {
-    if (!error.isAxiosError) return {};
+    if (!error.isAxiosError) {
+      return {};
+    }
 
     return {
       request_method: error.config.method,

src/timer/timer.spec.js

@@ -1,5 +1,3 @@
-'use strict';
-
 const { Logger } = require('../logger/logger');
 const { Timer } = require('./timer');