nhb-express/templates/drizzle/nhb.scripts.config.mjs

Minimal Express + TypeScript scaffolder with modular structure and flexible stack choices.

// @ts-check

import { defineScriptConfig, generateModule, parsePackageJson, runExeca } from 'nhb-scripts';
import { createDrizzlePostgresSchema } from './scripts/createSchema.mjs';
import { expressDrizzlePostgresTemplate } from './scripts/moduleTemplate.mjs';
import { updateDrizzleInstance } from './scripts/updateDrizzle.mjs';
import { updateCollection, updateRoutes } from './scripts/updateTemplate.mjs';

export default defineScriptConfig({
	format: {
		args: ['--write'],
		files: ['src', 'nhb.scripts.config.mjs', 'eslint.config.mjs', 'drizzle.config.ts'],
		ignorePath: '.prettierignore',
	},
	lint: { folders: ['src'], patterns: ['**/*.ts'] },
	fix: { folders: ['src'], patterns: ['**/*.ts'] },
	commit: {
		runFormatter: !!parsePackageJson()?.devDependencies?.prettier,
		emojiBeforePrefix: true,
		wrapPrefixWith: '`',
	},
	build: {
		distFolder: 'dist',
		commands: [{ cmd: 'tsc' }, { cmd: 'tsc-alias' }],
		waitingMessage: ' 📦 Building Your Express Application...',
	},
	count: {
		defaultPath: 'src',
		excludePaths: ['node_modules', 'dist', 'public', 'migrations'],
	},
	module: {
		force: false,
		defaultTemplate: 'express-drizzle-postgres',
		templates: {
			'express-drizzle-postgres': {
				createFolder: true,
				destination: 'src/app/modules',
				files: expressDrizzlePostgresTemplate,
				onComplete: async (moduleName) => {
					generateModule(moduleName, {
						createFolder: false,
						defaultTemplate: 'drizzle-schema',
						templates: {
							'drizzle-schema': {
								createFolder: false,
								destination: 'src/drizzle/schema',
								files: createDrizzlePostgresSchema,
							},
						},
					});
					updateCollection(moduleName);
					updateRoutes(moduleName, true);
					updateDrizzleInstance(moduleName);
					await runDrizzleMigration(moduleName);
				},
			},
			'drizzle-postgres-schema': {
				createFolder: false,
				destination: 'src/drizzle/schema',
				files: createDrizzlePostgresSchema,
				onComplete: async (schemaName) => {
					updateDrizzleInstance(schemaName);
					await runDrizzleMigration(schemaName);
				},
			},
		},
	},
});

/**
 * * Run Drizzle migration related commands.
 * @param {string} schemaName Name of the schema to append with the migration filename.
 */
async function runDrizzleMigration(schemaName) {
	/** @type {{ stdout: 'inherit', stderr: 'inherit', stdin: 'inherit' }} */
	const options = { stdout: 'inherit', stderr: 'inherit', stdin: 'inherit' };

	// Generate new migration file
	await runExeca(
		'drizzle-kit',
		['generate', `--name=${schemaName}`, '--config=drizzle.config.ts'],
		options
	);

	// Push the schema directly to the DB
	await runExeca('drizzle-kit', ['push', '--force', '--config=drizzle.config.ts'], options);

	// Drop a migration
	// await runExeca('drizzle-kit', ['drop', '--config=drizzle.config.ts'], options);

	// Create new baseline migration
	// await runExeca('drizzle-kit', ['migrate', '--config=drizzle.config.ts'], options);
}