chore: Upgrade packages, add explicit prettier config

.eslintrc

@@ -2,8 +2,7 @@
   "parser": "@typescript-eslint/parser",
   "extends": [
     "plugin:@typescript-eslint/recommended",
-    "prettier/@typescript-eslint",
-    "plugin:prettier/recommended"
+    "prettier/@typescript-eslint"
   ],
   "parserOptions": {
     "ecmaVersion": 2018,

.prettierrc.js

@@ -0,0 +1,12 @@
+module.exports = {
+  printWidth: 80,
+  tabWidth: 2,
+  useTabs: false,
+  semi: true,
+  singleQuote: false,
+  jsxSingleQuote: false,
+  trailingComma: "none",
+  bracketSpacing: false,
+  jsxBracketSameLine: true,
+  arrowParens: "always"
+};

package.json

@@ -28,26 +28,25 @@
   "homepage": "https://github.com/Hipo/hipo-exceptions-js#readme",
   "lint-staged": {
     "src/**/*.{ts,tsx}": [
-      "lint"
+      "eslint"
     ]
   },
   "husky": {
     "hooks": {
-      "pre-commit": "lint-staged && npm run test &&  npm run type-check"
+      "pre-commit": "lint-staged && npm run test && npm run type-check"
     }
   },
   "devDependencies": {
-    "@types/jest": "25.1.2",
-    "@typescript-eslint/eslint-plugin": "2.6.1",
-    "@typescript-eslint/parser": "2.6.1",
-    "eslint": "6.6.0",
-    "eslint-config-prettier": "6.5.0",
-    "eslint-plugin-prettier": "3.1.1",
-    "husky": "4.2.3",
-    "jest": "25.1.0",
-    "lint-staged": "10.0.8",
-    "prettier": "1.19.1",
-    "ts-jest": "25.2.0",
-    "typescript": "3.7.2"
+    "@types/jest": "26.0.15",
+    "@typescript-eslint/eslint-plugin": "4.6.0",
+    "@typescript-eslint/parser": "4.6.0",
+    "eslint": "7.12.1",
+    "eslint-config-prettier": "6.15.0",
+    "husky": "4.3.0",
+    "jest": "26.6.1",
+    "lint-staged": "10.5.0",
+    "prettier": "2.1.2",
+    "ts-jest": "26.4.3",
+    "typescript": "4.0.5"
   }
 }

src/ExceptionTransformer.ts

@@ -1,4 +1,4 @@
-import { createMapFromObject, isObjectEmpty } from "./utils/dataStructureUtils";
+import {createMapFromObject, isObjectEmpty} from "./utils/dataStructureUtils";
 import {
   getErrorDetail,
   getStringMessage,

src/ExceptionTransformerModel.ts

@@ -1,4 +1,4 @@
-type ExceptionMap = Map<string, object>;
+type ExceptionMap = Map<string, unknown>;
 
 interface ExceptionDetail {
   [key: string]: ExceptionDetailValue;
@@ -21,7 +21,7 @@ type ErrorMessageGeneratorOptions = {
   skipTypes?: string[];
   shouldHideErrorKey?: boolean;
   shouldCapitalizeErrorKey?: boolean;
-  fieldLabelMap?: { [key: string]: string };
+  fieldLabelMap?: {[key: string]: string};
 };
 
 type OnUnexpectedException = (details: {

src/utils/dataStructureUtils.ts

@@ -1,27 +1,22 @@
-function createMapFromObject(obj: { [key: string]: any }) {
+function createMapFromObject(obj: {[key: string]: any}) {
   return new Map(Object.entries(obj));
 }
 
 function isArrayOfStrings(x: unknown): x is string[] {
-  return Array.isArray(x) && x.every(item => typeof item === "string");
+  return Array.isArray(x) && x.every((item) => typeof item === "string");
 }
 
-function isArrayOfObjects(x: unknown): x is Array<{ [key: string]: any }> {
+function isArrayOfObjects(x: unknown): x is Array<{[key: string]: any}> {
   return (
     Array.isArray(x) &&
-    x.every(item => typeof item === "object" && !Array.isArray(item))
+    x.every((item) => typeof item === "object" && !Array.isArray(item))
   );
 }
 
-function isObjectEmpty(obj: unknown): obj is {} {
+function isObjectEmpty(obj: unknown): obj is unknown {
   return typeof obj === "object" && !Array.isArray(obj) && obj
     ? Object.keys(obj).length === 0
     : false;
 }
 
-export {
-  createMapFromObject,
-  isArrayOfStrings,
-  isArrayOfObjects,
-  isObjectEmpty
-};
+export {createMapFromObject, isArrayOfStrings, isArrayOfObjects, isObjectEmpty};

src/utils/errorUtils.ts

@@ -8,7 +8,7 @@ import {
   isArrayOfObjects,
   isObjectEmpty
 } from "./dataStructureUtils";
-import { convertSnakeCaseToTitleCase } from "./stringUtils";
+import {convertSnakeCaseToTitleCase} from "./stringUtils";
 
 function getErrorDetail(
   errorInfo: Exception | null | undefined
@@ -53,7 +53,7 @@ interface StringMessageGeneratorKeyOptions {
   customKey?: string;
   shouldCapitalizeErrorKey?: boolean;
   shouldHideErrorKey?: boolean;
-  fieldLabelMap?: { [key: string]: string };
+  fieldLabelMap?: {[key: string]: string};
 }
 
 function getStringMessage(
@@ -72,7 +72,7 @@ function getStringMessage(
     } else if (isArrayOfObjects(errorDetailValue)) {
       // errorDetailValue = [ {}, {}, {..} ]
       const firstNonEmptyErrorObject = (errorDetailValue as ExceptionDetail[]).find(
-        x => !isObjectEmpty(x)
+        (x) => !isObjectEmpty(x)
       );
 
       if (firstNonEmptyErrorObject) {
@@ -135,7 +135,7 @@ function getErrorKeyForStringMessageGenerator(
 }
 
 function deleteProperty(exceptionDetail: ExceptionDetail, path: string) {
-  const filteredObj = { ...exceptionDetail };
+  const filteredObj = {...exceptionDetail};
   const keys = path.split(".");
 
   keys.reduce<undefined | ExceptionDetailValue>((value, key, index) => {
@@ -164,7 +164,7 @@ function removeKnownKeysFromErrorDetail(
 }
 
 function getValueFromPath(exceptionDetail: ExceptionDetail, path: string) {
-  const filteredObj = { ...exceptionDetail };
+  const filteredObj = {...exceptionDetail};
   const keys = path.split(".");
 
   return keys.reduce<undefined | ExceptionDetailValue>((acc, key) => {

src/utils/stringUtils.ts

@@ -1,8 +1,8 @@
 function convertSnakeCaseToTitleCase(string: string) {
   return string
     .split("_")
-    .map(word => word[0].toUpperCase() + word.slice(1))
+    .map((word) => word[0].toUpperCase() + word.slice(1))
     .join(" ");
 }
 
-export { convertSnakeCaseToTitleCase };
+export {convertSnakeCaseToTitleCase};

tests/utils/dataStructureUtils.test.ts

@@ -65,7 +65,7 @@ describe("createMapFromObject", () => {
           {},
           {},
           {},
-          { phone_number: ["The phone number entered is not valid."] }
+          {phone_number: ["The phone number entered is not valid."]}
         ]
       },
       fallback_message: "This is a random fallback message"
@@ -80,7 +80,7 @@ describe("createMapFromObject", () => {
             {},
             {},
             {},
-            { phone_number: ["The phone number entered is not valid."] }
+            {phone_number: ["The phone number entered is not valid."]}
           ]
         }
       ],
@@ -179,7 +179,7 @@ describe("isArrayOfObjects", () => {
 
   it("should return true when given array of non empty object(s)", () => {
     const objectArrayResult = isArrayOfObjects([
-      { "key-string-1": "value-string-1" }
+      {"key-string-1": "value-string-1"}
     ]);
     const longObjectArrayResult = isArrayOfObjects([
       {
@@ -224,7 +224,7 @@ describe("isArrayOfObjects", () => {
     const arrayOfArraysAndObjectsResult = isArrayOfObjects([
       [],
       ["not", "empty", "array"],
-      { "object-key": "object-value" }
+      {"object-key": "object-value"}
     ]);
 
     expect(emptyArrayOfArrayResult).toBe(false);
@@ -259,6 +259,6 @@ describe("isObjectEmpty", () => {
   });
 
   it("should return false when object is not empty", () => {
-    expect(isObjectEmpty({ "any key": "any value" })).toBe(false);
+    expect(isObjectEmpty({"any key": "any value"})).toBe(false);
   });
 });

tests/utils/errorUtils.test.ts

@@ -38,8 +38,8 @@ describe("getErrorDetail", () => {
       type: "ValidationError",
       detail: {
         non_field_errors: [
-          { address: ["The address entered is not valid."] },
-          { phone_number: ["The phone number entered is not valid."] }
+          {address: ["The address entered is not valid."]},
+          {phone_number: ["The phone number entered is not valid."]}
         ]
       },
       fallback_message: "This is a random fallback message"
@@ -49,8 +49,8 @@ describe("getErrorDetail", () => {
 
     expect(detail).toStrictEqual({
       non_field_errors: [
-        { address: ["The address entered is not valid."] },
-        { phone_number: ["The phone number entered is not valid."] }
+        {address: ["The address entered is not valid."]},
+        {phone_number: ["The phone number entered is not valid."]}
       ]
     });
   });
@@ -62,8 +62,8 @@ describe("getErrorDetail", () => {
         non_field_errors: [
           {},
           {},
-          { address: ["The address entered is not valid."] },
-          { phone_number: ["The phone number entered is not valid."] }
+          {address: ["The address entered is not valid."]},
+          {phone_number: ["The phone number entered is not valid."]}
         ]
       },
       fallback_message: "This is a random fallback message"
@@ -87,8 +87,8 @@ describe("getErrorDetail", () => {
       non_field_errors: [
         {},
         {},
-        { address: ["The address entered is not valid."] },
-        { phone_number: ["The phone number entered is not valid."] }
+        {address: ["The address entered is not valid."]},
+        {phone_number: ["The phone number entered is not valid."]}
       ]
     });
     expect(detailWithOnlyEmptyObjects).toStrictEqual({
@@ -170,7 +170,7 @@ describe("generateMessageFromStringArray", () => {
 describe("generateFieldErrorFromErrorDetail", () => {
   const mockErrorDetail: ExceptionDetail = {
     title: ["Title is missing"],
-    questions: [{}, {}, {}, { answer: ["required"] }, {}]
+    questions: [{}, {}, {}, {answer: ["required"]}, {}]
   };
 
   it("should return correct field error", () => {
@@ -238,7 +238,7 @@ describe("getStringMessage", () => {
 
     it("should replace error key using fieldLabelMap", () => {
       const message = getStringMessage(mockErrorDetail, {
-        fieldLabelMap: { phone_number: "Custom Title" }
+        fieldLabelMap: {phone_number: "Custom Title"}
       });
       expect(message).toBe(
         "Custom Title: The phone number entered is not valid."
@@ -247,7 +247,7 @@ describe("getStringMessage", () => {
 
     it("should not replace error key if no matching value in fieldLabelMap", () => {
       const message = getStringMessage(mockErrorDetail, {
-        fieldLabelMap: { address: "Custom Title" }
+        fieldLabelMap: {address: "Custom Title"}
       });
       expect(message).toBe(
         "phone_number: The phone number entered is not valid."
@@ -258,7 +258,7 @@ describe("getStringMessage", () => {
   describe("when error detail is an object", () => {
     const mockErrorDetail: ExceptionDetailValue = {
       title: ["Title is missing"],
-      questions: [{}, {}, {}, { answer: ["required"] }, {}]
+      questions: [{}, {}, {}, {answer: ["required"]}, {}]
     };
 
     it("should return first field's error message", () => {
@@ -298,7 +298,7 @@ describe("getStringMessage", () => {
 
     it("should add given key to the message and return", () => {
       const key = "Title";
-      const message = getStringMessage(mockErrorDetail, { customKey: key });
+      const message = getStringMessage(mockErrorDetail, {customKey: key});
       expect(message).toBe(`${key}: ${mockErrorDetail[0]}`);
     });
   });