feat(api): dynamically load entities using webpack require.context

don't need to manually adding all entities for TypeOrmModule config

Author: xmlking

PLAYBOOK-NEST.md

@@ -107,6 +107,13 @@ nest g class notification/notification.entity app/notifications --no-spec --dry-
 nest g controller subscription app/notifications  --dry-run
 nest g service subscription app/notifications --dry-run
 nest g class subscription/subscription.entity app/notifications --no-spec --dry-run
+
+
+You could also use `ng g` if you `npm i -D @nestjs/schematics`
+ng g @nestjs/schematics:module game --path app --source-root apps/api/src -d
+ng g @nestjs/schematics:controller match --path app/game  --source-root apps/api/src -d
+ng g @nestjs/schematics:service match --path app/game --source-root apps/api/src -d
+ng g @nestjs/schematics:class match/match.entity --path app/game --source-root apps/api/src --spec -d
 ```
 
 ### Ref

apps/api/src/app/core/core.module.ts

@@ -8,9 +8,19 @@ import { RequestContextMiddleware } from './context';
 import { ConfigService } from '../config';
 import { ConnectionOptions } from 'typeorm';
 import { environment as env } from '@env-api/environment';
-import { User } from '../auth/user.entity';
-import { Notification } from '../notifications/notification/notification.entity';
-import { Subscription } from '../notifications/subscription/subscription.entity';
+import { isClass } from '@ngx-starter-kit/utils';
+
+function requireAllClasses(rc) {
+  return rc
+    .keys()
+    .filter(filePath => !filePath.includes('base'))
+    .flatMap(key => Object.values(rc(key)))
+    .filter(isClass);
+}
+
+const requireContext = (require as any).context('../..', true, /\.entity.ts/);
+// const requireContext = (require as any).context('../..', true, /^\.\/.*\/.*\/(?!(base|audit-base)).*\.entity.ts$/);
+const entities = requireAllClasses(requireContext);
 
 @Module({
   imports: [
@@ -21,7 +31,7 @@ import { Subscription } from '../notifications/subscription/subscription.entity'
       useFactory: async (config: ConfigService) =>
         ({
           ...env.database,
-          entities: [User, Notification, Subscription],
+          entities,
         } as ConnectionOptions),
       inject: [ConfigService],
     }),

apps/api/src/app/core/index.ts

@@ -1,5 +1,4 @@
 export * from './core.module';
 export * from './services/base-remote.service';
-export * from './entities/audit-base.entity';
 export * from './crud/crud.service';
 export * from './crud/crud.controller';

apps/api/src/app/user/profile/Image.entity.ts renamed to apps/api/src/app/user/profile/image.entity.ts

@@ -1,6 +1,6 @@
 import { Column, Entity, JoinColumn, OneToOne } from 'typeorm';
-import { AuditBase } from '../../core';
-import { Image } from './Image.entity';
+import { AuditBase } from '../../core/entities/audit-base.entity';
+import { Image } from './image.entity';
 
 @Entity('profile')
 export class Profile extends AuditBase {

apps/api/src/app/user/profile/profile.entity.ts

@@ -1,4 +1,5 @@
-export { StateDef } from './lib/StateDef';
-export { waitUntil } from './lib/utils';
-export { DeepPartial } from './lib/DeepPartial';
-export { ObjectLiteral } from './lib/ObjectLiteral';
+export { StateDef } from './lib/state-def';
+export { waitUntil } from './lib/wait-until';
+export { DeepPartial } from './lib/deep-partial';
+export { ObjectLiteral } from './lib/object-literal';
+export * from './lib/require-multi';

libs/utils/src/index.ts

@@ -0,0 +1,15 @@
+export function isClass(obj) {
+  return !!obj.prototype && !!obj.prototype.constructor.name;
+}
+
+export function requireAll(rc) {
+  return rc.keys().map(rc);
+}
+
+export function requireAllClasses(rc) {
+  return rc
+    .keys()
+    // .filter(filePath => !filePath.includes('base'))
+    .flatMap(key => Object.values(rc(key)))
+    .filter(isClass);
+}