nodejs-quickstart-structure 1.19.0 → 1.19.1

package/templates/clean-architecture/ts/src/interfaces/routes/userRoutes.spec.ts.ejs

@@ -1,40 +1,40 @@
-import request from 'supertest';
-import express, { Express } from 'express';
-import router from '@/interfaces/routes/userRoutes';
-
-const mockGetUsers = jest.fn().mockImplementation((req, res) => res.status(200).json([{ id: '1', name: 'John Doe' }]));
-const mockCreateUser = jest.fn().mockImplementation((req, res) => res.status(201).json({ id: '1', name: 'Test' }));
-
-jest.mock('@/interfaces/controllers/userController', () => {
-  return {
-    UserController: jest.fn().mockImplementation(() => ({
-      getUsers: (...args: unknown[]) => mockGetUsers(...args),
-      createUser: (...args: unknown[]) => mockCreateUser(...args)
-    }))
-  };
-});
-
-describe('UserRoutes', () => {
-    let app: Express;
-
-    beforeEach(() => {
-        app = express();
-        app.use(express.json());
-        app.use('/users', router);
-    });
-
-    it('POST /users should call controller.createUser', async () => {
-        await request(app)
-            .post('/users')
-            .send({ name: 'Test', email: 'test@example.com' });
-
-        expect(mockCreateUser).toHaveBeenCalledTimes(1);
-    });
-
-    it('GET /users should call controller.getUsers', async () => {
-        await request(app)
-            .get('/users');
-
-        expect(mockGetUsers).toHaveBeenCalledTimes(1);
-    });
-});
+import request from 'supertest';
+import express, { Express } from 'express';
+import router from '@/interfaces/routes/userRoutes';
+
+const mockGetUsers = jest.fn().mockImplementation((req, res) => res.status(200).json([{ id: '1', name: 'John Doe' }]));
+const mockCreateUser = jest.fn().mockImplementation((req, res) => res.status(201).json({ id: '1', name: 'Test' }));
+
+jest.mock('@/interfaces/controllers/userController', () => {
+  return {
+    UserController: jest.fn().mockImplementation(() => ({
+      getUsers: (...args: unknown[]) => mockGetUsers(...args),
+      createUser: (...args: unknown[]) => mockCreateUser(...args)
+    }))
+  };
+});
+
+describe('UserRoutes', () => {
+    let app: Express;
+
+    beforeEach(() => {
+        app = express();
+        app.use(express.json());
+        app.use('/users', router);
+    });
+
+    it('POST /users should call controller.createUser', async () => {
+        await request(app)
+            .post('/users')
+            .send({ name: 'Test', email: 'test@example.com' });
+
+        expect(mockCreateUser).toHaveBeenCalledTimes(1);
+    });
+
+    it('GET /users should call controller.getUsers', async () => {
+        await request(app)
+            .get('/users');
+
+        expect(mockGetUsers).toHaveBeenCalledTimes(1);
+    });
+});

package/templates/clean-architecture/ts/src/usecases/createUser.spec.ts.ejs

@@ -1,51 +1,51 @@
-import CreateUser from '@/usecases/createUser';
-import { UserRepository } from '@/infrastructure/repositories/UserRepository';
-<%_ if (caching !== 'None') { -%>
-import cacheService from '<% if (caching === "Redis") { %>@/infrastructure/caching/redisClient<% } else { %>@/infrastructure/caching/memoryCache<% } %>';
-<%_ } -%>
-
-jest.mock('@/infrastructure/repositories/UserRepository');
-<%_ if (caching !== 'None') { -%>
-jest.mock('<% if (caching === "Redis") { %>@/infrastructure/caching/redisClient<% } else { %>@/infrastructure/caching/memoryCache<% } %>', () => ({
-    get: jest.fn(),
-    set: jest.fn(),
-    del: jest.fn()
-}));
-<%_ } -%>
-
-describe('CreateUser UseCase', () => {
-    let createUser: CreateUser;
-    let mockUserRepository: jest.Mocked<UserRepository>;
-
-    beforeEach(() => {
-        mockUserRepository = new UserRepository() as jest.Mocked<UserRepository>;
-        createUser = new CreateUser(mockUserRepository);
-        jest.clearAllMocks();
-    });
-
-    it('should create and save a new user', async () => {
-        const name = 'Test User';
-        const email = 'test@example.com';
-        const expectedResult = { id: 1, name, email };
-
-        mockUserRepository.save.mockResolvedValue(expectedResult as any);
-
-        const result = await createUser.execute(name, email);
-
-        expect(mockUserRepository.save).toHaveBeenCalledTimes(1);
-        const savedUser = mockUserRepository.save.mock.calls[0][0];
-        expect(savedUser.name).toBe(name);
-        expect(savedUser.email).toBe(email);
-        expect(result).toEqual(expectedResult);
-<%_ if (caching !== 'None') { -%>
-        expect(cacheService.del).toHaveBeenCalledWith('users:all');
-<%_ } %>
-    });
-
-    it('should throw an error if repository fails', async () => {
-        const error = new Error('Database error');
-        mockUserRepository.save.mockRejectedValue(error);
-
-        await expect(createUser.execute('Test', 'test@test.com')).rejects.toThrow(error);
-    });
-});
+import CreateUser from '@/usecases/createUser';
+import { UserRepository } from '@/infrastructure/repositories/UserRepository';
+<%_ if (caching !== 'None') { -%>
+import cacheService from '<% if (caching === "Redis") { %>@/infrastructure/caching/redisClient<% } else { %>@/infrastructure/caching/memoryCache<% } %>';
+<%_ } -%>
+
+jest.mock('@/infrastructure/repositories/UserRepository');
+<%_ if (caching !== 'None') { -%>
+jest.mock('<% if (caching === "Redis") { %>@/infrastructure/caching/redisClient<% } else { %>@/infrastructure/caching/memoryCache<% } %>', () => ({
+    get: jest.fn(),
+    set: jest.fn(),
+    del: jest.fn()
+}));
+<%_ } -%>
+
+describe('CreateUser UseCase', () => {
+    let createUser: CreateUser;
+    let mockUserRepository: jest.Mocked<UserRepository>;
+
+    beforeEach(() => {
+        mockUserRepository = new UserRepository() as jest.Mocked<UserRepository>;
+        createUser = new CreateUser(mockUserRepository);
+        jest.clearAllMocks();
+    });
+
+    it('should create and save a new user', async () => {
+        const name = 'Test User';
+        const email = 'test@example.com';
+        const expectedResult = { id: 1, name, email };
+
+        mockUserRepository.save.mockResolvedValue(expectedResult as any);
+
+        const result = await createUser.execute(name, email);
+
+        expect(mockUserRepository.save).toHaveBeenCalledTimes(1);
+        const savedUser = mockUserRepository.save.mock.calls[0][0];
+        expect(savedUser.name).toBe(name);
+        expect(savedUser.email).toBe(email);
+        expect(result).toEqual(expectedResult);
+<%_ if (caching !== 'None') { -%>
+        expect(cacheService.del).toHaveBeenCalledWith('users:all');
+<%_ } %>
+    });
+
+    it('should throw an error if repository fails', async () => {
+        const error = new Error('Database error');
+        mockUserRepository.save.mockRejectedValue(error);
+
+        await expect(createUser.execute('Test', 'test@test.com')).rejects.toThrow(error);
+    });
+});

package/templates/clean-architecture/ts/src/usecases/createUser.ts

@@ -1,13 +1,13 @@
-import { User } from '@/domain/user';
-
-import { UserRepository } from '@/infrastructure/repositories/UserRepository';
-
-export default class CreateUser {
-    constructor(private userRepository: UserRepository) {}
-
-    async execute(name: string, email: string) {
-        const user = new User(null, name, email);
-        return this.userRepository.save(user);
-    }
-}
-
+import { User } from '@/domain/user';
+
+import { UserRepository } from '@/infrastructure/repositories/UserRepository';
+
+export default class CreateUser {
+    constructor(private userRepository: UserRepository) {}
+
+    async execute(name: string, email: string) {
+        const user = new User(null, name, email);
+        return this.userRepository.save(user);
+    }
+}
+

package/templates/clean-architecture/ts/src/usecases/getAllUsers.spec.ts.ejs

@@ -1,63 +1,63 @@
-import GetAllUsers from '@/usecases/getAllUsers';
-import { UserRepository } from '@/infrastructure/repositories/UserRepository';
-<%_ if (caching !== 'None') { -%>
-import cacheService from '<% if (caching === "Redis") { %>@/infrastructure/caching/redisClient<% } else { %>@/infrastructure/caching/memoryCache<% } %>';
-<%_ } -%>
-
-jest.mock('@/infrastructure/repositories/UserRepository');
-<%_ if (caching !== 'None') { -%>
-jest.mock('<% if (caching === "Redis") { %>@/infrastructure/caching/redisClient<% } else { %>@/infrastructure/caching/memoryCache<% } %>', () => ({
-    get: jest.fn(),
-    set: jest.fn(),
-    del: jest.fn()
-}));
-<%_ } -%>
-
-describe('GetAllUsers UseCase', () => {
-    let getAllUsers: GetAllUsers;
-    let mockUserRepository: jest.Mocked<UserRepository>;
-
-    beforeEach(() => {
-        mockUserRepository = new UserRepository() as jest.Mocked<UserRepository>;
-        getAllUsers = new GetAllUsers(mockUserRepository);
-        jest.clearAllMocks();
-    });
-
-    it('should retrieve all users', async () => {
-        const expectedUsers = [{ id: 1, name: 'Alice', email: 'alice@example.com' }];
-        mockUserRepository.getUsers.mockResolvedValue(expectedUsers as any);
-<%_ if (caching !== 'None') { -%>
-        (cacheService.get as jest.Mock).mockResolvedValue(null);
-<%_ } %>
-
-        const result = await getAllUsers.execute();
-
-        expect(mockUserRepository.getUsers).toHaveBeenCalledTimes(1);
-        expect(result).toEqual(expectedUsers);
-<%_ if (caching !== 'None') { -%>
-        expect(cacheService.set).toHaveBeenCalled();
-<%_ } %>
-    });
-
-<%_ if (caching !== 'None') { -%>
-    it('should return from cache if available', async () => {
-        const cachedUsers = [{ id: 1, name: 'Cached', email: 'cached@example.com' }];
-        (cacheService.get as jest.Mock).mockResolvedValue(cachedUsers);
-
-        const result = await getAllUsers.execute();
-
-        expect(mockUserRepository.getUsers).not.toHaveBeenCalled();
-        expect(result).toEqual(cachedUsers);
-    });
-<%_ } -%>
-
-    it('should throw an error if repository fails', async () => {
-        const error = new Error('Database error');
-        mockUserRepository.getUsers.mockRejectedValue(error);
-<%_ if (caching !== 'None') { -%>
-        (cacheService.get as jest.Mock).mockResolvedValue(null);
-<%_ } -%>
-
-        await expect(getAllUsers.execute()).rejects.toThrow(error);
-    });
-});
+import GetAllUsers from '@/usecases/getAllUsers';
+import { UserRepository } from '@/infrastructure/repositories/UserRepository';
+<%_ if (caching !== 'None') { -%>
+import cacheService from '<% if (caching === "Redis") { %>@/infrastructure/caching/redisClient<% } else { %>@/infrastructure/caching/memoryCache<% } %>';
+<%_ } -%>
+
+jest.mock('@/infrastructure/repositories/UserRepository');
+<%_ if (caching !== 'None') { -%>
+jest.mock('<% if (caching === "Redis") { %>@/infrastructure/caching/redisClient<% } else { %>@/infrastructure/caching/memoryCache<% } %>', () => ({
+    get: jest.fn(),
+    set: jest.fn(),
+    del: jest.fn()
+}));
+<%_ } -%>
+
+describe('GetAllUsers UseCase', () => {
+    let getAllUsers: GetAllUsers;
+    let mockUserRepository: jest.Mocked<UserRepository>;
+
+    beforeEach(() => {
+        mockUserRepository = new UserRepository() as jest.Mocked<UserRepository>;
+        getAllUsers = new GetAllUsers(mockUserRepository);
+        jest.clearAllMocks();
+    });
+
+    it('should retrieve all users', async () => {
+        const expectedUsers = [{ id: 1, name: 'Alice', email: 'alice@example.com' }];
+        mockUserRepository.getUsers.mockResolvedValue(expectedUsers as any);
+<%_ if (caching !== 'None') { -%>
+        (cacheService.get as jest.Mock).mockResolvedValue(null);
+<%_ } %>
+
+        const result = await getAllUsers.execute();
+
+        expect(mockUserRepository.getUsers).toHaveBeenCalledTimes(1);
+        expect(result).toEqual(expectedUsers);
+<%_ if (caching !== 'None') { -%>
+        expect(cacheService.set).toHaveBeenCalled();
+<%_ } %>
+    });
+
+<%_ if (caching !== 'None') { -%>
+    it('should return from cache if available', async () => {
+        const cachedUsers = [{ id: 1, name: 'Cached', email: 'cached@example.com' }];
+        (cacheService.get as jest.Mock).mockResolvedValue(cachedUsers);
+
+        const result = await getAllUsers.execute();
+
+        expect(mockUserRepository.getUsers).not.toHaveBeenCalled();
+        expect(result).toEqual(cachedUsers);
+    });
+<%_ } -%>
+
+    it('should throw an error if repository fails', async () => {
+        const error = new Error('Database error');
+        mockUserRepository.getUsers.mockRejectedValue(error);
+<%_ if (caching !== 'None') { -%>
+        (cacheService.get as jest.Mock).mockResolvedValue(null);
+<%_ } -%>
+
+        await expect(getAllUsers.execute()).rejects.toThrow(error);
+    });
+});

package/templates/clean-architecture/ts/src/usecases/getAllUsers.ts

@@ -1,10 +1,10 @@
-import { UserRepository } from '@/infrastructure/repositories/UserRepository';
-
-export default class GetAllUsers {
-    constructor(private userRepository: UserRepository) {}
-
-    async execute() {
-        return this.userRepository.getUsers();
-    }
-}
-
+import { UserRepository } from '@/infrastructure/repositories/UserRepository';
+
+export default class GetAllUsers {
+    constructor(private userRepository: UserRepository) {}
+
+    async execute() {
+        return this.userRepository.getUsers();
+    }
+}
+

package/templates/clean-architecture/ts/src/utils/errorMiddleware.ts.ejs

@@ -1,27 +1,27 @@
-import { Request, Response } from 'express';
-import logger from '@/infrastructure/log/logger';
-import { ApiError } from '@/errors/ApiError';
-import { HTTP_STATUS } from '@/utils/httpCodes';
-
-export const errorMiddleware = (err: Error, req: Request, res: Response, _next: unknown) => {
-  let error = err;
-
-  if (!(error instanceof ApiError)) {
-    const statusCode = HTTP_STATUS.INTERNAL_SERVER_ERROR;
-    const message = error.message || 'Internal Server Error';
-    error = new ApiError(statusCode, message, false, err.stack);
-  }
-
-  const { statusCode, message } = error as ApiError;
-
-  if (statusCode === HTTP_STATUS.INTERNAL_SERVER_ERROR) {
-    logger.error(`${statusCode} - ${message} - ${req.originalUrl} - ${req.method} - ${req.ip}`);
-    logger.error(error.stack || 'No stack trace');
-  }
-
-  res.status(statusCode).json({
-    statusCode,
-    message,
-    ...(process.env.NODE_ENV === 'development' && { stack: error.stack }),
-  });
-};
+import { Request, Response } from 'express';
+import logger from '@/infrastructure/log/logger';
+import { ApiError } from '@/errors/ApiError';
+import { HTTP_STATUS } from '@/utils/httpCodes';
+
+export const errorMiddleware = (err: Error, req: Request, res: Response, _next: unknown) => {
+  let error = err;
+
+  if (!(error instanceof ApiError)) {
+    const statusCode = HTTP_STATUS.INTERNAL_SERVER_ERROR;
+    const message = error.message || 'Internal Server Error';
+    error = new ApiError(statusCode, message, false, err.stack);
+  }
+
+  const { statusCode, message } = error as ApiError;
+
+  if (statusCode === HTTP_STATUS.INTERNAL_SERVER_ERROR) {
+    logger.error(`${statusCode} - ${message} - ${req.originalUrl} - ${req.method} - ${req.ip}`);
+    logger.error(error.stack || 'No stack trace');
+  }
+
+  res.status(statusCode).json({
+    statusCode,
+    message,
+    ...(process.env.NODE_ENV === 'development' && { stack: error.stack }),
+  });
+};

package/templates/clean-architecture/ts/src/utils/httpCodes.ts

@@ -1,7 +1,7 @@
-export const HTTP_STATUS = {
-    OK: 200,
-    CREATED: 201,
-    BAD_REQUEST: 400,
-    NOT_FOUND: 404,
-    INTERNAL_SERVER_ERROR: 500
-} as const;
+export const HTTP_STATUS = {
+    OK: 200,
+    CREATED: 201,
+    BAD_REQUEST: 400,
+    NOT_FOUND: 404,
+    INTERNAL_SERVER_ERROR: 500
+} as const;

package/templates/common/.cursorrules.ejs

@@ -1,60 +1,60 @@
-# Cursor AI Coding Rules for <%= projectName %>
-
-## Project Context
-You are an expert working on **<%= projectName %>**.
-- **Project Goal**: [Replace this with your business logic, e.g., E-commerce API]
-- **Language**: <%= language %>
-- **Architecture**: <%= architecture %>
-- **Database**: <%= database %>
-- **Communication**: <%= communication %>
-
-## Excluded Files/Folders
-When indexing or searching the workspace, ignore the following paths to prevent context pollution:
-- `node_modules/`
-- `dist/`
-- `build/`
-- `coverage/`
-- `.git/`
-
-## Strict Rules
-
-### 1. Testing First
-- Every new service or controller method MUST have a test file in `tests/`.
-- **Coverage Gate**: Aim for > 80% coverage (Statement/Line/Function/Branch).
-- **Format**: Use Jest with the AAA (Arrange, Act, Assert) pattern.
-- **Isolation**: Mock external dependencies (DB, Redis, etc.) using `jest.mock()`.
-
-### 2. Error Handling
-- Do NOT use generic `Error`.
-- Use custom classes from `src/errors/` (e.g., `ApiError`, `NotFoundError`, `BadRequestError`).
-<% if (language === 'TypeScript') { -%>
-- Use `HTTP_STATUS` constants from `@/utils/httpCodes` for status codes.
-<% } else { -%>
-- Use `HTTP_STATUS` constants from `../utils/httpCodes.js` for status codes.
-<% } -%>
-
-### 3. File Naming & Style
-- **Controllers**: camelCase (e.g., `userController.<% if (language === 'TypeScript') { %>ts<% } else { %>js<% } %>`).
-- **Services**: camelCase (e.g., `userService.<% if (language === 'TypeScript') { %>ts<% } else { %>js<% } %>`).
-- **Routes**: camelCase (e.g., `userRoutes.<% if (language === 'TypeScript') { %>ts<% } else { %>js<% } %>`).
-<% if (language === 'TypeScript') { -%>
-- **Imports**: Use path aliases (e.g., `@/services/...`) instead of relative paths.
-- **Typing**: Ensure strong typing for interfaces and DTOs. Do not use `any` unless absolutely necessary.
-<% } else { -%>
-- **Imports**: Use relative paths as dictated by the directory structure.
-<% } -%>
-
-### 4. Architecture Standards
-<% if (architecture === 'Clean Architecture') { -%>
-- Enforce strict separation of concerns:
-  - `domain`: Entities and enterprise business rules.
-  - `usecases`: Application business rules.
-  - `interfaces`: Controllers and Routes.
-  - `infrastructure`: Frameworks, Database, Caching, and Web Server.
-- Dependencies point inward toward the `domain`.
-<% } else { -%>
-- Enforce MVC standards:
-  - `models`: Data layer.
-  - `controllers`: Request handlers and business logic.
-  - `routes`: Define endpoints routing to controllers.
-<% } -%>
+# Cursor AI Coding Rules for <%= projectName %>
+
+## Project Context
+You are an expert working on **<%= projectName %>**.
+- **Project Goal**: [Replace this with your business logic, e.g., E-commerce API]
+- **Language**: <%= language %>
+- **Architecture**: <%= architecture %>
+- **Database**: <%= database %>
+- **Communication**: <%= communication %>
+
+## Excluded Files/Folders
+When indexing or searching the workspace, ignore the following paths to prevent context pollution:
+- `node_modules/`
+- `dist/`
+- `build/`
+- `coverage/`
+- `.git/`
+
+## Strict Rules
+
+### 1. Testing First
+- Every new service or controller method MUST have a test file in `tests/`.
+- **Coverage Gate**: Aim for > 80% coverage (Statement/Line/Function/Branch).
+- **Format**: Use Jest with the AAA (Arrange, Act, Assert) pattern.
+- **Isolation**: Mock external dependencies (DB, Redis, etc.) using `jest.mock()`.
+
+### 2. Error Handling
+- Do NOT use generic `Error`.
+- Use custom classes from `src/errors/` (e.g., `ApiError`, `NotFoundError`, `BadRequestError`).
+<% if (language === 'TypeScript') { -%>
+- Use `HTTP_STATUS` constants from `@/utils/httpCodes` for status codes.
+<% } else { -%>
+- Use `HTTP_STATUS` constants from `../utils/httpCodes.js` for status codes.
+<% } -%>
+
+### 3. File Naming & Style
+- **Controllers**: camelCase (e.g., `userController.<% if (language === 'TypeScript') { %>ts<% } else { %>js<% } %>`).
+- **Services**: camelCase (e.g., `userService.<% if (language === 'TypeScript') { %>ts<% } else { %>js<% } %>`).
+- **Routes**: camelCase (e.g., `userRoutes.<% if (language === 'TypeScript') { %>ts<% } else { %>js<% } %>`).
+<% if (language === 'TypeScript') { -%>
+- **Imports**: Use path aliases (e.g., `@/services/...`) instead of relative paths.
+- **Typing**: Ensure strong typing for interfaces and DTOs. Do not use `any` unless absolutely necessary.
+<% } else { -%>
+- **Imports**: Use relative paths as dictated by the directory structure.
+<% } -%>
+
+### 4. Architecture Standards
+<% if (architecture === 'Clean Architecture') { -%>
+- Enforce strict separation of concerns:
+  - `domain`: Entities and enterprise business rules.
+  - `usecases`: Application business rules.
+  - `interfaces`: Controllers and Routes.
+  - `infrastructure`: Frameworks, Database, Caching, and Web Server.
+- Dependencies point inward toward the `domain`.
+<% } else { -%>
+- Enforce MVC standards:
+  - `models`: Data layer.
+  - `controllers`: Request handlers and business logic.
+  - `routes`: Define endpoints routing to controllers.
+<% } -%>

package/templates/common/.dockerignore

@@ -1,12 +1,12 @@
-node_modules
-npm-debug.log
-dist
-.env
-.git
-.gitignore
-README.md
-docker-compose.yml
-test_results.log
-flyway/sql
-.cursorrules
-prompts
+node_modules
+npm-debug.log
+dist
+.env
+.git
+.gitignore
+README.md
+docker-compose.yml
+test_results.log
+flyway/sql
+.cursorrules
+prompts