feat(nest-demo): 基于@142vip/nest周边模块，补充Demo最佳实践代码

Author: mmdapl

apps/nest-demo/config/test.config.js

@@ -0,0 +1,10 @@
+module.exports = {
+  starter: {
+    port: 3000,
+    enableSwagger: true,
+    swagger: {},
+    // logger: {},
+    enableLogger: true,
+  },
+  // test: 1,
+}

apps/nest-demo/package.json

@@ -10,30 +10,27 @@
     "homePage": "https://142vip.cn"
   },
   "scripts": {
-    "dev": "nest start -d -w",
+    "dev": "NODE_ENV=local RUN_ENV=test nest start -d -w",
     "dev:debug": "nest start --debug --watch",
     "dev:prod": "node dist/main",
     "build": "nest build",
     "start": "nest start"
   },
+  "peerDependencies": {
+    "@142vip/nest": "workspace:*"
+  },
   "dependencies": {
     "@142vip/nest-redis": "workspace:*",
-    "@nestjs/common": "11.1.6",
-    "@nestjs/core": "11.1.6",
-    "@nestjs/platform-express": "11.1.6",
-    "reflect-metadata": "0.2.2",
-    "rxjs": "7.8.1"
+    "@142vip/nest-starter": "workspace:*"
   },
   "devDependencies": {
     "@nestjs/cli": "11.0.10",
     "@nestjs/schematics": "11.0.9",
     "@nestjs/testing": "11.1.7",
     "@types/express": "5.0.0",
-    "@types/jest": "30.0.0",
     "@types/supertest": "6.0.2",
     "source-map-support": "0.5.21",
     "supertest": "7.0.0",
-    "ts-jest": "29.2.5",
     "ts-loader": "9.5.2",
     "ts-node": "10.9.2",
     "tsconfig-paths": "4.2.0"

apps/nest-demo/src/app.module.ts

@@ -1,14 +1,17 @@
-import { RedisModule } from '@142vip/nest-redis'
+import { NestRedisModule } from '@142vip/nest-redis'
 import { Module } from '@nestjs/common'
+import { ConfigExampleModule } from './config-example/config-example.module'
 import { RedisExampleModule } from './redis-example/redis-example.module'
 
 @Module({
   imports: [
     // 全局模块
-    RedisModule.register({ url: 'redis://localhost:6379' }),
+    NestRedisModule.register({ url: 'redis://172.16.202.252:6379' }),
 
     // 最佳实践
     RedisExampleModule,
+
+    ConfigExampleModule,
   ],
 })
 export class AppModule {}

apps/nest-demo/src/config-example/config-example.controller.ts

@@ -0,0 +1,15 @@
+import { StarterConfig } from '@142vip/nest-starter'
+import { Controller, Get } from '@nestjs/common'
+import { ConfigExampleService } from './config-example.service'
+
+@Controller('config-example')
+export class ConfigExampleController {
+  constructor(
+    private readonly configExampleService: ConfigExampleService,
+  ) {}
+
+  @Get('/')
+  public 'Get /'(): StarterConfig {
+    return this.configExampleService.getStarterConfig()
+  }
+}

apps/nest-demo/src/config-example/config-example.module.ts

@@ -0,0 +1,9 @@
+import { Module } from '@nestjs/common'
+import { ConfigExampleController } from './config-example.controller'
+import { ConfigExampleService } from './config-example.service'
+
+@Module({
+  controllers: [ConfigExampleController],
+  providers: [ConfigExampleService],
+})
+export class ConfigExampleModule {}

apps/nest-demo/src/config-example/config-example.service.ts

@@ -0,0 +1,11 @@
+import { StarterConfig } from '@142vip/nest-starter'
+
+export class ConfigExampleService {
+  constructor(
+    private readonly starterConfig: StarterConfig,
+  ) { }
+
+  public getStarterConfig(): StarterConfig {
+    return this.starterConfig
+  }
+}

apps/nest-demo/src/config.ts

@@ -0,0 +1,7 @@
+import { NestAppConfig } from '@142vip/nest-starter'
+import { IsNumber } from 'class-validator'
+
+export class Config extends NestAppConfig {
+  @IsNumber()
+  test!: number
+}

apps/nest-demo/src/main.ts

@@ -1,9 +1,5 @@
-import { NestFactory } from '@nestjs/core'
+import { NestStarter } from '@142vip/nest-starter'
 import { AppModule } from './app.module'
 
-async function bootstrap(): Promise<void> {
-  const app = await NestFactory.create(AppModule)
-  await app.listen(3000)
-}
-
-void bootstrap()
+// 统一启动类
+void NestStarter.getInstance().start(AppModule)

packages/nest-starter/README.md

@@ -13,25 +13,11 @@ pnpm i @142vip/nest-starter
 
 ## 配置
 
-```ts
-import { NestAppConfig } from '@142vip/nest-starter'
-import { IsNumber } from 'class-validator'
-
-export class Config extends NestAppConfig {
-  @IsNumber()
-  test!: number
-}
-```
-
 ## 使用
 
-```ts
-import { NestStarter } from '@142vip/nest-starter'
-import { AppModule } from './app.module'
+### 模块注入
 
-// 统一启动类
-void NestStarter.getInstance().start(AppModule)
-```
+### 使用服务
 
 ## 参考