feat(cli): allow the use of TS path mapping (#554)

This enables the use of path aliases in your entities and ORM configuration file.

Example `tsconfig.json`:

```json
{
	"compilerOptions": {
		"paths": {
			"@foo": ["src/foo/index.ts"]
		}
	},
}
```

packages/cli/package.json

@@ -53,6 +53,7 @@
     "cli-highlight": "^2.1.4",
     "cli-table3": "^0.6.0",
     "fs-extra": "^9.0.0",
+    "tsconfig-paths": "^3.9.0",
     "yargonaut": "^1.1.4",
     "yargs": "^15.3.1"
   }

packages/cli/src/CLIHelper.ts

@@ -39,9 +39,7 @@ export class CLIHelper {
     const settings = await ConfigurationLoader.getSettings();
 
     if (settings.useTsNode) {
-      require('ts-node').register({
-        project: settings.tsConfigPath,
-      });
+      await ConfigurationLoader.registerTsNode(settings.tsConfigPath);
     }
 
     // noinspection HtmlDeprecatedTag

packages/core/src/utils/ConfigurationLoader.ts

@@ -56,6 +56,27 @@ export class ConfigurationLoader {
     return paths;
   }
 
+  static async registerTsNode(tsConfigPath = process.cwd() + '/tsconfig.json') {
+    require('ts-node').register({
+      project: tsConfigPath,
+    });
+
+    if (await pathExists(tsConfigPath)) {
+      // eslint-disable-next-line @typescript-eslint/no-var-requires
+      const tsConfig = require(tsConfigPath);
+
+      /* istanbul ignore next */
+      const paths = tsConfig?.compilerOptions?.paths;
+
+      if (paths) {
+        require('tsconfig-paths').register({
+          baseUrl: tsConfig.compilerOptions.baseUrl,
+          paths: tsConfig.compilerOptions.paths,
+        });
+      }
+    }
+  }
+
 }
 
 export interface Settings {

tests/cli/CLIHelper.test.ts

@@ -4,6 +4,8 @@ jest.mock('../../tests/mikro-orm.config.js', () => ({ type: 'mongo', dbName: 'fo
 jest.mock('../../tests/mikro-orm.config.ts', () => ({ type: 'mongo', dbName: 'foo_bar', entitiesDirs: ['.'] }), { virtual: true });
 const pkg = { 'mikro-orm': {} } as any;
 jest.mock('../../tests/package.json', () => pkg, { virtual: true });
+const tsc = { compilerOptions: {} } as any;
+jest.mock('../../tests/tsconfig.json', () => tsc, { virtual: true });
 const cwd = process.cwd;
 (global as any).process.cwd = () => '../../../../tests';
 const log = jest.fn();
@@ -38,28 +40,46 @@ describe('CLIHelper', () => {
   });
 
   test('configures yargs instance [ts-node]', async () => {
+    const pathExistsMock = jest.spyOn(require('fs-extra'), 'pathExists');
+    pathExistsMock.mockImplementation(path => path === '../../../../tests/package.json');
+    pkg['mikro-orm'].useTsNode = true;
+    const tsNodeMock = jest.spyOn(require('ts-node'), 'register');
+    tsNodeMock.mockImplementation(i => i);
+    const cli = await CLIHelper.configure() as any;
+    expect(cli.$0).toBe('mikro-orm');
+    expect(tsNodeMock).toHaveBeenCalled();
+    pathExistsMock.mockRestore();
+  });
+
+  test('configures yargs instance [ts-node] without paths', async () => {
     const pathExistsMock = jest.spyOn(require('fs-extra'), 'pathExists');
     pathExistsMock.mockResolvedValue(true);
     pkg['mikro-orm'].useTsNode = true;
+    delete tsc.compilerOptions.paths;
     const tsNodeMock = jest.spyOn(require('ts-node'), 'register');
+    tsNodeMock.mockImplementation(i => i);
+    const tsPathsMock = jest.spyOn(require('tsconfig-paths'), 'register');
+    tsPathsMock.mockImplementation(i => i);
     const cli = await CLIHelper.configure() as any;
     expect(cli.$0).toBe('mikro-orm');
     expect(tsNodeMock).toHaveBeenCalled();
-    expect(cli.getCommandInstance().getCommands()).toEqual([
-      'cache:clear',
-      'cache:generate',
-      'generate-entities',
-      'database:import',
-      'schema:create',
-      'schema:drop',
-      'schema:update',
-      'migration:create',
-      'migration:up',
-      'migration:down',
-      'migration:list',
-      'migration:pending',
-      'debug',
-    ]);
+    expect(tsPathsMock).not.toHaveBeenCalled();
+    pathExistsMock.mockRestore();
+  });
+
+  test('configures yargs instance [ts-node and ts-paths]', async () => {
+    const pathExistsMock = jest.spyOn(require('fs-extra'), 'pathExists');
+    pathExistsMock.mockResolvedValue(true);
+    pkg['mikro-orm'].useTsNode = true;
+    tsc.compilerOptions.paths = { alternativePath: ['alternativePath'] };
+    const tsNodeMock = jest.spyOn(require('ts-node'), 'register');
+    tsNodeMock.mockImplementation(i => i);
+    const tsPathsMock = jest.spyOn(require('tsconfig-paths'), 'register');
+    tsPathsMock.mockImplementation(i => i);
+    const cli = await CLIHelper.configure() as any;
+    expect(cli.$0).toBe('mikro-orm');
+    expect(tsNodeMock).toHaveBeenCalled();
+    expect(tsPathsMock).toHaveBeenCalled();
     pathExistsMock.mockRestore();
   });