feat: add typescript paths to the boilerplate (#310)

* feat: add typescript paths to the boilerplate * build: removed uneeded dep
MapColonies · Sep 24, 2024 · 1bb2444 · 1bb2444
1 parent 04dee76
commit 1bb2444
Show file tree

Hide file tree

Showing 16 changed files with 1,890 additions and 1,226 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -16,7 +16,7 @@
     "release": "standard-version",
     "test": "npm run test:unit && npm run test:integration",
     "prebuild": "npm run clean",
-    "build": "tsc --project tsconfig.build.json  && npm run assets:copy",
+    "build": "tsc --project tsconfig.build.json && tsc-alias -p tsconfig.build.json && npm run assets:copy",
     "start": "npm run build && cd dist && node --require ./common/tracing.js ./index.js",
     "start:dev": "npm run build && cd dist && node --enable-source-maps --require ./common/tracing.js ./index.js",
     "assets:copy": "copyfiles -f ./config/* ./dist/config && copyfiles -f ./openapi3.yaml ./dist/ && copyfiles ./package.json dist",
@@ -78,7 +78,7 @@
     "cz-conventional-changelog": "^3.3.0",
     "eslint": "^8.43.0",
     "husky": "^8.0.3",
-    "jest": "^29.5.0",
+    "jest": "^29.7.0",
     "jest-create-mock-instance": "^2.0.0",
     "jest-html-reporters": "^3.1.4",
     "jest-openapi": "^0.14.2",
@@ -87,7 +87,8 @@
     "rimraf": "^5.0.1",
     "standard-version": "^9.5.0",
     "supertest": "^6.3.3",
-    "ts-jest": "^29.0.5",
+    "ts-jest": "^29.2.5",
+    "tsc-alias": "^1.8.10",
     "typescript": "^5.1.3"
   }
 }
diff --git a/src/containerConfig.ts b/src/containerConfig.ts
@@ -4,10 +4,10 @@ import { trace, metrics as OtelMetrics } from '@opentelemetry/api';
 import { DependencyContainer } from 'tsyringe/dist/typings/types';
 import jsLogger, { LoggerOptions } from '@map-colonies/js-logger';
 import { Metrics } from '@map-colonies/telemetry';
-import { SERVICES, SERVICE_NAME } from './common/constants';
-import { tracing } from './common/tracing';
+import { InjectionObject, registerDependencies } from '@common/dependencyRegistration';
+import { SERVICES, SERVICE_NAME } from '@common/constants';
+import { tracing } from '@common/tracing';
 import { resourceNameRouterFactory, RESOURCE_NAME_ROUTER_SYMBOL } from './resourceName/routes/resourceNameRouter';
-import { InjectionObject, registerDependencies } from './common/dependencyRegistration';
 import { anotherResourceRouterFactory, ANOTHER_RESOURCE_ROUTER_SYMBOL } from './anotherResource/routes/anotherResourceRouter';
 
 export interface RegisterOptions {

diff --git a/src/index.ts b/src/index.ts
@@ -5,7 +5,7 @@ import { createTerminus } from '@godaddy/terminus';
 import { Logger } from '@map-colonies/js-logger';
 import { container } from 'tsyringe';
 import config from 'config';
-import { DEFAULT_SERVER_PORT, SERVICES } from './common/constants';
+import { DEFAULT_SERVER_PORT, SERVICES } from '@common/constants';
 
 import { getApp } from './app';
 

diff --git a/src/resourceName/controllers/resourceNameController.ts b/src/resourceName/controllers/resourceNameController.ts
@@ -3,7 +3,7 @@ import { BoundCounter, Meter } from '@opentelemetry/api-metrics';
 import { RequestHandler } from 'express';
 import httpStatus from 'http-status-codes';
 import { injectable, inject } from 'tsyringe';
-import { SERVICES } from '../../common/constants';
+import { SERVICES } from '@common/constants';
 
 import { IResourceNameModel, ResourceNameManager } from '../models/resourceNameManager';
 

diff --git a/src/resourceName/models/resourceNameManager.ts b/src/resourceName/models/resourceNameManager.ts
@@ -1,6 +1,6 @@
 import { Logger } from '@map-colonies/js-logger';
 import { inject, injectable } from 'tsyringe';
-import { SERVICES } from '../../common/constants';
+import { SERVICES } from '@common/constants';
 
 const resourceInstance: IResourceNameModel = {
   id: 1,

diff --git a/src/serverBuilder.ts b/src/serverBuilder.ts
@@ -8,8 +8,8 @@ import { inject, injectable } from 'tsyringe';
 import { Logger } from '@map-colonies/js-logger';
 import httpLogger from '@map-colonies/express-access-log-middleware';
 import { collectMetricsExpressMiddleware, getTraceContexHeaderMiddleware } from '@map-colonies/telemetry';
-import { SERVICES } from './common/constants';
-import { IConfig } from './common/interfaces';
+import { SERVICES } from '@common/constants';
+import { IConfig } from '@common/interfaces';
 import { RESOURCE_NAME_ROUTER_SYMBOL } from './resourceName/routes/resourceNameRouter';
 import { ANOTHER_RESOURCE_ROUTER_SYMBOL } from './anotherResource/routes/anotherResourceRouter';
 

diff --git a/tests/configurations/integration/jest.config.js b/tests/configurations/integration/jest.config.js
@@ -1,8 +1,13 @@
+const { pathsToModuleNameMapper } = require('ts-jest');
+const { compilerOptions } = require('../../../tsconfig.json');
+
+/** @type {import('jest').Config} */
 module.exports = {
   transform: {
     '^.+\\.ts$': ['ts-jest', { tsconfig: 'tsconfig.test.json' }],
   },
   coverageReporters: ['text', 'html'],
+  moduleNameMapper: pathsToModuleNameMapper(compilerOptions.paths, { prefix: '<rootDir>/' }),
   collectCoverage: true,
   collectCoverageFrom: ['<rootDir>/src/**/*.ts', '!*/node_modules/', '!/vendor/**', '!*/common/**', '!**/models/**', '!<rootDir>/src/*'],
   coverageDirectory: '<rootDir>/coverage',

diff --git a/tests/configurations/unit/jest.config.js b/tests/configurations/unit/jest.config.js
@@ -1,7 +1,12 @@
+const { pathsToModuleNameMapper } = require('ts-jest');
+const { compilerOptions } = require('../../../tsconfig.json');
+
+/** @type {import('jest').Config} */
 module.exports = {
   transform: {
     '^.+\\.ts$': ['ts-jest', { tsconfig: 'tsconfig.test.json' }],
   },
+  moduleNameMapper: pathsToModuleNameMapper(compilerOptions.paths, { prefix: '<rootDir>/' }),
   testMatch: ['<rootDir>/tests/unit/**/*.spec.ts'],
   coverageReporters: ['text', 'html'],
   collectCoverage: true,

diff --git a/tests/integration/anotherResource/anotherResourceName.spec.ts b/tests/integration/anotherResource/anotherResourceName.spec.ts
@@ -1,9 +1,9 @@
 import jsLogger from '@map-colonies/js-logger';
 import { trace } from '@opentelemetry/api';
 import httpStatusCodes from 'http-status-codes';
-import { getApp } from '../../../src/app';
-import { SERVICES } from '../../../src/common/constants';
-import { IAnotherResourceModel } from '../../../src/anotherResource/models/anotherResourceManager';
+import { getApp } from '@src/app';
+import { SERVICES } from '@src/common/constants';
+import { IAnotherResourceModel } from '@src/anotherResource/models/anotherResourceManager';
 import { AnotherResourceRequestSender } from './helpers/requestSender';
 
 describe('resourceName', function () {

diff --git a/tests/integration/docs/docs.spec.ts b/tests/integration/docs/docs.spec.ts
@@ -1,8 +1,8 @@
 import jsLogger from '@map-colonies/js-logger';
 import { trace } from '@opentelemetry/api';
 import httpStatusCodes from 'http-status-codes';
-import { getApp } from '../../../src/app';
-import { SERVICES } from '../../../src/common/constants';
+import { getApp } from '@src/app';
+import { SERVICES } from '@src/common/constants';
 import { DocsRequestSender } from './helpers/docsRequestSender';
 
 describe('docs', function () {

diff --git a/tests/integration/resourceName/resourceName.spec.ts b/tests/integration/resourceName/resourceName.spec.ts
@@ -2,9 +2,9 @@ import jsLogger from '@map-colonies/js-logger';
 import { trace } from '@opentelemetry/api';
 import httpStatusCodes from 'http-status-codes';
 
-import { getApp } from '../../../src/app';
-import { SERVICES } from '../../../src/common/constants';
-import { IResourceNameModel } from '../../../src/resourceName/models/resourceNameManager';
+import { getApp } from '@src/app';
+import { SERVICES } from '@common/constants';
+import { IResourceNameModel } from '@src/resourceName/models/resourceNameManager';
 import { ResourceNameRequestSender } from './helpers/requestSender';
 
 describe('resourceName', function () {

diff --git a/tests/tsconfig.json b/tests/tsconfig.json
@@ -0,0 +1,3 @@
+{
+  "extends": "../tsconfig.test.json"
+}
diff --git a/tests/unit/anotherResource/models/anotherResourceManager.spec.ts b/tests/unit/anotherResource/models/anotherResourceManager.spec.ts
@@ -1,5 +1,5 @@
 import jsLogger from '@map-colonies/js-logger';
-import { AnotherResourceManager } from '../../../../src/anotherResource/models/anotherResourceManager';
+import { AnotherResourceManager } from '@src/anotherResource/models/anotherResourceManager';
 
 let anotherResourceManager: AnotherResourceManager;
 

diff --git a/tests/unit/resourceName/models/resourceNameModel.spec.ts b/tests/unit/resourceName/models/resourceNameModel.spec.ts
@@ -1,5 +1,5 @@
 import jsLogger from '@map-colonies/js-logger';
-import { ResourceNameManager } from '../../../../src/resourceName/models/resourceNameManager';
+import { ResourceNameManager } from '@src/resourceName/models/resourceNameManager';
 
 let resourceNameManager: ResourceNameManager;
 

diff --git a/tsconfig.json b/tsconfig.json
@@ -1,15 +1,21 @@
 {
   "compilerOptions": {
     "target": "es2021",
-    "module": "commonjs",
+    "module": "NodeNext",
     "declaration": true,
     "outDir": "dist",
     "strict": true,
     "esModuleInterop": true,
     "allowSyntheticDefaultImports": true,
-    "moduleResolution": "node",
+    "moduleResolution": "NodeNext",
     "experimentalDecorators": true,
-    "emitDecoratorMetadata": true
+    "emitDecoratorMetadata": true,
+    "baseUrl": ".",
+    "paths": {
+      "@src/*": ["src/*"],
+      "@tests/*": ["tests/*"],
+      "@common/*": ["src/common/*"]
+    }
   },
   "include": ["src"],
   "exclude": ["node_modules", "dist", "tests"]