achscli 1.3.5

package/package.json

@@ -0,0 +1,37 @@
+{
+  "name": "achscli",
+  "version": "1.3.5",
+  "description": "Scaffolding CLI to generate files and update modules",
+  "license": "MIT",
+  "private": false,
+  "author": "sorodriguezz",
+  "bin": {
+    "achscli": "dist/bin.js"
+  },
+  "files": [
+    "dist",
+    "templates",
+    "README.md",
+    "LICENSE"
+  ],
+  "type": "commonjs",
+  "engines": {
+    "node": ">=18"
+  },
+  "scripts": {
+    "build": "node esbuild.config.mjs",
+    "dev": "node esbuild.config.mjs --watch",
+    "prepublishOnly": "npm run build"
+  },
+  "dependencies": {
+    "chalk": "5.6.2",
+    "commander": "14.0.2",
+    "handlebars": "4.7.8",
+    "ts-morph": "27.0.2"
+  },
+  "devDependencies": {
+    "@types/node": "25.0.3",
+    "esbuild": "0.27.2",
+    "typescript": "5.9.3"
+  }
+}

package/templates/generate/nestjs/controller.hbs

@@ -0,0 +1,30 @@
+import { Controller, Get, Logger } from '@nestjs/common';
+import { ApplyControllerDocs } from '#app/common/docs.decorator.ts';
+import { {{PASCALCASE className}}ControllerDocs } from './{{KEBABCASE className}}.controller.docs.ts';
+
+/**
+ * {{PASCALCASE className}} controller.
+ * NOTE: import it in your context module at 'controllers' array.
+ *
+ * @see https://docs.nestjs.com/controllers
+ */
+@Controller({
+	path: '{{route}}',
+	version: '1',
+})
+@ApplyControllerDocs({{PASCALCASE className}}ControllerDocs)
+export class {{PASCALCASE className}} {
+	/**
+	 * Return sample result.
+	 *
+	 * @returns returns a sample
+	 */
+	@Get()
+	run(): string {
+		return 'Hello World';
+	}
+
+	constructor() {}
+
+	private readonly _logger = new Logger({{PASCALCASE className}}.name);
+}

package/templates/generate/nestjs/decorator.hbs

@@ -0,0 +1,10 @@
+import { applyDecorators } from '@nestjs/common';
+
+/**
+ * {{PASCALCASE decoratorName}} decorator.
+ *
+ * @see https://docs.nestjs.com/custom-decorators
+ */
+export function {{PASCALCASE decoratorName}}() {
+	return applyDecorators(/* your decorators here */);
+}

package/templates/generate/nestjs/docs-controller.hbs

@@ -0,0 +1,19 @@
+import { ApiOperation, ApiResponse, ApiTags } from '@nestjs/swagger';
+import { HttpStatus } from '@nestjs/common';
+import type { DecoratorsLookUp } from '#common/decorators/apply.decorator.js';
+import { type {{PASCALCASE className}}Controller } from './{{KEBABCASE className}}.controller.ts';
+
+export const {{PASCALCASE className}}ControllerDocs: DecoratorsLookUp<{{PASCALCASE className}}Controller> =
+	{
+		class: [ApiTags('{{PASCALCASE className}}')],
+		method: {
+			run: [
+				ApiOperation({ summary: 'A Description' }),
+				ApiResponse({
+					description: 'DTO',
+					status: HttpStatus.OK,
+					type: String,
+				}),
+			],
+		},
+	};

package/templates/generate/nestjs/dto.hbs

@@ -0,0 +1,17 @@
+import { ZodDto } from '#libs/zod';
+import { z } from 'zod';
+
+/**
+ * {{PASCALCASE className}} Schema.
+ */
+const {{PASCALCASE className}}Schema = z.object({
+	prop: z.string().describe('my prop'),
+});
+
+/**
+ * {{PASCALCASE className}} Dto.
+ */
+export class {{PASCALCASE className}}Dto extends ZodDto(
+	{{PASCALCASE className}}Schema,
+	'{{PASCALCASE className}}',
+) {}

package/templates/generate/nestjs/dynamic-module.hbs

@@ -0,0 +1,36 @@
+import {
+	type DynamicModule,
+	Logger,
+	Module,
+	type OnModuleInit,
+} from '@nestjs/common';
+
+/**
+ * {{PASCALCASE className}} dynamic module.
+ * NOTE: import it in your 'main.module' at 'imports' array.
+ *
+ * @see https://docs.nestjs.com/fundamentals/dynamic-modules
+ */
+@Module({})
+export class {{PASCALCASE className}}Module implements OnModuleInit {
+	onModuleInit(): void {
+		this._logger.debug('Module started');
+	}
+
+	private readonly _logger = new Logger({{PASCALCASE className}}Module.name);
+
+	/**
+	 * Register the module with configuration.
+	 *
+	 * @returns module registration
+	 */
+	static register(): DynamicModule {
+		return {
+			module: {{PASCALCASE className}}Module,
+			controllers: [],
+			imports: [],
+			exports: [],
+			providers: [],
+		};
+	}
+}

package/templates/generate/nestjs/entity.hbs

@@ -0,0 +1,23 @@
+/**
+ * {{PASCALCASE entityName}} Entity.
+ */
+export class {{PASCALCASE entityName}}Entity {
+	/**
+	 * A member.
+	 */
+	private _member: string;
+
+	/**
+	 * Returns member value.
+	 */
+	get member(): string {
+		return this._member;
+	}
+
+	/**
+	 * Sets member value.
+	 */
+	set member(value: string) {
+		this._member = value;
+	}
+}

package/templates/generate/nestjs/filter.hbs

@@ -0,0 +1,52 @@
+import { HttpAdapterHost } from '@nestjs/core';
+import {
+	type ArgumentsHost,
+	Catch,
+	type ExceptionFilter,
+	HttpException,
+	HttpStatus,
+	Logger,
+} from '@nestjs/common';
+
+/**
+ * {{PASCALCASE filterName}} exception filter.
+ * NOTE: import it in your context module at 'providers' array
+ *  or with decorator @UseFilters(new {{PASCALCASE filterName}}ExceptionFilter())
+ *
+ * Remove @Catch() decorator for scoped catching.
+ *
+ * @see https://docs.nestjs.com/exception-filters
+ */
+@Catch()
+export class {{PASCALCASE filterName}}ExceptionFilter implements ExceptionFilter {
+	/**
+	 * Captures all exceptions.
+	 *
+	 * @param exception - thrown exception
+	 * @param host - execution context
+	 */
+	catch(exception: unknown, host: ArgumentsHost) {
+		// in certain situations `httpAdapter` might not be available in the
+		// constructor method, thus we should resolve it here.
+		const { httpAdapter } = this.httpAdapterHost;
+
+		const ctx = host.switchToHttp();
+
+		const httpStatus =
+			exception instanceof HttpException
+				? exception.getStatus()
+				: HttpStatus.INTERNAL_SERVER_ERROR;
+
+		const responseBody = {
+			path: httpAdapter.getRequestUrl(ctx.getRequest()),
+			statusCode: httpStatus,
+			timestamp: new Date().toISOString(),
+		};
+
+		httpAdapter.reply(ctx.getResponse(), responseBody, httpStatus);
+	}
+
+	constructor(private readonly httpAdapterHost: HttpAdapterHost) {}
+
+	private readonly _logger = new Logger({{PASCALCASE filterName}}ExceptionFilter.name);
+}

package/templates/generate/nestjs/guard.hbs

@@ -0,0 +1,34 @@
+import { type Observable } from 'rxjs';
+import {
+	type CanActivate,
+	type ExecutionContext,
+	Injectable,
+	UseGuards,
+} from '@nestjs/common';
+
+/**
+ * {{PASCALCASE guardName}} guard.
+ *
+ * @see https://docs.nestjs.com/guards
+ */
+@Injectable()
+class {{PASCALCASE guardName}}Guard implements CanActivate {
+	/**
+	 * Validates if request may continue
+	 *
+	 * @param context - current request context
+	 *
+	 * @returns whether can be executed
+	 */
+	canActivate(
+		context: ExecutionContext,
+	): boolean | Promise<boolean> | Observable<boolean> {
+		console.log(`Guard ${ {{PASCALCASE guardName}}Guard.name } triggered!`);
+
+		return true;
+	}
+}
+
+const guard = UseGuards(new {{PASCALCASE guardName}}Guard());
+
+export const {{PASCALCASE guardName}} = () => guard;

package/templates/generate/nestjs/http-exception.hbs

@@ -0,0 +1,11 @@
+import { HttpException, HttpStatus } from '@nestjs/common';
+
+/**
+ * {{PASCALCASE httpExceptionName}} HTTP exception.
+ */
+export class {{PASCALCASE httpExceptionName}}HttpException extends HttpException {
+	constructor() {
+    // add description
+		super('', HttpStatus.INTERNAL_SERVER_ERROR);
+	}
+}

package/templates/generate/nestjs/interceptor.hbs

@@ -0,0 +1,40 @@
+import { tap } from 'rxjs/operators';
+import { type Observable } from 'rxjs';
+import {
+	Injectable,
+	type NestInterceptor,
+	type ExecutionContext,
+	type CallHandler,
+	UseInterceptors,
+	Logger,
+} from '@nestjs/common';
+
+/**
+ * {{PASCALCASE interceptorName}} interceptor.
+ *
+ * @see https://docs.nestjs.com/interceptors
+ */
+@Injectable()
+class {{PASCALCASE interceptorName}}Interceptor implements NestInterceptor {
+	/**
+	 * Intercepts a method execution.
+	 *
+	 * @param context - execution context
+	 * @param next - continues to the next handler
+	 *
+	 * @returns
+	 */
+	intercept(context: ExecutionContext, next: CallHandler): Observable<any> {
+		this._logger.debug('Before...');
+
+		return next.handle().pipe(tap(() => this._logger.debug('After...')));
+	}
+
+	private readonly _logger = new Logger(
+		{{PASCALCASE interceptorName}}Interceptor.name,
+	);
+}
+
+const interceptor = UseInterceptors(new {{PASCALCASE interceptorName}}Interceptor());
+
+export const {{PASCALCASE interceptorName}} = () => interceptor;

package/templates/generate/nestjs/interface.hbs

@@ -0,0 +1,9 @@
+/**
+ * {{PASCALCASE interfaceName}}.
+ */
+export interface {{PASCALCASE interfaceName}} {
+	/**
+	 * A member.
+	 */
+	readonly _member: string;
+}

package/templates/generate/nestjs/middleware.hbs

@@ -0,0 +1,24 @@
+import { type FastifyRequest, type FastifyReply } from 'fastify';
+import { Injectable, type NestMiddleware, Logger } from '@nestjs/common';
+
+/**
+ * User middleware.
+ *
+ * @see https://docs.nestjs.com/middleware
+ */
+@Injectable()
+export class UserMiddleware implements NestMiddleware {
+	/**
+	 * Intercepts requests.
+	 *
+	 * @param req - inbound request
+	 * @param next - continues to the next middleware
+	 */
+	use(req: FastifyRequest, res: FastifyReply, next: () => void): void {
+		this._logger.debug('Middleware triggered');
+
+		next();
+	}
+
+	private readonly _logger = new Logger(UserMiddleware.name);
+}

package/templates/generate/nestjs/module.hbs

@@ -0,0 +1,9 @@
+import { Module } from '@nestjs/common';
+
+@Module({
+  imports: [],
+  controllers: [],
+  providers: [],
+  exports: [],
+})
+export class {{PASCALCASE className}}Module {}

package/templates/generate/nestjs/param-decorator.hbs

@@ -0,0 +1,15 @@
+import { type FastifyRequest } from 'fastify';
+import { createParamDecorator, ExecutionContext } from '@nestjs/common';
+
+/**
+ * {{PASCALCASE decoratorName}} decorator.
+ *
+ * @see https://docs.nestjs.com/custom-decorators
+ */
+export const {{PASCALCASE decoratorName}} = createParamDecorator(
+	(data: unknown, ctx: ExecutionContext) => {
+		const { params }: FastifyRequest = ctx.switchToHttp().getRequest();
+
+		return params;
+	},
+);

package/templates/generate/nestjs/repository.hbs

@@ -0,0 +1,35 @@
+import { Injectable, Provider } from '@nestjs/common';
+
+/**
+ * {{PASCALCASE className}} Repository.
+ * NOTE: import it in your context module at 'providers' array.
+ *
+ * @see https://docs.nestjs.com/Providers
+ */
+@Injectable()
+export class {{PASCALCASE className}}Repository {
+	/**
+	 * Returns sample phrase
+	 *
+	 * @returns sample phrase
+	 */
+	sample(): string {
+		return 'Hello World';
+	}
+
+	constructor() {}
+
+	/**
+	 * Repository initializer for module.
+	 *
+	 * @returns Repository
+	 */
+	static register(): Provider<{{PASCALCASE className}}Repository> {
+		return {
+			provide: {{PASCALCASE className}}Repository,
+			inject: [], // your injected dependencies tokens here
+			useFactory: (/* your dependencies from inject */) =>
+				new {{PASCALCASE className}}Repository(),
+		};
+	}
+}

package/templates/generate/nestjs/service.hbs

@@ -0,0 +1,24 @@
+import { Injectable } from '@nestjs/common';
+
+/**
+ * {{PASCALCASE className}} service.
+ * NOTE: import it in your context module at 'providers' array.
+ *
+ * @see https://docs.nestjs.com/providers
+ */
+@Injectable()
+export class {{PASCALCASE className}}Service {
+	/**
+	 * Sums two numbers.
+	 *
+	 * @param a - any number
+	 * @param b - any number
+	 *
+	 * @returns sum
+	 */
+	sum(a: number, b: number): number {
+		return a + b;
+	}
+
+	constructor() {}
+}

package/templates/generate/nestjs/spec-controller.hbs

@@ -0,0 +1,35 @@
+import { afterAll, beforeAll, describe, expect, test } from 'vitest';
+import { Test, type TestingModule } from '@nestjs/testing';
+import { {{PASCALCASE className}}Controller } from './{{KEBABCASE className}}.controller.ts';
+
+describe({{PASCALCASE className}}Controller, () => {
+	let _module: TestingModule;
+	let _controller: {{PASCALCASE className}}Controller;
+
+	// hooks
+	beforeAll(async () => {
+		_module = await Test.createTestingModule({
+			controllers: [{{PASCALCASE className}}Controller],
+		}).compile();
+
+		_controller = _module.get<{{PASCALCASE className}}Controller>(
+			{{PASCALCASE className}}Controller,
+		);
+
+		// disables logger
+		(_controller as any)._logger?.localInstance.setLogLevels?.([]);
+	});
+
+	afterAll(async () => {
+		await _module.close();
+	});
+
+	// tests
+	test('should be defined', () => {
+		expect(_controller).toBeDefined();
+	});
+
+	test('should return "Hello World"', () => {
+		expect(_controller.run()).toBe('Hello World');
+	});
+});

package/templates/generate/nestjs/spec-repository.hbs

@@ -0,0 +1,32 @@
+import { afterAll, beforeAll, describe, expect, test } from 'vitest';
+import { Test, type TestingModule } from '@nestjs/testing';
+import { {{PASCALCASE className}}Repository } from './{{KEBABCASE className}}.repository.ts';
+
+describe({{PASCALCASE className}}Repository.name, () => {
+	let _module: TestingModule;
+	let _repository: {{PASCALCASE className}}Repository;
+
+	// hooks
+	beforeAll(async () => {
+		_module = await Test.createTestingModule({
+			providers: [{{PASCALCASE className}}Repository.register()],
+		}).compile();
+
+		_repository = _module.get<{{PASCALCASE className}}Repository>(
+			{{PASCALCASE className}}Repository,
+		);
+	});
+
+	afterAll(async () => {
+		await _module.close();
+	});
+
+	// tests
+	test('should be defined', () => {
+		expect(_repository).toBeDefined();
+	});
+
+	test('sample() return "Hello World"', () => {
+		expect(_repository.sample()).toBe('Hello World');
+	});
+});

package/templates/generate/nestjs/spec-service.hbs

@@ -0,0 +1,28 @@
+import { afterAll, beforeAll, describe, expect, test } from 'vitest';
+import { Test, type TestingModule } from '@nestjs/testing';
+import { {{PASCALCASE className}}Service } from './{{KEBABCASE className}}.service.ts';
+
+describe({{PASCALCASE className}}Service.name, () => {
+	let _module: TestingModule;
+	let _service: {{PASCALCASE className}}Service;
+
+	// hooks
+	beforeAll(async () => {
+		_module = await Test.createTestingModule({
+			providers: [{{PASCALCASE className}}Service],
+		}).compile();
+
+		_service = _module.get<{{PASCALCASE className}}Service>(
+			{{PASCALCASE className}}Service,
+		);
+	});
+
+	afterAll(async () => {
+		await _module.close();
+	});
+
+	// tests
+	test('1 + 1 should sum 2', () => {
+		expect(_service.sum(1, 1)).toBe(2);
+	});
+});

package/templates/generate/nestjs/spec.hbs

@@ -0,0 +1,8 @@
+import { describe, expect, test } from 'vitest';
+
+describe('{{className}}', () => {
+	// tests
+	test('1 to be 1', () => {
+		expect(1).toBe(1);
+	});
+});