nodejs-quickstart-structure 1.19.0 → 2.0.0

package/templates/common/_github/workflows/ci.yml.ejs

@@ -1,46 +1,46 @@
-name: Node.js CI
-
-env:
-  FORCE_JAVASCRIPT_ACTIONS_TO_NODE24: 'true'
-
-on:
-  push:
-    branches: [ "main" ]
-  pull_request:
-    branches: [ "main" ]
-
-jobs:
-  build:
-
-    runs-on: ubuntu-latest
-
-    steps:
-    - uses: actions/checkout@v4
-    
-    - name: Use Node.js 22.x
-      uses: actions/setup-node@v4
-      with:
-        node-version: 22.x
-        cache: 'npm'
-        
-    - name: Install Dependencies
-      run: npm ci
-      
-    - name: Lint Code
-      run: npm run lint
-      
-    - name: Run Unit Tests
-      run: npm run test:coverage
-      
-    - name: Run E2E Tests
-      run: npm run test:e2e
-      
-    - name: Build
-      run: npm run build --if-present
-<% if (includeSecurity) { %>
-    - name: SonarQube Scan
-      uses: SonarSource/sonarqube-scan-action@master
-      env:
-        SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
-        SONAR_HOST_URL: ${{ secrets.SONAR_HOST_URL }}
-<% } %>
+name: Node.js CI
+
+env:
+  FORCE_JAVASCRIPT_ACTIONS_TO_NODE24: 'true'
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+    
+    - name: Use Node.js 22.x
+      uses: actions/setup-node@v4
+      with:
+        node-version: 22.x
+        cache: 'npm'
+        
+    - name: Install Dependencies
+      run: npm ci
+      
+    - name: Lint Code
+      run: npm run lint
+      
+    - name: Run Unit Tests
+      run: npm run test:coverage
+      
+    - name: Run E2E Tests
+      run: npm run test:e2e
+      
+    - name: Build
+      run: npm run build --if-present
+<% if (includeSecurity) { %>
+    - name: SonarQube Scan
+      uses: SonarSource/sonarqube-scan-action@master
+      env:
+        SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
+        SONAR_HOST_URL: ${{ secrets.SONAR_HOST_URL }}
+<% } %>

package/templates/common/_github/workflows/security.yml.ejs

@@ -1,36 +1,36 @@
-name: Enterprise Security Scan
-
-on:
-  push:
-    branches: [ "main" ]
-  pull_request:
-    branches: [ "main" ]
-  schedule:
-    - cron: '0 0 * * 1' # Weekly scan
-
-jobs:
-  node-security:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-
-      - name: Run Snyk to check for vulnerabilities
-        uses: snyk/actions/node@master
-        env:
-          SNYK_TOKEN: ${{ secrets.SNYK_TOKEN }}
-        with:
-          args: --severity-threshold=high
-
-  container-security:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - name: Build Docker image
-        run: docker build -t <%= projectName %>:latest .
-      - name: Run Snyk to check Docker image for vulnerabilities
-        uses: snyk/actions/docker@master
-        env:
-          SNYK_TOKEN: ${{ secrets.SNYK_TOKEN }}
-        with:
-          image: <%= projectName %>:latest
-          args: --file=Dockerfile --severity-threshold=high --skip-unused-projects
+name: Enterprise Security Scan
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+  schedule:
+    - cron: '0 0 * * 1' # Weekly scan
+
+jobs:
+  node-security:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Run Snyk to check for vulnerabilities
+        uses: snyk/actions/node@master
+        env:
+          SNYK_TOKEN: ${{ secrets.SNYK_TOKEN }}
+        with:
+          args: --severity-threshold=high
+
+  container-security:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Build Docker image
+        run: docker build -t <%= projectName %>:latest .
+      - name: Run Snyk to check Docker image for vulnerabilities
+        uses: snyk/actions/docker@master
+        env:
+          SNYK_TOKEN: ${{ secrets.SNYK_TOKEN }}
+        with:
+          image: <%= projectName %>:latest
+          args: --file=Dockerfile --severity-threshold=high --skip-unused-projects

package/templates/common/_gitignore

@@ -1,5 +1,5 @@
-node_modules
-dist
-.env
-.DS_Store
-coverage
+node_modules
+dist
+.env
+.DS_Store
+coverage

package/templates/common/_husky/pre-commit

@@ -1,4 +1,4 @@
-#!/usr/bin/env sh
-. "$(dirname -- "$0")/_/husky.sh"
-
-npx lint-staged
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+npx lint-staged

package/templates/common/caching/clean/js/CreateUser.js.ejs

@@ -1,29 +1,29 @@
-const User = require('../domain/models/User');
-<%_ if (caching === 'Redis') { -%>
-const cacheService = require('../infrastructure/caching/redisClient');
-<%_ } else if (caching === 'Memory Cache') { -%>
-const cacheService = require('../infrastructure/caching/memoryCache');
-<%_ } -%>
-const logger = require('../infrastructure/log/logger');
-
-class CreateUser {
-    constructor(userRepository) {
-        this.userRepository = userRepository;
-    }
-
-    async execute(name, email) {
-        const user = new User(null, name, email);
-        const savedUser = await this.userRepository.save(user);
-
-        try {
-            await cacheService.del('users:all');
-            logger.info('Invalidated users:all cache');
-        } catch (error) {
-            logger.error('Cache error (del):', error);
-        }
-
-        return savedUser;
-    }
-}
-
-module.exports = CreateUser;
+const User = require('../domain/models/User');
+<%_ if (caching === 'Redis') { -%>
+const cacheService = require('../infrastructure/caching/redisClient');
+<%_ } else if (caching === 'Memory Cache') { -%>
+const cacheService = require('../infrastructure/caching/memoryCache');
+<%_ } -%>
+const logger = require('../infrastructure/log/logger');
+
+class CreateUser {
+    constructor(userRepository) {
+        this.userRepository = userRepository;
+    }
+
+    async execute(name, email) {
+        const user = new User(null, name, email);
+        const savedUser = await this.userRepository.save(user);
+
+        try {
+            await cacheService.del('users:all');
+            logger.info('Invalidated users:all cache');
+        } catch (error) {
+            logger.error('Cache error (del):', error);
+        }
+
+        return savedUser;
+    }
+}
+
+module.exports = CreateUser;

package/templates/common/caching/clean/js/GetAllUsers.js.ejs

@@ -1,37 +1,37 @@
-<%_ if (caching === 'Redis') { -%>
-const cacheService = require('../infrastructure/caching/redisClient');
-<%_ } else if (caching === 'Memory Cache') { -%>
-const cacheService = require('../infrastructure/caching/memoryCache');
-<%_ } -%>
-const logger = require('../infrastructure/log/logger');
-
-class GetAllUsers {
-    constructor(userRepository) {
-        this.userRepository = userRepository;
-    }
-
-    async execute() {
-        const cacheKey = 'users:all';
-        try {
-            const cachedUsers = await cacheService.get(cacheKey);
-            if (cachedUsers) {
-                logger.info('Serving users from cache');
-                return cachedUsers;
-            }
-        } catch (error) {
-            logger.error('Cache error (get):', error);
-        }
-
-        const users = await this.userRepository.getUsers();
-
-        try {
-            await cacheService.set(cacheKey, users, 60);
-        } catch (error) {
-            logger.error('Cache error (set):', error);
-        }
-
-        return users;
-    }
-}
-
-module.exports = GetAllUsers;
+<%_ if (caching === 'Redis') { -%>
+const cacheService = require('../infrastructure/caching/redisClient');
+<%_ } else if (caching === 'Memory Cache') { -%>
+const cacheService = require('../infrastructure/caching/memoryCache');
+<%_ } -%>
+const logger = require('../infrastructure/log/logger');
+
+class GetAllUsers {
+    constructor(userRepository) {
+        this.userRepository = userRepository;
+    }
+
+    async execute() {
+        const cacheKey = 'users:all';
+        try {
+            const cachedUsers = await cacheService.get(cacheKey);
+            if (cachedUsers) {
+                logger.info('Serving users from cache');
+                return cachedUsers;
+            }
+        } catch (error) {
+            logger.error('Cache error (get):', error);
+        }
+
+        const users = await this.userRepository.getUsers();
+
+        try {
+            await cacheService.set(cacheKey, users, 60);
+        } catch (error) {
+            logger.error('Cache error (set):', error);
+        }
+
+        return users;
+    }
+}
+
+module.exports = GetAllUsers;

package/templates/common/caching/clean/ts/createUser.ts.ejs

@@ -1,27 +1,27 @@
-import { User } from '@/domain/user';
-
-import { UserRepository } from '@/infrastructure/repositories/UserRepository';
-<%_ if (caching === 'Redis') { -%>
-import cacheService from '@/infrastructure/caching/redisClient';
-<%_ } else if (caching === 'Memory Cache') { -%>
-import cacheService from '@/infrastructure/caching/memoryCache';
-<%_ } -%>
-import logger from '@/infrastructure/log/logger';
-
-export default class CreateUser {
-    constructor(private userRepository: UserRepository) {}
-
-    async execute(name: string, email: string) {
-        const user = new User(null, name, email);
-        const savedUser = await this.userRepository.save(user);
-
-        try {
-            await cacheService.del('users:all');
-            logger.info('Invalidated users:all cache');
-        } catch (error) {
-            logger.error('Cache error (del):', error);
-        }
-
-        return savedUser;
-    }
-}
+import { User } from '@/domain/user';
+
+import { UserRepository } from '@/infrastructure/repositories/UserRepository';
+<%_ if (caching === 'Redis') { -%>
+import cacheService from '@/infrastructure/caching/redisClient';
+<%_ } else if (caching === 'Memory Cache') { -%>
+import cacheService from '@/infrastructure/caching/memoryCache';
+<%_ } -%>
+import logger from '@/infrastructure/log/logger';
+
+export default class CreateUser {
+    constructor(private userRepository: UserRepository) {}
+
+    async execute(name: string, email: string) {
+        const user = new User(null, name, email);
+        const savedUser = await this.userRepository.save(user);
+
+        try {
+            await cacheService.del('users:all');
+            logger.info('Invalidated users:all cache');
+        } catch (error) {
+            logger.error('Cache error (del):', error);
+        }
+
+        return savedUser;
+    }
+}

package/templates/common/caching/clean/ts/getAllUsers.ts.ejs

@@ -1,34 +1,34 @@
-import { UserRepository } from '@/infrastructure/repositories/UserRepository';
-<%_ if (caching === 'Redis') { -%>
-import cacheService from '@/infrastructure/caching/redisClient';
-<%_ } else if (caching === 'Memory Cache') { -%>
-import cacheService from '@/infrastructure/caching/memoryCache';
-<%_ } -%>
-import logger from '@/infrastructure/log/logger';
-
-export default class GetAllUsers {
-    constructor(private userRepository: UserRepository) {}
-
-    async execute() {
-        const cacheKey = 'users:all';
-        try {
-            const cachedUsers = await cacheService.get(cacheKey);
-            if (cachedUsers) {
-                logger.info('Serving users from cache');
-                return cachedUsers;
-            }
-        } catch (error) {
-            logger.error('Cache error (get):', error);
-        }
-
-        const users = await this.userRepository.getUsers();
-
-        try {
-            await cacheService.set(cacheKey, users, 60);
-        } catch (error) {
-            logger.error('Cache error (set):', error);
-        }
-
-        return users;
-    }
-}
+import { UserRepository } from '@/infrastructure/repositories/UserRepository';
+<%_ if (caching === 'Redis') { -%>
+import cacheService from '@/infrastructure/caching/redisClient';
+<%_ } else if (caching === 'Memory Cache') { -%>
+import cacheService from '@/infrastructure/caching/memoryCache';
+<%_ } -%>
+import logger from '@/infrastructure/log/logger';
+
+export default class GetAllUsers {
+    constructor(private userRepository: UserRepository) {}
+
+    async execute() {
+        const cacheKey = 'users:all';
+        try {
+            const cachedUsers = await cacheService.get(cacheKey);
+            if (cachedUsers) {
+                logger.info('Serving users from cache');
+                return cachedUsers;
+            }
+        } catch (error) {
+            logger.error('Cache error (get):', error);
+        }
+
+        const users = await this.userRepository.getUsers();
+
+        try {
+            await cacheService.set(cacheKey, users, 60);
+        } catch (error) {
+            logger.error('Cache error (set):', error);
+        }
+
+        return users;
+    }
+}

package/templates/common/caching/js/memoryCache.js.ejs

@@ -1,60 +1,60 @@
-const NodeCache = require('node-cache');
-const logger = require('<%- loggerPath %>');
-
-class MemoryCacheService {
-    constructor() {
-        // Default TTL of 0 (unlimited), check period of 120s
-        this.cache = new NodeCache({ stdTTL: 0, checkperiod: 120 });
-        logger.info('Memory Cache initialized');
-    }
-
-    static getInstance() {
-        if (!MemoryCacheService.instance) {
-            MemoryCacheService.instance = new MemoryCacheService();
-        }
-        return MemoryCacheService.instance;
-    }
-
-    async get(key) {
-        try {
-            const data = this.cache.get(key);
-            if (data === undefined) return null;
-            return typeof data === 'string' ? JSON.parse(data) : data;
-        } catch (error) {
-            logger.error(`Memory Cache get error for key ${key}:`, error);
-            return null;
-        }
-    }
-
-    async set(key, value, ttl) {
-        try {
-            const data = JSON.stringify(value);
-            if (ttl) {
-                this.cache.set(key, data, ttl);
-            } else {
-                this.cache.set(key, data);
-            }
-        } catch (error) {
-            logger.error(`Memory Cache set error for key ${key}:`, error);
-        }
-    }
-
-    async del(key) {
-        try {
-            this.cache.del(key);
-        } catch (error) {
-            logger.error(`Memory Cache del error for key ${key}:`, error);
-        }
-    }
-
-    async getOrSet(key, fetcher, ttl = 3600) {
-        const cached = await this.get(key);
-        if (cached) return cached;
-
-        const data = await fetcher();
-        if (data) await this.set(key, data, ttl);
-        return data;
-    }
-}
-
-module.exports = MemoryCacheService.getInstance();
+const NodeCache = require('node-cache');
+const logger = require('<%- loggerPath %>');
+
+class MemoryCacheService {
+    constructor() {
+        // Default TTL of 0 (unlimited), check period of 120s
+        this.cache = new NodeCache({ stdTTL: 0, checkperiod: 120 });
+        logger.info('Memory Cache initialized');
+    }
+
+    static getInstance() {
+        if (!MemoryCacheService.instance) {
+            MemoryCacheService.instance = new MemoryCacheService();
+        }
+        return MemoryCacheService.instance;
+    }
+
+    async get(key) {
+        try {
+            const data = this.cache.get(key);
+            if (data === undefined) return null;
+            return typeof data === 'string' ? JSON.parse(data) : data;
+        } catch (error) {
+            logger.error(`Memory Cache get error for key ${key}:`, error);
+            return null;
+        }
+    }
+
+    async set(key, value, ttl) {
+        try {
+            const data = JSON.stringify(value);
+            if (ttl) {
+                this.cache.set(key, data, ttl);
+            } else {
+                this.cache.set(key, data);
+            }
+        } catch (error) {
+            logger.error(`Memory Cache set error for key ${key}:`, error);
+        }
+    }
+
+    async del(key) {
+        try {
+            this.cache.del(key);
+        } catch (error) {
+            logger.error(`Memory Cache del error for key ${key}:`, error);
+        }
+    }
+
+    async getOrSet(key, fetcher, ttl = 3600) {
+        const cached = await this.get(key);
+        if (cached) return cached;
+
+        const data = await fetcher();
+        if (data) await this.set(key, data, ttl);
+        return data;
+    }
+}
+
+module.exports = MemoryCacheService.getInstance();