nodejs-quickstart-structure 1.19.0 → 2.0.0

package/templates/common/docker-compose.yml.ejs

@@ -1,159 +1,159 @@
-services:
-  app:
-    build: .
-    ports:
-      - "${PORT:-3000}:3000"
-<%_ if (database !== 'None' || communication === 'Kafka') { -%>
-    depends_on:
-<%_ if (database !== 'None') { -%>
-      - db
-<%_ } -%>
-<%_ if (communication === 'Kafka') { -%>
-      - kafka
-<%_ } -%>
-<%_ } -%>
-<%_ if (communication === 'Kafka') { -%>
-    environment:
-      - KAFKA_BROKER=kafka:9092
-      - KAFKAJS_NO_PARTITIONER_WARNING=1
-      - PORT=3000
-<%_ if (caching === 'Redis') { -%>
-      - REDIS_HOST=redis
-      - REDIS_PORT=6379
-      - REDIS_PASSWORD=
-<%_ } -%>
-<%_ if (database !== 'None') { -%>
-      - DB_HOST=db
-<%_ if (database === 'MySQL') { -%>
-      - DB_USER=root
-      - DB_PASSWORD=root
-      - DB_NAME=<%= dbName %>
-      - DB_PORT=3306
-<%_ } -%><%_ if (database === 'PostgreSQL') { -%>
-      - DB_USER=postgres
-      - DB_PASSWORD=root
-      - DB_NAME=<%= dbName %>
-      - DB_PORT=5432
-<%_ } -%><%_ if (database === 'MongoDB') { -%>
-      - DB_NAME=<%= dbName %>
-      - DB_PORT=27017
-<%_ } -%>
-<%_ } -%>
-<%_ } else { -%>
-    environment:
-      - PORT=3000
-<%_ if (caching === 'Redis') { -%>
-      - REDIS_HOST=redis
-      - REDIS_PORT=6379
-      - REDIS_PASSWORD=
-<%_ } -%>
-<%_ if (database !== 'None') { -%>
-      - DB_HOST=db
-<%_ if (database === 'MySQL') { -%>
-      - DB_USER=root
-      - DB_PASSWORD=root
-      - DB_NAME=<%= dbName %>
-      - DB_PORT=3306
-<%_ } -%><%_ if (database === 'PostgreSQL') { -%>
-      - DB_USER=postgres
-      - DB_PASSWORD=root
-      - DB_NAME=<%= dbName %>
-      - DB_PORT=5432
-<%_ } -%><%_ if (database === 'MongoDB') { -%>
-      - DB_NAME=<%= dbName %>
-      - DB_PORT=27017
-<%_ } -%>
-<%_ } -%>
-<%_ } -%>
-<%_ if (database !== 'None') { -%>
-  db:
-<%_ if (database === 'MySQL') { -%>
-    image: mysql:8.0
-    restart: always
-    environment:
-      MYSQL_ROOT_PASSWORD: root
-      MYSQL_DATABASE: <%= dbName %>
-    ports:
-      - "${DB_PORT:-3306}:3306"
-    volumes:
-      - ./flyway/sql:/docker-entrypoint-initdb.d
-<%_ } else if (database === 'PostgreSQL') { -%>
-    image: postgres:15
-    restart: always
-    environment:
-      POSTGRES_USER: postgres
-      POSTGRES_PASSWORD: root
-      POSTGRES_DB: <%= dbName %>
-    ports:
-      - "${DB_PORT:-5432}:5432"
-    volumes:
-      - ./flyway/sql:/docker-entrypoint-initdb.d
-<%_ } else if (database === 'MongoDB') { -%>
-    image: mongo:latest
-    restart: always
-    environment:
-      MONGO_INITDB_DATABASE: <%= dbName %>
-    ports:
-      - "${DB_PORT:-27017}:27017"
-    volumes:
-      - mongodb_data:/data/db
-
-  mongo-migrate:
-    image: node:22-slim
-    working_dir: /app
-    volumes:
-      - .:/app
-    command: sh -c "npm install migrate-mongo && npm run migrate"
-    environment:
-      - DB_HOST=db
-      - DB_NAME=<%= dbName %>
-    depends_on:
-      - db
-<%_ } -%>
-<%_ } -%>
-<%_ if (database !== 'MongoDB' && database !== 'None') { -%>
-  flyway:
-    image: flyway/flyway
-    command: -connectRetries=60 migrate
-    volumes:
-      - ./flyway/sql:/flyway/sql
-    environment:
-<%_ if (database === 'MySQL') { -%>
-      FLYWAY_URL: jdbc:mysql://db:3306/<%= dbName %>
-      FLYWAY_USER: root
-      FLYWAY_PASSWORD: root
-<%_ } -%><%_ if (database === 'PostgreSQL') { -%>
-      FLYWAY_URL: jdbc:postgresql://db:5432/<%= dbName %>
-      FLYWAY_USER: postgres
-      FLYWAY_PASSWORD: root
-<%_ } -%>
-    depends_on:
-      - db
-<%_ } -%>
-<%_ if (communication === 'Kafka') { -%>
-  kafka:
-    image: bitnamilegacy/kafka:3.4.1-debian-12-r39
-    ports:
-      - "${KAFKA_EXTERNAL_PORT:-9093}:9093"
-    environment:
-      - KAFKA_ENABLE_KRAFT=yes
-      - KAFKA_CFG_PROCESS_ROLES=broker,controller
-      - KAFKA_CFG_CONTROLLER_QUORUM_VOTERS=1@localhost:9094
-      - KAFKA_CFG_NODE_ID=1
-      - KAFKA_CFG_ADVERTISED_LISTENERS=PLAINTEXT://kafka:9092,PLAINTEXT_HOST://localhost:${KAFKA_PORT:-9093}
-      - KAFKA_CFG_LISTENERS=PLAINTEXT://:9092,PLAINTEXT_HOST://:9093,CONTROLLER://:9094
-      - KAFKA_CFG_LISTENER_SECURITY_PROTOCOL_MAP=CONTROLLER:PLAINTEXT,PLAINTEXT:PLAINTEXT,PLAINTEXT_HOST:PLAINTEXT
-      - KAFKA_CFG_CONTROLLER_LISTENER_NAMES=CONTROLLER
-      - KAFKA_CFG_INTER_BROKER_LISTENER_NAME=PLAINTEXT
-<%_ } -%>
-<%_ if (caching === 'Redis') { -%>
-  redis:
-    image: redis:alpine
-    restart: always
-    ports:
-      - "${REDIS_PORT:-6379}:6379"
-<%_ } -%>
-<%_ if (database !== 'None') { -%>
-volumes:
-  <%= database.toLowerCase() %>_data:
-<%_ } -%>
+services:
+  app:
+    build: .
+    ports:
+      - "${PORT:-3000}:3000"
+<%_ if (database !== 'None' || communication === 'Kafka') { -%>
+    depends_on:
+<%_ if (database !== 'None') { -%>
+      - db
+<%_ } -%>
+<%_ if (communication === 'Kafka') { -%>
+      - kafka
+<%_ } -%>
+<%_ } -%>
+<%_ if (communication === 'Kafka') { -%>
+    environment:
+      - KAFKA_BROKER=kafka:9092
+      - KAFKAJS_NO_PARTITIONER_WARNING=1
+      - PORT=3000
+<%_ if (caching === 'Redis') { -%>
+      - REDIS_HOST=redis
+      - REDIS_PORT=6379
+      - REDIS_PASSWORD=
+<%_ } -%>
+<%_ if (database !== 'None') { -%>
+      - DB_HOST=db
+<%_ if (database === 'MySQL') { -%>
+      - DB_USER=root
+      - DB_PASSWORD=root
+      - DB_NAME=<%= dbName %>
+      - DB_PORT=3306
+<%_ } -%><%_ if (database === 'PostgreSQL') { -%>
+      - DB_USER=postgres
+      - DB_PASSWORD=root
+      - DB_NAME=<%= dbName %>
+      - DB_PORT=5432
+<%_ } -%><%_ if (database === 'MongoDB') { -%>
+      - DB_NAME=<%= dbName %>
+      - DB_PORT=27017
+<%_ } -%>
+<%_ } -%>
+<%_ } else { -%>
+    environment:
+      - PORT=3000
+<%_ if (caching === 'Redis') { -%>
+      - REDIS_HOST=redis
+      - REDIS_PORT=6379
+      - REDIS_PASSWORD=
+<%_ } -%>
+<%_ if (database !== 'None') { -%>
+      - DB_HOST=db
+<%_ if (database === 'MySQL') { -%>
+      - DB_USER=root
+      - DB_PASSWORD=root
+      - DB_NAME=<%= dbName %>
+      - DB_PORT=3306
+<%_ } -%><%_ if (database === 'PostgreSQL') { -%>
+      - DB_USER=postgres
+      - DB_PASSWORD=root
+      - DB_NAME=<%= dbName %>
+      - DB_PORT=5432
+<%_ } -%><%_ if (database === 'MongoDB') { -%>
+      - DB_NAME=<%= dbName %>
+      - DB_PORT=27017
+<%_ } -%>
+<%_ } -%>
+<%_ } -%>
+<%_ if (database !== 'None') { -%>
+  db:
+<%_ if (database === 'MySQL') { -%>
+    image: mysql:8.0
+    restart: always
+    environment:
+      MYSQL_ROOT_PASSWORD: root
+      MYSQL_DATABASE: <%= dbName %>
+    ports:
+      - "${DB_PORT:-3306}:3306"
+    volumes:
+      - ./flyway/sql:/docker-entrypoint-initdb.d
+<%_ } else if (database === 'PostgreSQL') { -%>
+    image: postgres:15
+    restart: always
+    environment:
+      POSTGRES_USER: postgres
+      POSTGRES_PASSWORD: root
+      POSTGRES_DB: <%= dbName %>
+    ports:
+      - "${DB_PORT:-5432}:5432"
+    volumes:
+      - ./flyway/sql:/docker-entrypoint-initdb.d
+<%_ } else if (database === 'MongoDB') { -%>
+    image: mongo:latest
+    restart: always
+    environment:
+      MONGO_INITDB_DATABASE: <%= dbName %>
+    ports:
+      - "${DB_PORT:-27017}:27017"
+    volumes:
+      - mongodb_data:/data/db
+
+  mongo-migrate:
+    image: node:22-slim
+    working_dir: /app
+    volumes:
+      - .:/app
+    command: sh -c "npm install migrate-mongo && npm run migrate"
+    environment:
+      - DB_HOST=db
+      - DB_NAME=<%= dbName %>
+    depends_on:
+      - db
+<%_ } -%>
+<%_ } -%>
+<%_ if (database !== 'MongoDB' && database !== 'None') { -%>
+  flyway:
+    image: flyway/flyway
+    command: -connectRetries=60 migrate
+    volumes:
+      - ./flyway/sql:/flyway/sql
+    environment:
+<%_ if (database === 'MySQL') { -%>
+      FLYWAY_URL: jdbc:mysql://db:3306/<%= dbName %>
+      FLYWAY_USER: root
+      FLYWAY_PASSWORD: root
+<%_ } -%><%_ if (database === 'PostgreSQL') { -%>
+      FLYWAY_URL: jdbc:postgresql://db:5432/<%= dbName %>
+      FLYWAY_USER: postgres
+      FLYWAY_PASSWORD: root
+<%_ } -%>
+    depends_on:
+      - db
+<%_ } -%>
+<%_ if (communication === 'Kafka') { -%>
+  kafka:
+    image: bitnamilegacy/kafka:3.4.1-debian-12-r39
+    ports:
+      - "${KAFKA_EXTERNAL_PORT:-9093}:9093"
+    environment:
+      - KAFKA_ENABLE_KRAFT=yes
+      - KAFKA_CFG_PROCESS_ROLES=broker,controller
+      - KAFKA_CFG_CONTROLLER_QUORUM_VOTERS=1@localhost:9094
+      - KAFKA_CFG_NODE_ID=1
+      - KAFKA_CFG_ADVERTISED_LISTENERS=PLAINTEXT://kafka:9092,PLAINTEXT_HOST://localhost:${KAFKA_PORT:-9093}
+      - KAFKA_CFG_LISTENERS=PLAINTEXT://:9092,PLAINTEXT_HOST://:9093,CONTROLLER://:9094
+      - KAFKA_CFG_LISTENER_SECURITY_PROTOCOL_MAP=CONTROLLER:PLAINTEXT,PLAINTEXT:PLAINTEXT,PLAINTEXT_HOST:PLAINTEXT
+      - KAFKA_CFG_CONTROLLER_LISTENER_NAMES=CONTROLLER
+      - KAFKA_CFG_INTER_BROKER_LISTENER_NAME=PLAINTEXT
+<%_ } -%>
+<%_ if (caching === 'Redis') { -%>
+  redis:
+    image: redis:alpine
+    restart: always
+    ports:
+      - "${REDIS_PORT:-6379}:6379"
+<%_ } -%>
+<%_ if (database !== 'None') { -%>
+volumes:
+  <%= database.toLowerCase() %>_data:
+<%_ } -%>

package/templates/common/ecosystem.config.js.ejs

@@ -1,40 +1,40 @@
-module.exports = {
-  apps: [{
-    name: "<%= projectName %>",
-    script: "<% if (language === 'TypeScript') { %>./dist/index.js<% } else { %>./src/index.js<% } %>", // Entry point
-    instances: "max",           // Run in Cluster Mode to utilize all CPUs (Note: On Windows, cluster mode may throw `spawn wmic ENOENT` errors due to missing WMIC in Windows 11. To fix, change instances to 1, or install wmic)
-    exec_mode: "cluster",
-    watch: false,               // Disable watch in production
-    max_memory_restart: "1G",
-    env_production: {
-      NODE_ENV: "production",
-      PORT: 3000,
-<%_ if (caching === 'Redis') { -%>
-      REDIS_HOST: "127.0.0.1",
-      REDIS_PORT: 6379,
-      REDIS_PASSWORD: "",
-<%_ } -%>
-<%_ if (communication === 'Kafka') { -%>
-      KAFKA_BROKER: "127.0.0.1:9093",
-      KAFKAJS_NO_PARTITIONER_WARNING: 1,
-<%_ } -%>
-<%_ if (database !== 'None') { -%>
-      DB_HOST: "127.0.0.1",
-<%_ if (database === 'MySQL') { -%>
-      DB_USER: "root",
-      DB_PASSWORD: "root",
-      DB_NAME: "<%= dbName %>",
-      DB_PORT: 3306
-<%_ } else if (database === 'PostgreSQL') { -%>
-      DB_USER: "postgres",
-      DB_PASSWORD: "root",
-      DB_NAME: "<%= dbName %>",
-      DB_PORT: 5432
-<%_ } else if (database === 'MongoDB') { -%>
-      DB_NAME: "<%= dbName %>",
-      DB_PORT: 27017
-<%_ } -%>
-<%_ } -%>
-    }
-  }]
-};
+module.exports = {
+  apps: [{
+    name: "<%= projectName %>",
+    script: "<% if (language === 'TypeScript') { %>./dist/index.js<% } else { %>./src/index.js<% } %>", // Entry point
+    instances: "max",           // Run in Cluster Mode to utilize all CPUs (Note: On Windows, cluster mode may throw `spawn wmic ENOENT` errors due to missing WMIC in Windows 11. To fix, change instances to 1, or install wmic)
+    exec_mode: "cluster",
+    watch: false,               // Disable watch in production
+    max_memory_restart: "1G",
+    env_production: {
+      NODE_ENV: "production",
+      PORT: 3000,
+<%_ if (caching === 'Redis') { -%>
+      REDIS_HOST: "127.0.0.1",
+      REDIS_PORT: 6379,
+      REDIS_PASSWORD: "",
+<%_ } -%>
+<%_ if (communication === 'Kafka') { -%>
+      KAFKA_BROKER: "127.0.0.1:9093",
+      KAFKAJS_NO_PARTITIONER_WARNING: 1,
+<%_ } -%>
+<%_ if (database !== 'None') { -%>
+      DB_HOST: "127.0.0.1",
+<%_ if (database === 'MySQL') { -%>
+      DB_USER: "root",
+      DB_PASSWORD: "root",
+      DB_NAME: "<%= dbName %>",
+      DB_PORT: 3306
+<%_ } else if (database === 'PostgreSQL') { -%>
+      DB_USER: "postgres",
+      DB_PASSWORD: "root",
+      DB_NAME: "<%= dbName %>",
+      DB_PORT: 5432
+<%_ } else if (database === 'MongoDB') { -%>
+      DB_NAME: "<%= dbName %>",
+      DB_PORT: 27017
+<%_ } -%>
+<%_ } -%>
+    }
+  }]
+};

package/templates/common/eslint.config.mjs.ejs

@@ -1,77 +1,77 @@
-import eslint from '@eslint/js';
-import eslintConfigPrettier from 'eslint-config-prettier';
-import globals from 'globals';
-import importPlugin from 'eslint-plugin-import-x';
-<% if (language === 'TypeScript') { %>import tseslint from 'typescript-eslint';
-
-export default tseslint.config(
-  eslint.configs.recommended,
-  ...tseslint.configs.recommended,
-  eslintConfigPrettier,
-  {
-    plugins: {
-      import: importPlugin,
-    },
-    settings: {
-      'import-x/resolver': {
-        typescript: true,
-        node: true,
-      },
-    },
-    languageOptions: {
-      globals: {
-        ...globals.node,
-        ...globals.jest,
-      },
-    },
-    rules: {
-      "no-console": "warn",
-      "no-unused-vars": "off",
-      "@typescript-eslint/no-unused-vars": ["warn", { 
-        "argsIgnorePattern": "^_",
-        "varsIgnorePattern": "^_"
-      }],
-      "@typescript-eslint/no-require-imports": "error",
-      "import/no-unresolved": [2, { "caseSensitive": false }]
-    },
-  },
-  {
-    files: ["**/*.test.ts", "**/*.spec.ts", "tests/**/*.ts"],
-    rules: {
-      "@typescript-eslint/no-require-imports": "off",
-      "@typescript-eslint/no-unused-vars": ["warn", { 
-        "argsIgnorePattern": "^_",
-        "varsIgnorePattern": "^_"
-      }],
-      "@typescript-eslint/no-explicit-any": "off",
-      "import/no-unresolved": [2, { "caseSensitive": false }]
-    },
-  }
-);<% } else { %>
-export default [
-  eslint.configs.recommended,
-  eslintConfigPrettier,
-  {
-    plugins: {
-      import: importPlugin,
-    },
-    settings: {
-      'import-x/resolver': {
-        node: true,
-      },
-    },
-    languageOptions: {
-      ecmaVersion: 'latest',
-      sourceType: 'module',
-      globals: {
-        ...globals.node,
-        ...globals.jest,
-      },
-    },
-    rules: {
-      "no-console": "warn",
-      "no-unused-vars": "warn",
-      "import/no-unresolved": [2, { "caseSensitive": false }]
-    }
-  }
-];<% } %>
+import eslint from '@eslint/js';
+import eslintConfigPrettier from 'eslint-config-prettier';
+import globals from 'globals';
+import importPlugin from 'eslint-plugin-import-x';
+<% if (language === 'TypeScript') { %>import tseslint from 'typescript-eslint';
+
+export default tseslint.config(
+  eslint.configs.recommended,
+  ...tseslint.configs.recommended,
+  eslintConfigPrettier,
+  {
+    plugins: {
+      import: importPlugin,
+    },
+    settings: {
+      'import-x/resolver': {
+        typescript: true,
+        node: true,
+      },
+    },
+    languageOptions: {
+      globals: {
+        ...globals.node,
+        ...globals.jest,
+      },
+    },
+    rules: {
+      "no-console": "warn",
+      "no-unused-vars": "off",
+      "@typescript-eslint/no-unused-vars": ["warn", { 
+        "argsIgnorePattern": "^_",
+        "varsIgnorePattern": "^_"
+      }],
+      "@typescript-eslint/no-require-imports": "error",
+      "import/no-unresolved": [2, { "caseSensitive": false }]
+    },
+  },
+  {
+    files: ["**/*.test.ts", "**/*.spec.ts", "tests/**/*.ts"],
+    rules: {
+      "@typescript-eslint/no-require-imports": "off",
+      "@typescript-eslint/no-unused-vars": ["warn", { 
+        "argsIgnorePattern": "^_",
+        "varsIgnorePattern": "^_"
+      }],
+      "@typescript-eslint/no-explicit-any": "off",
+      "import/no-unresolved": [2, { "caseSensitive": false }]
+    },
+  }
+);<% } else { %>
+export default [
+  eslint.configs.recommended,
+  eslintConfigPrettier,
+  {
+    plugins: {
+      import: importPlugin,
+    },
+    settings: {
+      'import-x/resolver': {
+        node: true,
+      },
+    },
+    languageOptions: {
+      ecmaVersion: 'latest',
+      sourceType: 'module',
+      globals: {
+        ...globals.node,
+        ...globals.jest,
+      },
+    },
+    rules: {
+      "no-console": "warn",
+      "no-unused-vars": "warn",
+      "import/no-unresolved": [2, { "caseSensitive": false }]
+    }
+  }
+];<% } %>