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/db-use-migrations.md

View on GitHub
---
title: Use Database Migrations
impact: HIGH
impactDescription: Enables safe, repeatable database schema changes
tags: database, migrations, typeorm, schema
---

## Use Database Migrations

Never use `synchronize: true` in production. Use migrations for all schema changes. Migrations provide version control for your database, enable safe rollbacks, and ensure consistency across all environments.

**Incorrect (using synchronize or manual SQL):**

```typescript
// Use synchronize in production
TypeOrmModule.forRoot({
	type: 'postgres',
	synchronize: true // DANGEROUS in production!
	// Can drop columns, tables, or data
});

// Manual SQL in production
@Injectable()
export class DatabaseService {
	async addColumn(): Promise<void> {
		await this.dataSource.query('ALTER TABLE users ADD COLUMN age INT');
		// No version control, no rollback, inconsistent across envs
	}
}

// Modify entities without migration
@Entity()
export class User {
	@Column()
	email: string;

	@Column() // Added without migration
	newField: string; // Will crash in production if synchronize is false
}
```

**Correct (use migrations for all schema changes):**

```typescript
// Configure TypeORM for migrations
// data-source.ts
export const dataSource = new DataSource({
	type: 'postgres',
	host: process.env.DB_HOST,
	port: parseInt(process.env.DB_PORT),
	username: process.env.DB_USERNAME,
	password: process.env.DB_PASSWORD,
	database: process.env.DB_NAME,
	entities: ['dist/**/*.entity.js'],
	migrations: ['dist/migrations/*.js'],
	synchronize: false, // Always false in production
	migrationsRun: true // Run migrations on startup
});

// app.module.ts
TypeOrmModule.forRootAsync({
	inject: [ConfigService],
	useFactory: (config: ConfigService) => ({
		type: 'postgres',
		host: config.get('DB_HOST'),
		synchronize: config.get('NODE_ENV') === 'development', // Only in dev
		migrations: ['dist/migrations/*.js'],
		migrationsRun: true
	})
});

// migrations/1705312800000-AddUserAge.ts
import { MigrationInterface, QueryRunner } from 'typeorm';

export class AddUserAge1705312800000 implements MigrationInterface {
	name = 'AddUserAge1705312800000';

	public async up(queryRunner: QueryRunner): Promise<void> {
		// Add column with default to handle existing rows
		await queryRunner.query(`
      ALTER TABLE "users" ADD "age" integer DEFAULT 0
    `);

		// Add index for frequently queried columns
		await queryRunner.query(`
      CREATE INDEX "IDX_users_age" ON "users" ("age")
    `);
	}

	public async down(queryRunner: QueryRunner): Promise<void> {
		// Always implement down for rollback
		await queryRunner.query(`DROP INDEX "IDX_users_age"`);
		await queryRunner.query(`ALTER TABLE "users" DROP COLUMN "age"`);
	}
}

// Safe column rename (two-step)
export class RenameNameToFullName1705312900000 implements MigrationInterface {
	public async up(queryRunner: QueryRunner): Promise<void> {
		// Step 1: Add new column
		await queryRunner.query(`
      ALTER TABLE "users" ADD "full_name" varchar(255)
    `);

		// Step 2: Copy data
		await queryRunner.query(`
      UPDATE "users" SET "full_name" = "name"
    `);

		// Step 3: Add NOT NULL constraint
		await queryRunner.query(`
      ALTER TABLE "users" ALTER COLUMN "full_name" SET NOT NULL
    `);

		// Step 4: Drop old column (after verifying app works)
		await queryRunner.query(`
      ALTER TABLE "users" DROP COLUMN "name"
    `);
	}

	public async down(queryRunner: QueryRunner): Promise<void> {
		await queryRunner.query(`ALTER TABLE "users" ADD "name" varchar(255)`);
		await queryRunner.query(`UPDATE "users" SET "name" = "full_name"`);
		await queryRunner.query(`ALTER TABLE "users" DROP COLUMN "full_name"`);
	}
}
```

Reference: [TypeORM Migrations](https://typeorm.io/migrations)
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: 472kUpdated 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: 472kUpdated Claude CodeCodexVerifiedInstall
rea-tool-designmorluto/reaAudit, investigate, design, or change REA investigation tools, CLI/MCP contracts, provider capabilities, and Evidence semantics.Stars: 472kUpdated 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