nodejs-quickstart-structure 1.18.1 → 1.19.1

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

package/templates/common/.env.example.ejs

@@ -1,41 +1,41 @@
-# Application
-PORT=3000
-NODE_ENV=development
-
-<%_ if (database !== 'None') { -%>
-# Database
-<%_ if (database === 'MySQL') { -%>
-DB_HOST=localhost
-DB_PORT=3306
-DB_USER=root
-DB_PASSWORD=root
-DB_NAME=<%= dbName %>
-<%_ } -%>
-<%_ if (database === 'PostgreSQL') { -%>
-DB_HOST=localhost
-DB_PORT=5432
-DB_USER=postgres
-DB_PASSWORD=root
-DB_NAME=<%= dbName %>
-<%_ } -%>
-<%_ if (database === 'MongoDB') { -%>
-DB_HOST=localhost
-DB_PORT=27017
-DB_NAME=<%= dbName %>
-<%_ } -%>
-<%_ } -%>
-
-
-<%_ if (communication === 'Kafka') { -%>
-# Communication
-KAFKA_BROKER=localhost:9093
-KAFKA_CLIENT_ID=<%= projectName %>
-KAFKA_GROUP_ID=<%= projectName %>-group
-<%_ } -%>
-
-<%_ if (caching === 'Redis') { -%>
-# Caching
-REDIS_HOST=localhost
-REDIS_PORT=6379
-REDIS_PASSWORD=
-<%_ } -%>
+# Application
+PORT=3000
+NODE_ENV=development
+
+<%_ if (database !== 'None') { -%>
+# Database
+<%_ if (database === 'MySQL') { -%>
+DB_HOST=localhost
+DB_PORT=3306
+DB_USER=root
+DB_PASSWORD=root
+DB_NAME=<%= dbName %>
+<%_ } -%>
+<%_ if (database === 'PostgreSQL') { -%>
+DB_HOST=localhost
+DB_PORT=5432
+DB_USER=postgres
+DB_PASSWORD=root
+DB_NAME=<%= dbName %>
+<%_ } -%>
+<%_ if (database === 'MongoDB') { -%>
+DB_HOST=localhost
+DB_PORT=27017
+DB_NAME=<%= dbName %>
+<%_ } -%>
+<%_ } -%>
+
+
+<%_ if (communication === 'Kafka') { -%>
+# Communication
+KAFKA_BROKER=localhost:9093
+KAFKA_CLIENT_ID=<%= projectName %>
+KAFKA_GROUP_ID=<%= projectName %>-group
+<%_ } -%>
+
+<%_ if (caching === 'Redis') { -%>
+# Caching
+REDIS_HOST=localhost
+REDIS_PORT=6379
+REDIS_PASSWORD=
+<%_ } -%>

package/templates/common/.gitattributes

@@ -0,0 +1,46 @@
+# Enforce LF endings for all text files
+* text=auto eol=lf
+
+# Explicitly handle common text file types
+*.js      text eol=lf
+*.ts      text eol=lf
+*.tsx     text eol=lf
+*.jsx     text eol=lf
+*.mjs     text eol=lf
+*.cjs     text eol=lf
+*.json    text eol=lf
+*.md      text eol=lf
+*.sh      text eol=lf
+*.yml     text eol=lf
+*.yaml    text eol=lf
+*.html    text eol=lf
+*.css     text eol=lf
+*.scss    text eol=lf
+*.less    text eol=lf
+*.graphql text eol=lf
+*.sql     text eol=lf
+*.pug     text eol=lf
+
+# Configuration files
+.env*          text eol=lf
+.editorconfig  text eol=lf
+.prettierrc    text eol=lf
+.eslintrc*     text eol=lf
+.gitignore     text eol=lf
+.dockerignore  text eol=lf
+.gitattributes text eol=lf
+
+# Assets
+*.png     binary
+*.jpg     binary
+*.jpeg    binary
+*.gif     binary
+*.ico     binary
+*.webp    binary
+*.avif    binary
+*.pdf     binary
+*.woff    binary
+*.woff2   binary
+*.ttf     binary
+*.eot     binary
+*.svg     text eol=lf

package/templates/common/.gitlab-ci.yml.ejs

@@ -1,86 +1,86 @@
-variables:
-  NODE_ENV: 'test'
-
-stages:
-  - lint
-  - test
-<% if (includeSecurity) { %>
-  - security
-  - quality
-<% } %>
-  - build
-
-cache:
-  paths:
-    - node_modules/
-
-install_dependencies:
-  stage: .pre
-  image: node:22-slim
-  script:
-    - npm ci
-
-lint_code:
-  stage: lint
-  image: node:22-slim
-  script:
-    - npm run lint
-
-run_unit_tests:
-  stage: test
-  image: node:22-slim
-  script:
-    - npm run test:coverage
-
-run_e2e_tests:
-  stage: test
-  image: docker:20.10.16
-  services:
-    - docker:20.10.16-dind
-  script:
-    - apk add --no-cache nodejs npm docker-compose
-    - npm ci
-    - npm run test:e2e
-<% if (includeSecurity) { %>
-snyk_scan:
-  stage: security
-  image: node:22-alpine
-  script:
-    - npm ci
-    - npm run snyk:test
-  only:
-    - main
-
-snyk_container_scan:
-  stage: security
-  image: docker:20.10.16
-  services:
-    - docker:20.10.16-dind
-  script:
-    - apk add --no-cache nodejs npm
-    - npm install -g snyk
-    - docker build -t <%= projectName %>:latest .
-    - snyk container test <%= projectName %>:latest --file=Dockerfile --severity-threshold=high --skip-unused-projects
-
-sonarqube_check:
-  stage: quality
-  image: 
-    name: sonarsource/sonar-scanner-cli:latest
-    entrypoint: [""]
-  variables:
-    SONAR_USER_HOME: "${CI_PROJECT_DIR}/.sonar"
-    GIT_DEPTH: "0"
-  cache:
-    key: "${CI_JOB_NAME}"
-    paths:
-      - .sonar/cache
-  script:
-    - sonar-scanner
-  only:
-    - main
-<% } %>
-build_app:
-  stage: build
-  image: node:22-alpine
-  script:
-    - npm run build --if-present
+variables:
+  NODE_ENV: 'test'
+
+stages:
+  - lint
+  - test
+<% if (includeSecurity) { %>
+  - security
+  - quality
+<% } %>
+  - build
+
+cache:
+  paths:
+    - node_modules/
+
+install_dependencies:
+  stage: .pre
+  image: node:22-slim
+  script:
+    - npm ci
+
+lint_code:
+  stage: lint
+  image: node:22-slim
+  script:
+    - npm run lint
+
+run_unit_tests:
+  stage: test
+  image: node:22-slim
+  script:
+    - npm run test:coverage
+
+run_e2e_tests:
+  stage: test
+  image: docker:20.10.16
+  services:
+    - docker:20.10.16-dind
+  script:
+    - apk add --no-cache nodejs npm docker-compose
+    - npm ci
+    - npm run test:e2e
+<% if (includeSecurity) { %>
+snyk_scan:
+  stage: security
+  image: node:22-alpine
+  script:
+    - npm ci
+    - npm run snyk:test
+  only:
+    - main
+
+snyk_container_scan:
+  stage: security
+  image: docker:20.10.16
+  services:
+    - docker:20.10.16-dind
+  script:
+    - apk add --no-cache nodejs npm
+    - npm install -g snyk
+    - docker build -t <%= projectName %>:latest .
+    - snyk container test <%= projectName %>:latest --file=Dockerfile --severity-threshold=high --skip-unused-projects
+
+sonarqube_check:
+  stage: quality
+  image: 
+    name: sonarsource/sonar-scanner-cli:latest
+    entrypoint: [""]
+  variables:
+    SONAR_USER_HOME: "${CI_PROJECT_DIR}/.sonar"
+    GIT_DEPTH: "0"
+  cache:
+    key: "${CI_JOB_NAME}"
+    paths:
+      - .sonar/cache
+  script:
+    - sonar-scanner
+  only:
+    - main
+<% } %>
+build_app:
+  stage: build
+  image: node:22-alpine
+  script:
+    - npm run build --if-present

package/templates/common/.lintstagedrc

@@ -1,6 +1,6 @@
-{
-  "*.{js,ts}": [
-    "eslint --fix",
-    "prettier --write"
-  ]
-}
+{
+  "*.{js,ts}": [
+    "eslint --fix",
+    "prettier --write"
+  ]
+}

package/templates/common/.prettierrc

@@ -1,7 +1,7 @@
-{
-  "semi": true,
-  "trailingComma": "all",
-  "singleQuote": true,
-  "printWidth": 100,
-  "tabWidth": 2
-}
+{
+  "semi": true,
+  "trailingComma": "all",
+  "singleQuote": true,
+  "printWidth": 100,
+  "tabWidth": 2
+}

package/templates/common/Dockerfile

@@ -1,73 +1,73 @@
-# ==========================================
-# Stage 1: Builder
-# ==========================================
-FROM node:22-alpine AS builder
-
-# Upgrade OS packages to fix upstream vulnerabilities (Snyk-detected)
-RUN apk update && apk upgrade && \
-    apk add --no-cache ca-certificates zlib>=1.3.2-r0 --repository=http://dl-cdn.alpinelinux.org/alpine/edge/main
-
-WORKDIR /app
-ENV NPM_CONFIG_UPDATE_NOTIFIER=false
-
-# Upgrade npm using corepack (safer in Alpine)
-RUN corepack enable && corepack prepare npm@11.6.4 --activate
-
-COPY package*.json ./
-COPY tsconfig*.json ./
-
-# Install ALL dependencies (including devDeps for build)
-RUN npm ci --no-audit --no-fund || npm ci --no-audit --no-fund || npm ci --no-audit --no-fund
-
-COPY . .
-
-# Build for production
-<% if (language === 'TypeScript') { %>RUN npm run build<% } %>
-
-# ==========================================
-# Stage 2: Production
-# ==========================================
-FROM node:22-alpine AS production
-
-# Upgrade OS packages to fix upstream vulnerabilities (Snyk-detected)
-RUN apk update && apk upgrade && \
-    apk add --no-cache ca-certificates zlib>=1.3.2-r0 --repository=http://dl-cdn.alpinelinux.org/alpine/edge/main
-
-WORKDIR /app
-
-ENV NODE_ENV=production
-ENV NPM_CONFIG_UPDATE_NOTIFIER=false
-
-# Upgrade npm using corepack (safer in Alpine)
-RUN corepack enable && corepack prepare npm@11.6.4 --activate
-
-COPY package*.json ./
-
-# Install ONLY production dependencies
-RUN npm ci --only=production --ignore-scripts --no-audit --no-fund || npm ci --only=production --ignore-scripts --no-audit --no-fund || npm ci --only=production --ignore-scripts --no-audit --no-fund
-
-# Remove npm and caches to achieve Zero-Vulnerability status in the final image
-RUN rm -rf /usr/local/lib/node_modules/npm /usr/local/bin/npm /usr/local/bin/npx /root/.npm /root/.cache
-
-# Copy built artifacts from builder
-<% if (language === 'TypeScript') { %>
-COPY --from=builder /app/dist ./dist
-<% } else { %>
-COPY --from=builder /app/src ./src
-<% } %>
-
-# Copy other necessary files (like views if MVC)
-<% if (viewEngine && viewEngine !== 'None') { %>
-COPY --from=builder /app/src/views ./dist/views
-<% if (viewEngine && viewEngine !== 'None') { %>COPY --from=builder /app/public ./public<% } %>
-<% } %>
-
-EXPOSE 3000
-
-# Create logs directory and give permissions to node user
-RUN mkdir -p logs && chown -R node:node logs
-
-USER node
-
-# Start application directly with node (safe even without npm)
-CMD ["node", "<% if (language === 'TypeScript') { %>dist/index.js<% } else { %>src/index.js<% } %>"]
+# ==========================================
+# Stage 1: Builder
+# ==========================================
+FROM node:22-alpine AS builder
+
+# Upgrade OS packages to fix upstream vulnerabilities (Snyk-detected)
+RUN apk update && apk upgrade && \
+    apk add --no-cache ca-certificates zlib>=1.3.2-r0 --repository=http://dl-cdn.alpinelinux.org/alpine/edge/main
+
+WORKDIR /app
+ENV NPM_CONFIG_UPDATE_NOTIFIER=false
+
+# Upgrade npm using corepack (safer in Alpine)
+RUN corepack enable && corepack prepare npm@11.6.4 --activate
+
+COPY package*.json ./
+COPY tsconfig*.json ./
+
+# Install ALL dependencies (including devDeps for build)
+RUN npm ci --no-audit --no-fund || npm ci --no-audit --no-fund || npm ci --no-audit --no-fund
+
+COPY . .
+
+# Build for production
+<% if (language === 'TypeScript') { %>RUN npm run build<% } %>
+
+# ==========================================
+# Stage 2: Production
+# ==========================================
+FROM node:22-alpine AS production
+
+# Upgrade OS packages to fix upstream vulnerabilities (Snyk-detected)
+RUN apk update && apk upgrade && \
+    apk add --no-cache ca-certificates zlib>=1.3.2-r0 --repository=http://dl-cdn.alpinelinux.org/alpine/edge/main
+
+WORKDIR /app
+
+ENV NODE_ENV=production
+ENV NPM_CONFIG_UPDATE_NOTIFIER=false
+
+# Upgrade npm using corepack (safer in Alpine)
+RUN corepack enable && corepack prepare npm@11.6.4 --activate
+
+COPY package*.json ./
+
+# Install ONLY production dependencies
+RUN npm ci --only=production --ignore-scripts --no-audit --no-fund || npm ci --only=production --ignore-scripts --no-audit --no-fund || npm ci --only=production --ignore-scripts --no-audit --no-fund
+
+# Remove npm and caches to achieve Zero-Vulnerability status in the final image
+RUN rm -rf /usr/local/lib/node_modules/npm /usr/local/bin/npm /usr/local/bin/npx /root/.npm /root/.cache
+
+# Copy built artifacts from builder
+<% if (language === 'TypeScript') { %>
+COPY --from=builder /app/dist ./dist
+<% } else { %>
+COPY --from=builder /app/src ./src
+<% } %>
+
+# Copy other necessary files (like views if MVC)
+<% if (viewEngine && viewEngine !== 'None') { %>
+COPY --from=builder /app/src/views ./dist/views
+<% if (viewEngine && viewEngine !== 'None') { %>COPY --from=builder /app/public ./public<% } %>
+<% } %>
+
+EXPOSE 3000
+
+# Create logs directory and give permissions to node user
+RUN mkdir -p logs && chown -R node:node logs
+
+USER node
+
+# Start application directly with node (safe even without npm)
+CMD ["node", "<% if (language === 'TypeScript') { %>dist/index.js<% } else { %>src/index.js<% } %>"]