@kuldi/create-nestjs 1.0.1 → 1.1.0

package/README.md

@@ -0,0 +1,27 @@
+# @kuldi/create-nestjs
+
+The official interactive scaffolding tool for Kuli Digital's NestJS Boilerplate.
+
+## Quick Start
+
+To generate a new NestJS project using this boilerplate, simply run:
+
+```bash
+npm create @kuldi/nestjs my-app
+```
+
+Or, to create it in the current directory:
+
+```bash
+npm create @kuldi/nestjs .
+```
+
+## Features
+
+- **Interactive Prompts**: Easily configure your project name and database name.
+- **Auto-Configured Environment**: Automatically generates a `.env` file tailored to your database credentials.
+- **Production Ready**: Scaffolds a full-fledged NestJS architecture with Prisma, Swagger, and JWT Auth out of the box.
+
+## License
+
+MIT - Kuli Digital

package/package.json

@@ -1,9 +1,14 @@
 {
   "name": "@kuldi/create-nestjs",
-  "version": "1.0.1",
+  "version": "1.1.0",
+  "type": "module",
   "description": "Scaffolding tool for Kuli Digital NestJS Boilerplate",
-  "main": "bin/cli.js",
-  "bin": "bin/cli.js",
+  "main": "src/cli.js",
+  "bin": "src/cli.js",
+  "files": [
+    "src",
+    "template"
+  ],
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"
   },
@@ -22,5 +27,10 @@
   "license": "MIT",
   "publishConfig": {
     "access": "public"
+  },
+  "dependencies": {
+    "chalk": "^5.6.2",
+    "inquirer": "^14.0.2",
+    "ora": "^9.4.1"
   }
 }

package/src/cli.js

@@ -0,0 +1,139 @@
+#!/usr/bin/env node
+
+import { execSync } from 'child_process';
+import path from 'path';
+import fs from 'fs';
+import inquirer from 'inquirer';
+import ora from 'ora';
+import chalk from 'chalk';
+import { fileURLToPath } from 'url';
+
+const currentPath = process.cwd();
+
+// Fallback untuk support Node versi di bawah 20.11 yang belum punya import.meta.dirname
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
+async function run() {
+  console.log(chalk.cyan.bold('\n🚀 Kuli Digital NestJS Boilerplate Generator\n'));
+
+  const argProjectName = process.argv[2];
+
+  // 1. Tanya-tanya
+  const answers = await inquirer.prompt([
+    {
+      type: 'input',
+      name: 'projectName',
+      message: 'Nama Project (atau . untuk folder saat ini):',
+      default: argProjectName || 'my-nestjs-app',
+      when: !argProjectName,
+    },
+    {
+      type: 'input',
+      name: 'database',
+      message: 'Nama Database PostgreSQL:',
+      default: 'kulidigital_db',
+    },
+    {
+      type: 'confirm',
+      name: 'skipInstall',
+      message: 'Lewati instalasi package (npm install)?',
+      default: false,
+    },
+  ]);
+
+  const projectName = argProjectName || answers.projectName;
+  const projectPath = projectName === '.' ? currentPath : path.join(currentPath, projectName);
+
+  // Mengecek apakah target directory kosong
+  if (projectName === '.') {
+    const files = fs.readdirSync(currentPath).filter(f => !f.startsWith('.git'));
+    if (files.length > 0) {
+      console.log(chalk.red('\n❌ Folder saat ini tidak kosong! Harap jalankan di folder kosong.\n'));
+      process.exit(1);
+    }
+  }
+
+  // 2. Salin Template
+  const copySpinner = ora('Membuat struktur project...').start();
+  try {
+    const templateDir = path.join(__dirname, '../template');
+    
+    // Copy seluruh isi folder template ke project tujuan
+    fs.cpSync(templateDir, projectPath, { recursive: true });
+    
+    // Rename gitignore menjadi .gitignore (krn NPM mengabaikan .gitignore saat publish)
+    const gitignorePath = path.join(projectPath, 'gitignore');
+    if (fs.existsSync(gitignorePath)) {
+      fs.renameSync(gitignorePath, path.join(projectPath, '.gitignore'));
+    }
+
+    copySpinner.succeed('Struktur project berhasil dibuat.');
+  } catch (error) {
+    copySpinner.fail('Gagal menyalin struktur template.');
+    console.error(error.message);
+    process.exit(1);
+  }
+
+  // Masuk ke folder project
+  process.chdir(projectPath);
+
+  // 3. Setup .env
+  const envSpinner = ora('Menyiapkan file .env...').start();
+  try {
+    const envExamplePath = path.join(projectPath, '.env.example');
+    const envPath = path.join(projectPath, '.env');
+    
+    if (fs.existsSync(envExamplePath)) {
+      let envContent = fs.readFileSync(envExamplePath, 'utf-8');
+      
+      envContent = envContent.replace(/__DATABASE_NAME__/g, answers.database);
+      envContent = envContent.replace(/APP_NAME=my-app/g, `APP_NAME=${projectName === '.' ? path.basename(currentPath) : projectName}`);
+      
+      fs.writeFileSync(envPath, envContent);
+      envSpinner.succeed('File .env berhasil dibuat.');
+    } else {
+      envSpinner.warn('File .env.example tidak ditemukan, lewati setup .env.');
+    }
+  } catch (error) {
+    envSpinner.fail('Gagal menyiapkan file .env.');
+  }
+  
+  // 4. Inisialisasi Git
+  try {
+    execSync('git init', { stdio: 'ignore' });
+  } catch (e) {
+    // Abaikan jika user tidak punya git terinstall
+  }
+
+  // 5. Install Dependencies
+  if (!answers.skipInstall) {
+    const installSpinner = ora(`Menginstal dependencies menggunakan npm... (ini butuh waktu beberapa menit)`).start();
+    try {
+      execSync(`npm install`, { stdio: 'ignore' });
+      installSpinner.succeed('Dependencies berhasil diinstal.');
+    } catch (error) {
+      installSpinner.fail('Gagal menginstal dependencies.');
+      console.log(chalk.yellow('\nKamu bisa menginstalnya secara manual nanti.'));
+    }
+  }
+
+  // 6. Success Message
+  console.log(chalk.green.bold('\n✅ Project Berhasil Dibuat!\n'));
+  console.log(chalk.white('Langkah selanjutnya:'));
+  
+  if (projectName !== '.') {
+    console.log(chalk.cyan(`  cd ${projectName}`));
+  }
+  
+  if (answers.skipInstall) {
+    console.log(chalk.cyan(`  npm install`));
+  }
+  
+  console.log(chalk.cyan(`  npx prisma migrate dev`));
+  console.log(chalk.cyan(`  npx prisma db seed`));
+  console.log(chalk.cyan(`  npm run start:dev\n`));
+  console.log(chalk.gray(`Happy Coding! - Kuli Digital\n`));
+}
+
+run();

package/template/.editorconfig

@@ -0,0 +1,12 @@
+root = true
+
+[*]
+charset = utf-8
+indent_style = space
+indent_size = 2
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.md]
+trim_trailing_whitespace = false

package/template/.env.example

@@ -0,0 +1,23 @@
+# Application
+NODE_ENV=development
+PORT=3000
+APP_NAME=my-app
+
+# Database
+DATABASE_URL="postgresql://username:password@localhost:5432/__DATABASE_NAME__?schema=public"
+
+# JWT
+JWT_SECRET=your-super-secret-jwt-key-change-this-in-production
+JWT_EXPIRATION=7d
+JWT_REFRESH_SECRET=your-super-secret-refresh-key-change-this-in-production
+JWT_REFRESH_EXPIRATION=30d
+
+# CORS
+CORS_ORIGIN=http://localhost:3001
+
+# API
+API_PREFIX=api
+
+# Swagger
+SWAGGER_ENABLED=true
+SWAGGER_PATH=docs

package/template/.eslintrc.js

@@ -0,0 +1,25 @@
+module.exports = {
+  parser: '@typescript-eslint/parser',
+  parserOptions: {
+    project: 'tsconfig.json',
+    tsconfigRootDir: __dirname,
+    sourceType: 'module',
+  },
+  plugins: ['@typescript-eslint/eslint-plugin'],
+  extends: [
+    'plugin:@typescript-eslint/recommended',
+    'plugin:prettier/recommended',
+  ],
+  root: true,
+  env: {
+    node: true,
+    jest: true,
+  },
+  ignorePatterns: ['.eslintrc.js'],
+  rules: {
+    '@typescript-eslint/interface-name-prefix': 'off',
+    '@typescript-eslint/explicit-function-return-type': 'off',
+    '@typescript-eslint/explicit-module-boundary-types': 'off',
+    '@typescript-eslint/no-explicit-any': 'off',
+  },
+};

package/template/.prettierrc

@@ -0,0 +1,8 @@
+{
+  "singleQuote": true,
+  "trailingComma": "all",
+  "tabWidth": 2,
+  "semi": true,
+  "printWidth": 100,
+  "arrowParens": "always"
+}

package/template/README.md

@@ -0,0 +1,133 @@
+# Kuli Digital NestJS Backend
+
+Backend application built with NestJS following Kuli Digital standardization manual.
+
+## Features
+
+- 🔐 JWT Authentication with RBAC
+- 📝 Complete User Management
+- 🎯 Permission-based Access Control
+- 📚 Auto-generated Swagger Documentation
+- ✅ Input Validation
+- 🔄 API Versioning
+- 📊 Structured Logging
+- 🗃️ Prisma ORM with PostgreSQL
+- 🧪 Testing Setup (Unit & E2E)
+
+## Prerequisites
+
+- Node.js >= 18.x
+- PostgreSQL >= 14.x
+- npm/yarn/pnpm
+
+## Installation
+```bash
+# Install dependencies
+npm install
+
+# Setup environment variables
+cp .env.example .env
+# Edit .env with your database credentials
+
+# Generate Prisma Client
+npm run prisma:generate
+
+# Run migrations
+npm run prisma:migrate
+
+# Seed database
+npm run prisma:seed
+```
+
+## Running the Application
+```bash
+# Development
+npm run start:dev
+
+# Production build
+npm run build
+npm run start:prod
+
+# Debug mode
+npm run start:debug
+```
+
+## Database Commands
+```bash
+# Generate Prisma Client
+npm run prisma:generate
+
+# Create migration
+npm run prisma:migrate
+
+# Seed database
+npm run prisma:seed
+
+# Open Prisma Studio
+npm run prisma:studio
+```
+
+## Testing
+```bash
+# Unit tests
+npm run test
+
+# E2E tests
+npm run test:e2e
+
+# Test coverage
+npm run test:cov
+```
+
+## API Documentation
+
+After starting the application, visit:
+- Swagger UI: `http://localhost:3000/api-docs`
+
+## Default Users
+
+After seeding the database:
+
+**Admin User:**
+- Email: `admin@kulidigital.com`
+- Password: `password123`
+- All permissions granted
+
+**Member User:**
+- Email: `member@kulidigital.com`
+- Password: `password123`
+- Limited permissions (VIEW_USER only)
+
+## Project Structure
+```
+src/
+├── common/              # Shared resources
+│   ├── decorators/      # Custom decorators
+│   ├── filters/         # Exception filters
+│   ├── guards/          # Auth & permission guards
+│   ├── interceptors/    # Logging & transform
+│   ├── prisma/          # Prisma service
+│   └── utils/           # Helper functions
+├── config/              # Configuration files
+├── modules/             # Feature modules
+│   ├── auth/            # Authentication
+│   ├── users/           # User management
+│   └── health/          # Health checks
+├── app.module.ts        # Root module
+└── main.ts              # Application entry point
+```
+
+## Environment Variables
+
+See `.env.example` for all available configuration options.
+
+## License
+
+Proprietary - Kuli Digital
+```
+
+### 20.2 .gitkeep for migrations
+
+**templates/nestjs-app/prisma/migrations/.gitkeep**
+```
+# This file keeps the migrations directory in git

package/template/nest-cli.json

@@ -0,0 +1,10 @@
+{
+  "$schema": "https://json.schemastore.org/nest-cli",
+  "collection": "@nestjs/schematics",
+  "sourceRoot": "src",
+  "compilerOptions": {
+    "deleteOutDir": true,
+    "webpack": true,
+    "tsConfigPath": "tsconfig.json"
+  }
+}