ROE-1679: add path aliases, alias compiling config to tsconfig; chang…

jest.config.ts

@@ -0,0 +1,32 @@
+import type { JestConfigWithTsJest } from 'ts-jest';
+import { pathsToModuleNameMapper } from 'ts-jest';
+import { compilerOptions } from './tsconfig.json';
+
+const jestConfig: JestConfigWithTsJest = {
+  roots: ['<rootDir>'],
+  testPathIgnorePatterns: [
+    "/node_modules/",
+    "/dist/",
+  ],
+  collectCoverageFrom: [
+    "./src/**/*.ts",
+  ],
+  coveragePathIgnorePatterns: [
+    "/src/bin/",
+    "/src/model/",
+  ],
+  preset: "ts-jest",
+  testEnvironment: "node",
+  verbose: true,
+  testMatch: ["**/test/**/*.spec.[jt]s"],
+  globals: {
+    "ts-jest": {
+      diagnostics: false,
+    },
+  },
+  globalSetup: "./test/setup.ts",
+  modulePaths: [compilerOptions.baseUrl],
+  moduleNameMapper: pathsToModuleNameMapper(compilerOptions.paths),
+};
+
+export default jestConfig;

package.json

@@ -5,7 +5,7 @@
   "main": "app.ts",
   "scripts": {
     "start": "node dist/bin/www.js",
-    "build": "tsc && cp -r views dist/",
+    "build": "tsc && tsc-alias && cp -r views dist/",
     "lint": "eslint '{src,test}/**/*'",
     "lint:fix": "eslint '{src,test}/**/*' --fix",
     "sonarqube-base-branch": "sonar-scanner",
@@ -48,10 +48,14 @@
     "@typescript-eslint/parser": "^5.15.0",
     "eslint": "^8.11.0",
     "husky": "^7.0.0",
-    "jest": "^27.5.1",
+    "jest": "^29.3.1",
     "sonarqube-scanner": "^2.8.1",
-    "supertest": "^6.2.2",
-    "ts-jest": "^27.1.3",
+    "supertest": "^6.3.1",
+    "ts-jest": "^29.0.3",
+    "ts-node": "^10.9.1",
+    "tsc-alias": "^1.7.1",
+    "tsconfig-paths": "^4.1.0",
+    "nodemon": "^2.0.20",
     "typescript": "^4.6.2"
   }
 }

src/app.ts

@@ -9,11 +9,11 @@ import {
 } from '@companieshouse/node-session-handler';
 
 import * as config from "./config";
-import { logger } from "./utils/logger";
+import { logger } from "@utils/logger";
 import router from "./routes";
-import errorHandler from "./controllers/error.controller";
-import { createChangeLinkConfig } from "./utils/change.link";
-import { countryFilter } from "./utils/country.filter";
+import errorHandler from "@controller/error.controller";
+import { createChangeLinkConfig } from "@utils/change.link";
+import { countryFilter } from "@utils/country.filter";
 
 const app = express();
 

src/controllers/sold.land.filter.controller.ts

@@ -1,10 +1,10 @@
 import { NextFunction, Request, Response } from "express";
 
-import { logger } from "../utils/logger";
+import { logger } from "@utils/logger";
 import * as config from "../config";
-import { ApplicationData } from "../model";
-import { deleteApplicationData, getApplicationData, setExtraData } from "../utils/application.data";
-import { HasSoldLandKey, LANDING_PAGE_QUERY_PARAM } from "../model/data.types.model";
+import { ApplicationData } from "@model/index";
+import { deleteApplicationData, getApplicationData, setExtraData } from "@utils/application.data";
+import { HasSoldLandKey, LANDING_PAGE_QUERY_PARAM } from "@model/data.types.model";
 
 export const get = (req: Request, res: Response, next: NextFunction) => {
   try {

src/controllers/trust.information.controller.ts

@@ -1,15 +1,15 @@
 import { NextFunction, Request, Response } from "express";
 import { Session } from "@companieshouse/node-session-handler";
 
-import { logger } from "../utils/logger";
+import { logger } from "@utils/logger";
 import * as config from "../config";
-import { ApplicationData, ApplicationDataType, trustType } from "../model";
-import { getApplicationData, prepareData, setApplicationData, getFromApplicationData } from "../utils/application.data";
-import { TrustKey, TrustKeys } from "../model/trust.model";
-import { BeneficialOwnerIndividualKey } from "../model/beneficial.owner.individual.model";
-import { BeneficialOwnerOtherKey } from "../model/beneficial.owner.other.model";
-import { getBeneficialOwnerList } from "../utils/trusts";
-import { saveAndContinue } from "../utils/save.and.continue";
+import { ApplicationData, ApplicationDataType, trustType } from "@model/index";
+import { getApplicationData, prepareData, setApplicationData, getFromApplicationData } from "@utils/application.data";
+import { TrustKey, TrustKeys } from "@model/trust.model";
+import { BeneficialOwnerIndividualKey } from "@model/beneficial.owner.individual.model";
+import { BeneficialOwnerOtherKey } from "@model/beneficial.owner.other.model";
+import { getBeneficialOwnerList } from "@utils/trusts";
+import { saveAndContinue } from "@utils/save.and.continue";
 
 export const get = (req: Request, res: Response, next: NextFunction) => {
   try {

test/controllers/trust.information.controller.spec.ts

@@ -1,15 +1,15 @@
 jest.mock("ioredis");
-jest.mock('../../src/middleware/authentication.middleware');
-jest.mock("../../src/utils/application.data");
-jest.mock('../../src/utils/save.and.continue');
-jest.mock('../../src/middleware/navigation/has.beneficial.owners.or.managing.officers.middleware');
+jest.mock('@middleware/authentication.middleware');
+jest.mock("@utils/application.data");
+jest.mock('@utils/save.and.continue');
+jest.mock('@middleware/navigation/has.beneficial.owners.or.managing.officers.middleware');
 
 import { describe, expect, test, jest, beforeEach } from '@jest/globals';
 import { NextFunction, Request, Response } from "express";
 import request from "supertest";
 
 import app from "../../src/app";
-import { authentication } from "../../src/middleware/authentication.middleware";
+import { authentication } from "@middleware/authentication.middleware";
 import { ANY_MESSAGE_ERROR, PAGE_TITLE_ERROR, SERVICE_UNAVAILABLE, TRUST_INFO_PAGE_TITLE } from "../__mocks__/text.mock";
 import {
   APPLICATION_DATA_MOCK,
@@ -29,9 +29,9 @@ import {
 } from '../__mocks__/session.mock';
 import * as config from "../../src/config";
 import { ErrorMessages } from '../../src/validation/error.messages';
-import { getApplicationData, prepareData, getFromApplicationData } from "../../src/utils/application.data";
-import { saveAndContinue } from "../../src/utils/save.and.continue";
-import { hasBOsOrMOs } from "../../src/middleware/navigation/has.beneficial.owners.or.managing.officers.middleware";
+import { getApplicationData, prepareData, getFromApplicationData } from "@utils/application.data";
+import { saveAndContinue } from "@utils/save.and.continue";
+import { hasBOsOrMOs } from "@middleware/navigation/has.beneficial.owners.or.managing.officers.middleware";
 import {
   TRUSTS_SUBMIT_CORPORATE_RO_ADDRESS_PREMISES_TOO_LONG,
   TRUSTS_SUBMIT_CORPORATE_SA_ADDRESS_PREMISES_TOO_LONG,

tsconfig.json

@@ -11,12 +11,30 @@
     "experimentalDecorators": true,
     "strictNullChecks": true,
     "esModuleInterop": true,
-    "resolveJsonModule": true
+    "resolveJsonModule": true,
+    "paths": {
+      "@utils/*": ["utils/*"],
+      "@service/*": ["service/*"],
+      "@middleware/*": ["middleware/*"],
+      "@controller/*": ["controllers/*"],
+      "@model/*": ["model/*"],
+      "@views/*": ["views/*"]
+    }
   },
   "include": [
     "src/**/*"
   ],
   "exclude": [
     "node_modules"
-  ]
+  ],
+  "ts-node": {
+    "files": true,
+    "require": [
+      "tsconfig-paths/register"
+    ]
+  },
+  "tsc-alias": {
+    "verbose": false,
+    "resolveFullPaths": true
+  }
 }

tsconfig.test.json

@@ -0,0 +1,7 @@
+{
+    "extends": "./tsconfig.json",
+    "include": [
+        "./src/**/*",
+        "./test/**/*"
+    ]
+}