@dhayalesh/create-ktern-nestjs-clean 1.0.0

package/bin/cli.js

@@ -0,0 +1,102 @@
+#!/usr/bin/env node
+
+const fs = require('fs');
+const path = require('path');
+const inquirer = require('inquirer');
+const ejs = require('ejs');
+const { promisify } = require('util');
+
+const copyFile = promisify(fs.copyFile);
+const mkdir = promisify(fs.mkdir);
+const readdir = promisify(fs.readdir);
+const stat = promisify(fs.stat);
+const writeFile = promisify(fs.writeFile);
+const readFile = promisify(fs.readFile);
+
+async function copyTemplate(src, dest, data) {
+    const stats = await stat(src);
+    if (stats.isDirectory()) {
+        if (!fs.existsSync(dest)) {
+            await mkdir(dest, { recursive: true });
+        }
+        const files = await readdir(src);
+        for (const file of files) {
+            await copyTemplate(path.join(src, file), path.join(dest, file), data);
+        }
+    } else {
+        let content = await readFile(src, 'utf8');
+        // Simple template replacement if no EJS variables are found or if we want to use EJS
+        try {
+            content = ejs.render(content, data);
+        } catch (err) {
+            // If EJS fails (e.g. invalid syntax in non-template files), just use raw content
+        }
+
+        // Remove .template or .tmpl suffix if present in destination filename
+        const finalDest = dest.replace(/\.template$/, '').replace(/\.tmpl$/, '');
+        await writeFile(finalDest, content);
+    }
+}
+
+async function run() {
+    console.log('🚀 Welcome to the KTERN Generator!');
+
+    const questions = [
+        {
+            type: 'input',
+            name: 'name',
+            message: 'What is the project name?',
+            validate: (input) => input.length > 0 || 'Project name is required',
+        },
+        {
+            type: 'input',
+            name: 'directory',
+            message: 'In which directory should the project be created?',
+            default: (answers) => path.join(process.cwd(), answers.name),
+        },
+        {
+            type: 'number',
+            name: 'port',
+            message: 'What port should the service run on?',
+            default: 3000,
+        },
+    ];
+
+    const answers = await inquirer.prompt(questions);
+    const targetDir = path.resolve(answers.directory);
+
+    if (fs.existsSync(targetDir)) {
+        const { overwrite } = await inquirer.prompt([
+            {
+                type: 'confirm',
+                name: 'overwrite',
+                message: `Directory ${targetDir} already exists. Overwrite?`,
+                default: false,
+            },
+        ]);
+        if (!overwrite) {
+            console.log('Exiting...');
+            process.exit(0);
+        }
+    }
+
+    console.log(`\nCreating project "${answers.name}" in ${targetDir}...`);
+
+    const templateDir = path.join(__dirname, '../templates');
+    await copyTemplate(templateDir, targetDir, {
+        name: answers.name,
+        port: answers.port,
+        // Add more default variables if needed
+    });
+
+    console.log('\n✅ Project created successfully!');
+    console.log(`\nNext steps:`);
+    console.log(`  cd ${targetDir}`);
+    console.log(`  npm install`);
+    console.log(`  npm start`);
+}
+
+run().catch((err) => {
+    console.error('❌ Error:', err.message);
+    process.exit(1);
+});

package/package.json

@@ -0,0 +1,15 @@
+{
+  "name": "@dhayalesh/create-ktern-nestjs-clean",
+  "version": "1.0.0",
+  "description": "Standalone KTERN clean generator",
+  "bin": {
+    "create-ktern-nestjs-clean": "./bin/cli.js"
+  },
+  "dependencies": {
+    "inquirer": "^8.2.4",
+    "ejs": "^3.1.8"
+  },
+  "publishConfig": {
+    "access": "restricted"
+  }
+}

package/templates/Dockerfile.template

@@ -0,0 +1,32 @@
+FROM node:20-alpine AS builder
+
+WORKDIR /app
+
+# Install pnpm
+RUN npm install -g pnpm
+
+# Copy files
+COPY package.json pnpm-lock.yaml* pnpm-workspace.yaml ./
+COPY packages/<%= name %> packages/<%= name %>
+COPY tsconfig.base.json ./
+COPY nx.json ./
+
+# Install dependencies (frozen-lockfile for consistency)
+RUN pnpm install --frozen-lockfile
+
+# Build the project
+RUN pnpm nx build <%= name %>
+
+# Production stage
+FROM node:20-alpine
+
+WORKDIR /app
+
+# Copy built application and node_modules
+COPY --from=builder /app/dist/packages/<%= name %> ./dist
+COPY --from=builder /app/node_modules ./node_modules
+COPY --from=builder /app/packages/<%= name %>/package.json ./package.json
+
+EXPOSE <%= port %>
+
+CMD ["node", "dist/src/main"]

package/templates/package.json.template

@@ -0,0 +1,70 @@
+{
+  "name": "<%= name %>",
+  "version": "0.0.1",
+  "description": "",
+  "author": "",
+  "private": true,
+  "license": "UNLICENSED",
+  "scripts": {
+    "build": "nest build",
+    "format": "prettier --write \"src/**/*.ts\" \"test/**/*.ts\"",
+    "start": "nest start",
+    "start:dev": "nest start --watch",
+    "start:debug": "nest start --debug --watch",
+    "start:prod": "node dist/packages/<%= name %>/src/main",
+    "lint": "eslint \"{src,apps,libs,test}/**/*.ts\" --fix",
+    "test": "jest",
+    "test:watch": "jest --watch",
+    "test:cov": "jest --coverage",
+    "test:debug": "node --inspect-brk -r tsconfig-paths/register -r ts-node/register node_modules/.bin/jest --runInBand",
+    "test:e2e": "jest --config ./test/jest-e2e.json"
+  },
+  "dependencies": {
+    "@nestjs/common": "^10.0.0",
+    "@nestjs/core": "^10.0.0",
+    "@nestjs/platform-express": "^10.0.0",
+    "@nestjs/swagger": "^7.1.0",
+    "reflect-metadata": "^0.1.13",
+    "rxjs": "^7.8.1"
+  },
+  "devDependencies": {
+    "@nestjs/cli": "^10.0.0",
+    "@nestjs/schematics": "^10.0.0",
+    "@nestjs/testing": "^10.0.0",
+    "@types/express": "^4.17.17",
+    "@types/jest": "^29.5.2",
+    "@types/node": "^20.3.1",
+    "@types/supertest": "^2.0.12",
+    "@typescript-eslint/eslint-plugin": "^6.0.0",
+    "@typescript-eslint/parser": "^6.0.0",
+    "eslint": "^8.42.0",
+    "eslint-config-prettier": "^9.0.0",
+    "eslint-plugin-prettier": "^5.0.0",
+    "jest": "^29.5.0",
+    "prettier": "^3.0.0",
+    "source-map-support": "^0.5.21",
+    "supertest": "^6.3.3",
+    "ts-jest": "^29.1.0",
+    "ts-loader": "^9.4.3",
+    "ts-node": "^10.9.1",
+    "tsconfig-paths": "^4.2.0",
+    "typescript": "^5.1.3"
+  },
+  "jest": {
+    "moduleFileExtensions": [
+      "js",
+      "json",
+      "ts"
+    ],
+    "rootDir": "src",
+    "testRegex": ".*\\.spec\\.ts$",
+    "transform": {
+      "^.+\\.(t|j)s$": "ts-jest"
+    },
+    "collectCoverageFrom": [
+      "**/*.(t|j)s"
+    ],
+    "coverageDirectory": "../coverage",
+    "testEnvironment": "node"
+  }
+}

package/templates/project.json.template

@@ -0,0 +1,23 @@
+{
+  "name": "<%= name %>",
+  "$schema": "../../node_modules/nx/schemas/project-schema.json",
+  "projectType": "application",
+  "sourceRoot": "<%= projectRoot %>/src",
+  "targets": {
+    "build": {
+      "executor": "@nx/js:tsc",
+      "options": {
+        "outputPath": "dist/<%= name %>",
+        "main": "<%= projectRoot %>/src/main.ts",
+        "tsConfig": "<%= projectRoot %>/tsconfig.json",
+        "assets": ["<%= projectRoot %>/src/assets"]
+      }
+    },
+    "serve": {
+      "executor": "@nx/js:node",
+      "options": {
+        "buildTarget": "<%= name %>:build"
+      }
+    }
+  }
+}

package/templates/src/api/app.controller.ts.template

@@ -0,0 +1,26 @@
+import { Controller, Get, Post, Put, Delete } from '@nestjs/common';
+import { ApiTags } from '@nestjs/swagger';
+
+@ApiTags('<%= name %>')
+@Controller('<%= name %>')
+export class AppController {
+  @Get()
+  getData(): string {
+    return '';
+  }
+
+  @Post()
+  createData(): string {
+    return '';
+  }
+
+  @Put()
+  updateData(): string {
+    return '';
+  }
+
+  @Delete()
+  deleteData(): string {
+    return '';
+  }
+}

package/templates/src/api/app.module.ts.template

@@ -0,0 +1,11 @@
+import { Module } from '@nestjs/common';
+import { AppController } from './app.controller';
+import { HealthController } from './health.controller';
+import { RootController } from './root.controller';
+
+@Module({
+  imports: [],
+  controllers: [AppController, HealthController, RootController],
+  providers: [],
+})
+export class AppModule {}

package/templates/src/api/health.controller.ts.template

@@ -0,0 +1,11 @@
+import { Controller, Get } from '@nestjs/common';
+import { ApiTags } from '@nestjs/swagger';
+
+@ApiTags('health')
+@Controller('health')
+export class HealthController {
+  @Get()
+  checkHealth() {
+    return 'OK';
+  }
+}

package/templates/src/api/root.controller.ts.template

@@ -0,0 +1,11 @@
+import { Controller, Get } from '@nestjs/common';
+import { ApiTags } from '@nestjs/swagger';
+
+@ApiTags('root')
+@Controller('')
+export class RootController {
+  @Get()
+  getRoot(): string {
+    return '<%= name %> is running on port <%= port %>';
+  }
+}

package/templates/src/main.ts.template

@@ -0,0 +1,27 @@
+import { NestFactory } from '@nestjs/core';
+import { SwaggerModule, DocumentBuilder } from '@nestjs/swagger';
+import { AppModule } from './api/app.module';
+
+async function bootstrap() {
+  const app = await NestFactory.create(AppModule);
+
+  // Set global prefix with versioning, excluding operational endpoints
+  app.setGlobalPrefix('v1/api', {
+    exclude: ['health', '/'],
+  });
+
+  // Swagger Configuration
+  const config = new DocumentBuilder()
+    .setTitle('<%= name %>')
+    .setDescription('The <%= name %> API description')
+    .setVersion('1.0')
+    .build();
+  const document = SwaggerModule.createDocument(app, config);
+
+  SwaggerModule.setup('api/docs', app, document);
+
+  await app.listen(<%= port %>, '0.0.0.0');
+  console.log(`Application is running on: http://localhost:<%= port %>`);
+  console.log(`Swagger documentation: http://localhost:<%= port %>/api/docs`);
+}
+bootstrap();

package/templates/tsconfig.json.template

@@ -0,0 +1,22 @@
+{
+  "compilerOptions": {
+    "module": "commonjs",
+    "declaration": true,
+    "removeComments": true,
+    "emitDecoratorMetadata": true,
+    "experimentalDecorators": true,
+    "allowSyntheticDefaultImports": true,
+    "target": "es2021",
+    "sourceMap": true,
+    "outDir": "../../dist/packages/<%= name %>",
+    "baseUrl": "./",
+    "incremental": true,
+    "skipLibCheck": true,
+    "strictNullChecks": false,
+    "noImplicitAny": false,
+    "strictBindCallApply": false,
+    "forceConsistentCasingInFileNames": false,
+    "noFallthroughCasesInSwitch": false
+  },
+  "include": ["src/**/*"]
+}