rapidkit 0.11.3 → 0.12.1

package/templates/kits/nestjs-standard/.rapidkit/rapidkit.j2

@@ -0,0 +1,227 @@
+#!/usr/bin/env bash
+# RapidKit CLI wrapper for NestJS projects (npm demo template)
+# This script provides local commands that mirror the full RapidKit engine.
+
+set -e
+
+PROJECT_ROOT="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd)"
+cd "$PROJECT_ROOT"
+
+print_banner() {
+    local emoji="$1"
+    local message="$2"
+    echo "$emoji $message"
+}
+
+check_node() {
+    if ! command -v node &> /dev/null; then
+        echo "❌ Node.js not found. Please install Node.js first."
+        exit 1
+    fi
+}
+
+check_npm_or_pnpm() {
+    if command -v pnpm &> /dev/null; then
+        echo "pnpm"
+    elif command -v npm &> /dev/null; then
+        echo "npm"
+    else
+        echo "❌ Neither npm nor pnpm found. Please install Node.js first."
+        exit 1
+    fi
+}
+
+cmd_init() {
+    print_banner "📦" "Bootstrapping NestJS project (installing dependencies)"
+    check_node
+    
+    local pkg_manager=$(check_npm_or_pnpm)
+    
+    if [ "$pkg_manager" = "pnpm" ]; then
+        pnpm install
+    else
+        npm install
+    fi
+    
+    echo "✅ Dependencies installed successfully!"
+}
+
+cmd_dev() {
+    local port="${1:-8000}"
+    local host="${2:-0.0.0.0}"
+    
+    print_banner "🚀" "Starting NestJS development server with hot reload..."
+    check_node
+    
+    if [ ! -d "node_modules" ]; then
+        echo "❌ node_modules not found. Run 'rapidkit init' first."
+        exit 1
+    fi
+    
+    local pkg_manager=$(check_npm_or_pnpm)
+    
+    if [ "$pkg_manager" = "pnpm" ]; then
+        PORT="$port" HOST="$host" pnpm run start:dev
+    else
+        PORT="$port" HOST="$host" npm run start:dev
+    fi
+}
+
+cmd_start() {
+    local port="${1:-8000}"
+    local host="${2:-0.0.0.0}"
+    
+    print_banner "⚡" "Starting NestJS production server..."
+    check_node
+    
+    if [ ! -d "node_modules" ]; then
+        echo "❌ node_modules not found. Run 'rapidkit init' first."
+        exit 1
+    fi
+    
+    local pkg_manager=$(check_npm_or_pnpm)
+    
+    if [ "$pkg_manager" = "pnpm" ]; then
+        PORT="$port" HOST="$host" pnpm run start:prod
+    else
+        PORT="$port" HOST="$host" npm run start:prod
+    fi
+}
+
+cmd_build() {
+    print_banner "📦" "Building NestJS project..."
+    check_node
+    
+    local pkg_manager=$(check_npm_or_pnpm)
+    
+    if [ "$pkg_manager" = "pnpm" ]; then
+        pnpm run build
+    else
+        npm run build
+    fi
+    
+    echo "✅ Build completed!"
+}
+
+cmd_test() {
+    print_banner "🧪" "Running tests..."
+    check_node
+    
+    local pkg_manager=$(check_npm_or_pnpm)
+    
+    if [ "$pkg_manager" = "pnpm" ]; then
+        pnpm run test
+    else
+        npm run test
+    fi
+}
+
+cmd_lint() {
+    print_banner "🔧" "Running ESLint..."
+    check_node
+    
+    local pkg_manager=$(check_npm_or_pnpm)
+    
+    if [ "$pkg_manager" = "pnpm" ]; then
+        pnpm run lint
+    else
+        npm run lint
+    fi
+}
+
+cmd_format() {
+    print_banner "✨" "Formatting code with Prettier..."
+    check_node
+    
+    local pkg_manager=$(check_npm_or_pnpm)
+    
+    if [ "$pkg_manager" = "pnpm" ]; then
+        pnpm run format
+    else
+        npm run format
+    fi
+}
+
+cmd_help() {
+    print_banner "📚" "RapidKit NestJS Project Commands"
+    echo ""
+    echo "Usage: rapidkit <command> [options]"
+    echo ""
+    echo "Commands:"
+    echo "  init         📦 Initialize project (install dependencies)"
+    echo "  dev          🚀 Start development server with hot reload"
+    echo "  start        ⚡ Start production server"
+    echo "  build        📦 Build for production"
+    echo "  test         🧪 Run tests"
+    echo "  lint         🔧 Lint code"
+    echo "  format       ✨ Format code"
+    echo "  help         📚 Show this help"
+    echo ""
+    echo "Options for dev/start:"
+    echo "  -p, --port <port>   Port number (default: 8000)"
+    echo "  --host <host>       Host address (default: 0.0.0.0)"
+    echo ""
+    echo "💡 Note: This is a demo project. For full RapidKit features:"
+    echo "   pipx install rapidkit"
+}
+
+# Parse command
+COMMAND="${1:-help}"
+shift || true
+
+# Parse options
+PORT="8000"
+HOST="0.0.0.0"
+
+while [[ $# -gt 0 ]]; do
+    case $1 in
+        -p|--port)
+            PORT="$2"
+            shift 2
+            ;;
+        --host)
+            HOST="$2"
+            shift 2
+            ;;
+        -h|--help)
+            cmd_help
+            exit 0
+            ;;
+        *)
+            shift
+            ;;
+    esac
+done
+
+case "$COMMAND" in
+    init)
+        cmd_init
+        ;;
+    dev)
+        cmd_dev "$PORT" "$HOST"
+        ;;
+    start)
+        cmd_start "$PORT" "$HOST"
+        ;;
+    build)
+        cmd_build
+        ;;
+    test)
+        cmd_test
+        ;;
+    lint)
+        cmd_lint
+        ;;
+    format)
+        cmd_format
+        ;;
+    help|-h|--help)
+        cmd_help
+        ;;
+    *)
+        echo "❌ Unknown command: $COMMAND"
+        echo ""
+        cmd_help
+        exit 1
+        ;;
+esac

package/templates/kits/nestjs-standard/README.md.j2

@@ -0,0 +1,97 @@
+# {{ project_name | replace('-', ' ') | title }}
+
+{{ description }}
+
+A production-ready NestJS 11 application generated with RapidKit.
+
+## 🚀 Getting Started
+
+### Prerequisites
+
+- Node.js >= 20 (check with `node --version`)
+- {{ package_manager }} package manager
+
+### Installation
+
+```bash
+# Install dependencies
+{{ package_manager }} install
+
+# Copy environment file
+cp .env.example .env
+
+# Start development server
+{{ package_manager }} run dev
+```
+
+Your API will be available at `http://localhost:8000`
+API docs available at `http://localhost:8000/docs`
+
+## 📚 Available Scripts
+
+| Command | Description |
+|---------|-------------|
+| `{{ package_manager }} run dev` | Start development server with hot reload |
+| `{{ package_manager }} run build` | Build for production |
+| `{{ package_manager }} start` | Start production server |
+| `{{ package_manager }} test` | Run unit tests |
+| `{{ package_manager }} run test:e2e` | Run e2e tests |
+| `{{ package_manager }} run test:cov` | Run tests with coverage |
+| `{{ package_manager }} run lint` | Lint and fix code |
+| `{{ package_manager }} run format` | Format code with Prettier |
+
+## 📁 Project Structure
+
+```
+{{ project_name }}/
+├── src/
+│   ├── main.ts              # Application entry point
+│   ├── app.module.ts        # Root module
+│   ├── app.controller.ts    # Root controller
+│   ├── app.service.ts       # Root service
+│   ├── config/              # Configuration module
+│   ├── examples/            # Example feature module
+│   └── modules/             # RapidKit modules
+├── test/                    # Test files
+├── package.json             # Dependencies
+├── tsconfig.json            # TypeScript config
+└── nest-cli.json            # NestJS CLI config
+```
+
+## 🔧 Configuration
+
+Environment variables are managed through `.env` file:
+
+- `APP_NAME` - Application name
+- `PORT` - Server port (default: 8000)
+- `HOST` - Server host (default: 0.0.0.0)
+- `NODE_ENV` - Environment (development/production/test)
+
+## 🧪 Example API
+
+The scaffold includes an example Notes API:
+
+```bash
+# Create a note
+curl -X POST http://localhost:8000/examples/notes \
+  -H "Content-Type: application/json" \
+  -d '{"title":"Hello","body":"World"}'
+
+# List all notes
+curl http://localhost:8000/examples/notes
+
+# Get health status
+curl http://localhost:8000/health
+```
+
+## 📖 Learn More
+
+- [NestJS Documentation](https://docs.nestjs.com)
+- [RapidKit Documentation](https://rapidkit.top)
+
+## 📄 License
+
+This project is licensed under the {{ license }} License.
+
+---
+Generated with ❤️ by RapidKit

package/templates/kits/nestjs-standard/jest.config.ts.j2

@@ -0,0 +1,21 @@
+import type { Config } from 'jest';
+
+const config: Config = {
+  moduleFileExtensions: ['js', 'json', 'ts'],
+  rootDir: '.',
+  testEnvironment: 'node',
+  testRegex: '.*\\.spec.ts$',
+  transform: {
+    '^.+\\.ts$': 'ts-jest',
+  },
+  collectCoverageFrom: ['src/**/*.{ts,tsx}', '!src/**/*.module.ts'],
+  coverageDirectory: './coverage',
+  moduleNameMapper: {
+    '^@config/(.*)$': '<rootDir>/src/config/$1',
+    '^@modules/(.*)$': '<rootDir>/src/modules/$1',
+    '^@shared/(.*)$': '<rootDir>/src/shared/$1',
+  },
+  setupFiles: ['dotenv/config'],
+};
+
+export default config;

package/templates/kits/nestjs-standard/nest-cli.json.j2

@@ -0,0 +1,10 @@
+{
+  "collection": "@nestjs/schematics",
+  "sourceRoot": "src",
+  "entryFile": "main",
+  "compilerOptions": {
+    "deleteOutDir": true,
+    "webpack": false,
+    "tsConfigPath": "tsconfig.build.json"
+  }
+}

package/templates/kits/nestjs-standard/package.json.j2

@@ -0,0 +1,75 @@
+{
+  "name": "{{ project_name | replace('_', '-') | lower }}",
+  "version": "{{ app_version }}",
+  "description": "{{ description }}",
+  "license": "{{ license }}",
+  "author": "{{ author }}",
+  "engines": {
+    "node": ">=20"
+  },
+  "private": true,
+  "scripts": {
+    "rapidkit": "./.rapidkit/rapidkit",
+    "rapidkit:init": "npm install",
+    "rapidkit:dev": "./.rapidkit/rapidkit dev",
+    "rapidkit:start": "./.rapidkit/rapidkit start",
+    "rapidkit:build": "./.rapidkit/rapidkit build",
+    "rapidkit:test": "./.rapidkit/rapidkit test",
+    "rapidkit:lint": "./.rapidkit/rapidkit lint",
+    "rapidkit:format": "./.rapidkit/rapidkit format",
+    "start": "node dist/main",
+    "dev": "nest start --watch",
+    "start:dev": "nest start --watch",
+    "start:debug": "nest start --debug --watch",
+    "start:prod": "node dist/main",
+    "build": "nest build",
+    "lint": "eslint \"{src,test}/**/*.ts\" --fix",
+    "format": "prettier --write \"src/**/*.ts\" \"test/**/*.ts\"",
+    "test": "jest",
+    "test:watch": "jest --watch",
+    "test:cov": "jest --coverage",
+    "test:e2e": "jest --config ./test/jest-e2e.json"
+  },
+  "dependencies": {
+    "@nestjs/common": "^11.1.6",
+    "@nestjs/config": "^4.0.2",
+    "@nestjs/core": "^11.1.6",
+    "@nestjs/platform-express": "^11.1.6",
+    "@nestjs/swagger": "^11.2.3",
+    "class-transformer": "^0.5.1",
+    "class-validator": "^0.14.0",
+    "reflect-metadata": "^0.2.1",
+    "rxjs": "^7.8.1",
+    "helmet": "^7.0.0",
+    "compression": "^1.7.4",
+    "winston": "^3.11.0",
+    "joi": "^17.12.1",
+    "@nestjs/terminus": "^11.0.0",
+    "dotenv": "^16.3.1"
+  },
+  "devDependencies": {
+    "@nestjs/cli": "^11.0.10",
+    "@nestjs/schematics": "^11.0.7",
+    "@nestjs/testing": "^11.1.6",
+    "@types/compression": "^1.7.5",
+    "@types/express": "^4.17.21",
+    "@types/jest": "^29.5.12",
+    "@types/node": "^22.8.5",
+    "@types/supertest": "^2.0.16",
+    "@typescript-eslint/eslint-plugin": "^8.46.1",
+    "@typescript-eslint/parser": "^8.46.1",
+    "eslint": "^8.57.1",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-import": "^2.32.0",
+    "eslint-plugin-prettier": "^5.5.4",
+    "jest": "^29.7.0",
+    "prettier": "^3.6.2",
+    "source-map-support": "^0.5.21",
+    "supertest": "^7.1.4",
+    "ts-jest": "^29.4.5",
+    "ts-loader": "^9.5.4",
+    "ts-node": "^10.9.2",
+    "tsconfig-paths": "^4.2.0",
+    "typescript": "^5.9.3"
+  }
+}

package/templates/kits/nestjs-standard/rapidkit.j2

@@ -0,0 +1,5 @@
+#!/usr/bin/env bash
+# RapidKit CLI - Local project commands
+# This wrapper delegates to .rapidkit/rapidkit
+
+exec "$(dirname "$0")/.rapidkit/rapidkit" "$@"

package/templates/kits/nestjs-standard/src/app.controller.ts.j2

@@ -0,0 +1,12 @@
+import { Controller, Get } from '@nestjs/common';
+import { AppService } from './app.service';
+
+@Controller()
+export class AppController {
+  constructor(private readonly appService: AppService) {}
+
+  @Get('health')
+  getHealth() {
+    return this.appService.getHealth();
+  }
+}

package/templates/kits/nestjs-standard/src/app.module.ts.j2

@@ -0,0 +1,23 @@
+import { Module } from '@nestjs/common';
+import { ConfigModule } from '@nestjs/config';
+
+import configuration from './config/configuration';
+import { validationSchema } from './config/validation';
+import { AppController } from './app.controller';
+import { AppService } from './app.service';
+import { ExamplesModule } from './examples/examples.module';
+
+@Module({
+  imports: [
+    ConfigModule.forRoot({
+      isGlobal: true,
+      load: [configuration],
+      validationSchema,
+      expandVariables: true,
+    }),
+    ExamplesModule,
+  ],
+  controllers: [AppController],
+  providers: [AppService],
+})
+export class AppModule {}

package/templates/kits/nestjs-standard/src/app.service.ts.j2

@@ -0,0 +1,11 @@
+import { Injectable } from '@nestjs/common';
+
+@Injectable()
+export class AppService {
+  getHealth() {
+    return {
+      status: 'ok',
+      timestamp: new Date().toISOString(),
+    };
+  }
+}

package/templates/kits/nestjs-standard/src/config/configuration.ts.j2

@@ -0,0 +1,9 @@
+import { registerAs } from '@nestjs/config';
+
+export default registerAs('app', () => ({
+  name: process.env.APP_NAME ?? '{{ project_name }}',
+  env: process.env.NODE_ENV ?? 'development',
+  host: process.env.HOST ?? '0.0.0.0',
+  port: parseInt(process.env.PORT ?? '8000', 10),
+  logLevel: process.env.LOG_LEVEL ?? 'info',
+}));

package/templates/kits/nestjs-standard/src/config/index.ts.j2

@@ -0,0 +1,2 @@
+export { default } from './configuration';
+export * from './validation';

package/templates/kits/nestjs-standard/src/config/validation.ts.j2

@@ -0,0 +1,11 @@
+import * as Joi from 'joi';
+
+export const validationSchema = Joi.object({
+  APP_NAME: Joi.string().default('{{ project_name }}'),
+  NODE_ENV: Joi.string().valid('development', 'production', 'test').default('development'),
+  HOST: Joi.string().hostname().default('0.0.0.0'),
+  PORT: Joi.number().port().default(8000),
+  LOG_LEVEL: Joi.string()
+    .valid('error', 'warn', 'log', 'debug', 'verbose')
+    .default('log'),
+});

package/templates/kits/nestjs-standard/src/examples/dto/create-note.dto.ts.j2

@@ -0,0 +1,11 @@
+import { IsString, MaxLength } from 'class-validator';
+
+export class CreateNoteDto {
+  @IsString()
+  @MaxLength(80)
+  title!: string;
+
+  @IsString()
+  @MaxLength(500)
+  body!: string;
+}

package/templates/kits/nestjs-standard/src/examples/examples.controller.ts.j2

@@ -0,0 +1,24 @@
+import { Body, Controller, Get, Param, ParseIntPipe, Post } from '@nestjs/common';
+
+import { CreateNoteDto } from './dto/create-note.dto';
+import { ExamplesService } from './examples.service';
+
+@Controller('examples/notes')
+export class ExamplesController {
+  constructor(private readonly examplesService: ExamplesService) {}
+
+  @Post()
+  create(@Body() payload: CreateNoteDto) {
+    return this.examplesService.create(payload);
+  }
+
+  @Get()
+  findAll() {
+    return this.examplesService.findAll();
+  }
+
+  @Get(':id')
+  findOne(@Param('id', ParseIntPipe) id: number) {
+    return this.examplesService.findOne(id);
+  }
+}

package/templates/kits/nestjs-standard/src/examples/examples.module.ts.j2

@@ -0,0 +1,10 @@
+import { Module } from '@nestjs/common';
+
+import { ExamplesController } from './examples.controller';
+import { ExamplesService } from './examples.service';
+
+@Module({
+  controllers: [ExamplesController],
+  providers: [ExamplesService],
+})
+export class ExamplesModule {}

package/templates/kits/nestjs-standard/src/examples/examples.service.ts.j2

@@ -0,0 +1,33 @@
+import { Injectable, NotFoundException } from '@nestjs/common';
+
+import { CreateNoteDto } from './dto/create-note.dto';
+
+export interface ExampleNote {
+  id: number;
+  title: string;
+  body: string;
+}
+
+@Injectable()
+export class ExamplesService {
+  private notes: ExampleNote[] = [];
+  private sequence = 1;
+
+  create(payload: CreateNoteDto): ExampleNote {
+    const note: ExampleNote = { id: this.sequence++, ...payload };
+    this.notes.push(note);
+    return note;
+  }
+
+  findAll(): ExampleNote[] {
+    return [...this.notes];
+  }
+
+  findOne(id: number): ExampleNote {
+    const note = this.notes.find((entry) => entry.id === id);
+    if (!note) {
+      throw new NotFoundException('Note not found');
+    }
+    return note;
+  }
+}

package/templates/kits/nestjs-standard/src/main.ts.j2

@@ -0,0 +1,51 @@
+import { Logger } from '@nestjs/common';
+import { SwaggerModule, DocumentBuilder } from '@nestjs/swagger';
+import { NestFactory } from '@nestjs/core';
+import helmet from 'helmet';
+import compression from 'compression';
+
+import { AppModule } from './app.module';
+
+async function bootstrap() {
+  const app = await NestFactory.create(AppModule, {
+    bufferLogs: true,
+  });
+
+  const logger = new Logger('Bootstrap');
+
+  app.use(helmet());
+  app.use(compression());
+
+  app.enableCors({
+    origin: '*',
+    credentials: true,
+  });
+
+  const port = parseInt(process.env.PORT ?? '8000', 10);
+  const host = process.env.HOST ?? '0.0.0.0';
+
+  // Enable Swagger docs in development or when explicitly requested.
+  const enableDocs = process.env.RAPIDKIT_ENABLE_SWAGGER === '1' || process.env.NODE_ENV !== 'production';
+  if (enableDocs) {
+    const config = new DocumentBuilder()
+      .setTitle('{{ project_name }} API')
+      .setDescription('{{ description }}')
+      .setVersion('{{ app_version }}')
+      .addBearerAuth()
+      .build();
+
+    const document = SwaggerModule.createDocument(app, config);
+    SwaggerModule.setup('docs', app, document);
+  }
+
+  await app.listen(port, host);
+
+  logger.log(`🚀 Application is running on http://${host}:${port}`);
+  logger.log(`📚 API docs available at http://${host}:${port}/docs`);
+}
+
+bootstrap().catch((error) => {
+  // eslint-disable-next-line no-console
+  console.error('❌ Failed to bootstrap application', error);
+  process.exit(1);
+});

package/templates/kits/nestjs-standard/src/modules/index.ts.j2

@@ -0,0 +1,3 @@
+// Central export for RapidKit modules
+// Add module exports here as needed
+export const rapidkitModules = [];

package/templates/kits/nestjs-standard/test/app.controller.spec.ts.j2

@@ -0,0 +1,22 @@
+import { Test, TestingModule } from '@nestjs/testing';
+
+import { AppController } from '../src/app.controller';
+import { AppService } from '../src/app.service';
+
+describe('AppController', () => {
+  let appController: AppController;
+
+  beforeEach(async () => {
+    const app: TestingModule = await Test.createTestingModule({
+      controllers: [AppController],
+      providers: [AppService],
+    }).compile();
+
+    appController = app.get<AppController>(AppController);
+  });
+
+  it('should return health status', () => {
+    const result = appController.getHealth();
+    expect(result).toHaveProperty('status', 'ok');
+  });
+});