Skip to content

ever-co/ever-works / .agents/skills/nestjs-best-practices

nestjs-best-practices

Verified

NestJS best practices and architecture patterns for building production-ready applications. This skill should be used when writing, reviewing, or refactoring NestJS code to ensure proper patterns for modules, dependency injection, security, and performance.

FileKindSize
AGENTS.mdmarkdown154.2 KB
README.mdmarkdown4.7 KB
SKILL.mdskill md4.8 KB
rules/_sections.mdmarkdown2.1 KB
rules/_template.mdmarkdown633 B
rules/api-use-dto-serialization.mdmarkdown4.2 KB
rules/api-use-interceptors.mdmarkdown5.4 KB
rules/api-use-pipes.mdmarkdown5.3 KB
rules/api-versioning.mdmarkdown4.7 KB
rules/arch-avoid-circular-deps.mdmarkdown1.9 KB
rules/arch-feature-modules.mdmarkdown2.3 KB
rules/arch-module-sharing.mdmarkdown3.7 KB
rules/arch-single-responsibility.mdmarkdown2.8 KB
rules/arch-use-events.mdmarkdown2.9 KB
rules/arch-use-repository-pattern.mdmarkdown2.7 KB
rules/db-avoid-n-plus-one.mdmarkdown3.8 KB
rules/db-use-migrations.mdmarkdown3.7 KB
rules/db-use-transactions.mdmarkdown3.6 KB
rules/devops-graceful-shutdown.mdmarkdown5.5 KB
rules/devops-use-config-module.mdmarkdown4.2 KB
rules/devops-use-logging.mdmarkdown5.1 KB
rules/di-avoid-service-locator.mdmarkdown2.8 KB
rules/di-interface-segregation.mdmarkdown5.0 KB
rules/di-liskov-substitution.mdmarkdown6.8 KB
rules/di-prefer-constructor-injection.mdmarkdown2.2 KB
rules/di-scope-awareness.mdmarkdown2.5 KB
rules/di-use-interfaces-tokens.mdmarkdown2.5 KB
rules/error-handle-async-errors.mdmarkdown3.4 KB
rules/error-throw-http-exceptions.mdmarkdown3.0 KB
rules/error-use-exception-filters.mdmarkdown3.4 KB
rules/micro-use-health-checks.mdmarkdown6.1 KB
rules/micro-use-patterns.mdmarkdown5.0 KB
rules/micro-use-queues.mdmarkdown5.7 KB
rules/perf-async-hooks.mdmarkdown2.8 KB
rules/perf-lazy-loading.mdmarkdown3.6 KB
rules/perf-optimize-database.mdmarkdown3.0 KB
rules/perf-use-caching.mdmarkdown3.3 KB
rules/security-auth-jwt.mdmarkdown3.8 KB
rules/security-rate-limiting.mdmarkdown3.1 KB
rules/security-sanitize-output.mdmarkdown3.7 KB
rules/security-use-guards.mdmarkdown3.4 KB
rules/security-validate-all-input.mdmarkdown3.2 KB
rules/test-e2e-supertest.mdmarkdown4.4 KB
rules/test-mock-external-services.mdmarkdown4.2 KB
rules/test-use-testing-module.mdmarkdown4.1 KB
scripts/build-agents.tsscript8.1 KB
scripts/build.shscript369 B
scripts/package-lock.jsonmanifest7.7 KB
scripts/package.jsonmanifest410 B

rules/perf-lazy-loading.md

View on GitHub
---
title: Use Lazy Loading for Large Modules
impact: MEDIUM
impactDescription: Improves startup time for large applications
tags: performance, lazy-loading, modules, optimization
---

## Use Lazy Loading for Large Modules

NestJS supports lazy-loading modules, which defers initialization until first use. This is valuable for large applications where some features are rarely used, serverless deployments where cold start time matters, or when certain modules have heavy initialization costs.

**Incorrect (loading everything eagerly):**

```typescript
// Load everything eagerly in a large app
@Module({
	imports: [
		UsersModule,
		OrdersModule,
		PaymentsModule,
		ReportsModule, // Heavy, rarely used
		AnalyticsModule, // Heavy, rarely used
		AdminModule, // Only admins use this
		LegacyModule, // Migration module, rarely used
		BulkImportModule // Used once a month
	]
})
export class AppModule {}

// All modules initialize at startup, even if never used
// Slow cold starts in serverless
// Memory wasted on unused modules
```

**Correct (lazy load rarely-used modules):**

```typescript
// Use LazyModuleLoader for optional modules
import { LazyModuleLoader } from '@nestjs/core';

@Injectable()
export class ReportsService {
	constructor(private lazyModuleLoader: LazyModuleLoader) {}

	async generateReport(type: string): Promise<Report> {
		// Load module only when needed
		const { ReportsModule } = await import('./reports/reports.module');
		const moduleRef = await this.lazyModuleLoader.load(() => ReportsModule);

		const reportsService = moduleRef.get(ReportsGeneratorService);
		return reportsService.generate(type);
	}
}

// Lazy load admin features with caching
@Injectable()
export class AdminService {
	private adminModule: ModuleRef | null = null;

	constructor(private lazyModuleLoader: LazyModuleLoader) {}

	private async getAdminModule(): Promise<ModuleRef> {
		if (!this.adminModule) {
			const { AdminModule } = await import('./admin/admin.module');
			this.adminModule = await this.lazyModuleLoader.load(() => AdminModule);
		}
		return this.adminModule;
	}

	async runAdminTask(task: string): Promise<void> {
		const moduleRef = await this.getAdminModule();
		const taskRunner = moduleRef.get(AdminTaskRunner);
		await taskRunner.run(task);
	}
}

// Reusable lazy loader service
@Injectable()
export class ModuleLoaderService {
	private loadedModules = new Map<string, ModuleRef>();

	constructor(private lazyModuleLoader: LazyModuleLoader) {}

	async load<T>(key: string, importFn: () => Promise<{ default: Type<T> } | Type<T>>): Promise<ModuleRef> {
		if (!this.loadedModules.has(key)) {
			const module = await importFn();
			const moduleType = 'default' in module ? module.default : module;
			const moduleRef = await this.lazyModuleLoader.load(() => moduleType);
			this.loadedModules.set(key, moduleRef);
		}
		return this.loadedModules.get(key)!;
	}
}

// Preload modules in background after startup
@Injectable()
export class ModulePreloader implements OnApplicationBootstrap {
	constructor(private lazyModuleLoader: LazyModuleLoader) {}

	async onApplicationBootstrap(): Promise<void> {
		setTimeout(async () => {
			await this.preloadModule(() => import('./reports/reports.module'));
		}, 5000); // 5 seconds after startup
	}

	private async preloadModule(importFn: () => Promise<any>): Promise<void> {
		try {
			const module = await importFn();
			const moduleType = module.default || Object.values(module)[0];
			await this.lazyModuleLoader.load(() => moduleType);
		} catch (error) {
			console.warn('Failed to preload module', error);
		}
	}
}
```

Reference: [NestJS Lazy Loading Modules](https://docs.nestjs.com/fundamentals/lazy-loading-modules)
rea-analysis-optimizationmorluto/reaOptimize REA providers and shared analysis workflows for agent context, latency, CPU, and memory while preserving correctness and Evidence. Use for analysis bottlenecks and cache or query design; CI/test-suite optimization belongs to rea-ci-tests-audit.Stars: 471kUpdated Claude CodeCodexVerifiedInstall
rea-ci-tests-auditmorluto/reaAudit REA CI and test suites for correctness, fixture drift, false passes, and measured performance; use for suite or workflow investigations and efficiency changes, rather than ordinary feature testing or a single test failure.Stars: 471kUpdated Claude CodeCodexVerifiedInstall
rea-tool-designmorluto/reaAudit, investigate, design, or change REA investigation tools, CLI/MCP contracts, provider capabilities, and Evidence semantics.Stars: 471kUpdated Claude CodeCodexVerifiedInstall
ponytail-auditDietrichGebert/ponytailQuality audit of the whole repo: bugs, security, real load, missing tests, speed, and what to delete. Most important first.Stars: 194kUpdated Claude CodeCodexVerifiedInstall