NestJS Drizzle CRUD 生成器 - 自动生成类型安全的 NestJS 后端模块

nestjs-drizzle-crud-generator by giuseppe-trisciuoglio/developer-kit

201 周安装量

173 GitHub Stars

GitHub

安装命令

npx skills add https://github.com/giuseppe-trisciuoglio/developer-kit --skill nestjs-drizzle-crud-generator

Node.js 自动化代码生成

🇨🇳中文介绍

NestJS Drizzle CRUD 生成器

概述

此技能使用 Drizzle ORM 为 NestJS 应用程序自动生成完整的 CRUD（创建、读取、更新、删除）模块。它遵循 zaccheroni-monorepo 模式创建所有必需的文件。

使用场景

为新的实体模块创建完整的 CRUD 端点
在 NestJS 中构建基于数据库的功能
生成带有 Zod 验证的类型安全 DTO
添加使用 Drizzle ORM 查询的服务
创建带有模拟数据库的单元测试

使用说明

步骤 1：确定功能需求

生成前，请收集：

实体名称（例如：user、product、order）
字段列表及其类型
必填字段与可选字段

步骤 2：运行生成器

执行生成脚本：

python scripts/generate_crud.py --feature <name> --fields '<json-array>' --output <path>

步骤 3：字段定义格式

字段必须定义为包含名称、类型和必需属性的 JSON 数组。

步骤 4：集成模块

生成后，将模块集成到您的 NestJS 应用程序中。

广告位招租

在这里展示您的产品或服务

触达数万 AI 开发者，精准高效

联系我们

示例 1：生成用户模块

python scripts/generate_crud.py \
  --feature user \
  --fields '[{"name": "name", "type": "string", "required": true}, {"name": "email", "type": "string", "required": true}, {"name": "password", "type": "string", "required": true}]' \
  --output ./libs/server

示例 2：生成产品模块

python scripts/generate_crud.py \
  --feature product \
  --fields '[{"name": "title", "type": "string", "required": true}, {"name": "price", "type": "number", "required": true}, {"name": "description", "type": "text", "required": false}, {"name": "inStock", "type": "boolean", "required": false, "default": true}]' \
  --output ./libs/server

步骤 1：确定功能需求

生成前，请收集：

实体名称（例如：user、product、order）
字段列表及其类型
必填字段与可选字段

步骤 2：运行生成器

执行生成脚本：

python scripts/generate_crud.py --feature <name> --fields '<json-array>' --output <path>

步骤 3：字段定义格式

字段必须定义为 JSON 数组：

[
  {"name": "name", "type": "string", "required": true},
  {"name": "email", "type": "string", "required": true},
  {"name": "age", "type": "integer", "required": false},
  {"name": "isActive", "type": "boolean", "required": false, "default": true},
  {"name": "price", "type": "number", "required": true},
  {"name": "description", "type": "text", "required": false},
  {"name": "uuid", "type": "uuid", "required": false}
]

步骤 4：示例命令

生成用户模块：

python scripts/generate_crud.py \
  --feature user \
  --fields '[{"name": "name", "type": "string", "required": true}, {"name": "email", "type": "string", "required": true}, {"name": "password", "type": "string", "required": true}]' \
  --output ./libs/server

生成产品模块：

python scripts/generate_crud.py \
  --feature product \
  --fields '[{"name": "title", "type": "string", "required": true}, {"name": "price", "type": "number", "required": true}, {"name": "description", "type": "text", "required": false}, {"name": "inStock", "type": "boolean", "required": false, "default": true}]' \
  --output ./libs/server

生成器创建以下目录结构：

libs/server/{feature-name}/
├── src/
│   ├── index.ts
│   └── lib/
│       ├── {feature}-feature.module.ts
│       ├── controllers/
│       │   ├── index.ts
│       │   └── {feature}.controller.ts
│       ├── services/
│       │   ├── index.ts
│       │   ├── {feature}.service.ts
│       │   └── {feature}.service.spec.ts
│       ├── dto/
│       │   ├── index.ts
│       │   └── {feature}.dto.ts
│       └── schema/
│           └── {feature}.table.ts

支持的字段类型

类型	Drizzle 列	Zod 模式
string	text	z.string()
text	text	z.string()
number	real	z.number()
integer	integer	z.number().int()
boolean	boolean	z.boolean()
date	timestamp	z.date()
uuid	uuid	z.string().uuid()
email	text	z.string().email()

使用 forRootAsync 模式进行延迟配置
导出生成的服务供其他模块使用
导入 DatabaseModule 以使用功能表

完整的 CRUD 端点：POST、GET、PATCH、DELETE
分页查询参数验证
Zod 验证管道集成

Drizzle ORM 查询方法
支持软删除（通过 deletedAt 列）
带 limit/offset 的分页
支持过滤
类型安全的返回类型

用于创建和更新的 Zod 模式
用于过滤的查询参数模式
NestJS DTO 集成

Jest 测试套件
模拟的 Drizzle 数据库
所有 CRUD 操作的测试用例

生成后，将其集成到您的应用模块中：

// app.module.ts
import { {{FeatureName}}FeatureModule } from '@your-org/server-{{feature}}';

@Module({
  imports: [
    {{FeatureName}}FeatureModule.forRootAsync({
      useFactory: () => ({
        defaultPageSize: 10,
        maxPageSize: 100,
      }),
    }),
  ],
})
export class AppModule {}

每个字段支持：

name：字段名称
type：数据类型（string、text、number、integer、boolean、date、uuid、email）
required：布尔值，表示是否为必填字段
default：非必填字段的默认值
maxLength：字符串的最大长度
minLength：字符串的最小长度

生成的代码需要：

@nestjs/common
@nestjs/core
drizzle-orm
drizzle-zod
zod
nestjs-zod

验证生成的代码：在提交前始终检查生成的文件
运行测试：执行单元测试以验证生成的代码正常工作
按需定制：生成后向服务中添加业务逻辑
数据库迁移：为生成的模式手动创建迁移
类型安全：在您的应用程序代码中使用生成的类型

仅支持软删除：生成的删除方法使用软删除（设置 deletedAt）。硬删除需要手动修改
无身份验证：生成的代码不包含身份验证守卫 - 需要单独添加
仅基本 CRUD：复杂的查询或业务逻辑必须手动实现
JSON 字段转义：在命令行中传递字段 JSON 时，请使用单引号包裹 JSON 数组

🇺🇸English

NestJS Drizzle CRUD Generator

Overview

This skill automatically generates complete CRUD (Create, Read, Update, Delete) modules for NestJS applications using Drizzle ORM. It creates all necessary files following the zaccheroni-monorepo patterns.

When to Use

Creating new entity modules with full CRUD endpoints
Building database-backed features in NestJS
Generating type-safe DTOs with Zod validation
Adding services with Drizzle ORM queries
Creating unit tests with mocked database

Instructions

Step 1: Identify Feature Requirements

Before generating, gather:

Entity name (e.g., user, product, order)
List of fields with types
Required fields vs optional fields

Step 2: Run the Generator

Execute the generation script:

python scripts/generate_crud.py --feature <name> --fields '<json-array>' --output <path>

Step 3: Field Definition Format

Fields must be defined as JSON array with name, type, and required properties.

Step 4: Integrate Module

After generation, integrate the module into your NestJS application.

Examples

Example 1: Generate a User module

python scripts/generate_crud.py \
  --feature user \
  --fields '[{"name": "name", "type": "string", "required": true}, {"name": "email", "type": "string", "required": true}, {"name": "password", "type": "string", "required": true}]' \
  --output ./libs/server

Example 2: Generate a Product module

python scripts/generate_crud.py \
  --feature product \
  --fields '[{"name": "title", "type": "string", "required": true}, {"name": "price", "type": "number", "required": true}, {"name": "description", "type": "text", "required": false}, {"name": "inStock", "type": "boolean", "required": false, "default": true}]' \
  --output ./libs/server

Quick Start

Step 1: Identify Feature Requirements

Before generating, gather:

Entity name (e.g., user, product, order)
List of fields with types
Required fields vs optional fields

Step 2: Run the Generator

Execute the generation script:

python scripts/generate_crud.py --feature <name> --fields '<json-array>' --output <path>

Step 3: Field Definition Format

Fields must be defined as JSON array:

[
  {"name": "name", "type": "string", "required": true},
  {"name": "email", "type": "string", "required": true},
  {"name": "age", "type": "integer", "required": false},
  {"name": "isActive", "type": "boolean", "required": false, "default": true},
  {"name": "price", "type": "number", "required": true},
  {"name": "description", "type": "text", "required": false},
  {"name": "uuid", "type": "uuid", "required": false}
]

Step 4: Example Commands

Generate a User module:

python scripts/generate_crud.py \
  --feature user \
  --fields '[{"name": "name", "type": "string", "required": true}, {"name": "email", "type": "string", "required": true}, {"name": "password", "type": "string", "required": true}]' \
  --output ./libs/server

Generate a Product module:

python scripts/generate_crud.py \
  --feature product \
  --fields '[{"name": "title", "type": "string", "required": true}, {"name": "price", "type": "number", "required": true}, {"name": "description", "type": "text", "required": false}, {"name": "inStock", "type": "boolean", "required": false, "default": true}]' \
  --output ./libs/server

Generated Structure

The generator creates this directory structure:

libs/server/{feature-name}/
├── src/
│   ├── index.ts
│   └── lib/
│       ├── {feature}-feature.module.ts
│       ├── controllers/
│       │   ├── index.ts
│       │   └── {feature}.controller.ts
│       ├── services/
│       │   ├── index.ts
│       │   ├── {feature}.service.ts
│       │   └── {feature}.service.spec.ts
│       ├── dto/
│       │   ├── index.ts
│       │   └── {feature}.dto.ts
│       └── schema/
│           └── {feature}.table.ts

Supported Field Types

Type	Drizzle Column	Zod Schema
string	text	z.string()
text	text	z.string()
number	real	z.number()
integer	integer	z.number().int()
boolean	boolean	z.boolean()
date	timestamp	z.date()
uuid	uuid	z.string().uuid()
email	text	z.string().email()

Features

Module

Uses forRootAsync pattern for lazy configuration
Exports generated service for other modules
Imports DatabaseModule for feature tables

Controller

Full CRUD endpoints: POST, GET, PATCH, DELETE
Query parameter validation for pagination
Zod validation pipe integration

Service

Drizzle ORM query methods
Soft delete support (via deletedAt column)
Pagination with limit/offset
Filtering support
Type-safe return types

DTOs

Zod schemas for Create and Update
Query parameter schemas for filtering
NestJS DTO integration

Tests

Jest test suite
Mocked Drizzle database
Test cases for all CRUD operations

Manual Integration

After generation, integrate into your app module:

// app.module.ts
import { {{FeatureName}}FeatureModule } from '@your-org/server-{{feature}}';

@Module({
  imports: [
    {{FeatureName}}FeatureModule.forRootAsync({
      useFactory: () => ({
        defaultPageSize: 10,
        maxPageSize: 100,
      }),
    }),
  ],
})
export class AppModule {}

Field Options

Each field supports:

name: Field name
type: Data type (string, text, number, integer, boolean, date, uuid, email)
required: Boolean for mandatory fields
default: Default value for non-required fields
maxLength: Maximum length for strings
minLength: Minimum length for strings

Dependencies

The generated code requires:

@nestjs/common
@nestjs/core
drizzle-orm
drizzle-zod
zod
nestjs-zod

Best Practices

Verify generated code : Always review generated files before committing
Run tests : Execute unit tests to verify the generated code works
Customize as needed : Add business logic to services after generation
Database migrations : Manually create migrations for the generated schema
Type safety : Use the generated types in your application code

Constraints and Warnings

Soft delete only : The generated delete method uses soft delete (sets deletedAt). Hard deletes require manual modification
No authentication : Generated code does not include auth guards - add them separately
Basic CRUD only : Complex queries or business logic must be implemented manually
JSON field escaping : When passing fields JSON on command line, use single quotes around the JSON array

Weekly Installs

201

Repository

giuseppe-trisci…oper-kit

GitHub Stars

173

First Seen

Feb 20, 2026

Security Audits

Gen Agent Trust HubPass SocketPass SnykPass

Installed on

codex180

gemini-cli178

github-copilot175

cursor173

opencode173

kimi-cli172

Skills CLI 使用指南：AI Agent 技能包管理器安装与管理教程

31,600 周安装

NestJS Drizzle CRUD 生成器 - 自动生成类型安全的 NestJS 后端模块

🇨🇳中文介绍

NestJS Drizzle CRUD 生成器

概述

使用场景

使用说明

步骤 1：确定功能需求

步骤 2：运行生成器

步骤 3：字段定义格式

步骤 4：集成模块

相关 Skills

示例

示例 1：生成用户模块

示例 2：生成产品模块

快速开始

步骤 1：确定功能需求

步骤 2：运行生成器

步骤 3：字段定义格式

步骤 4：示例命令

生成的结构

支持的字段类型

功能特性

模块

控制器

服务

DTO

测试

手动集成

字段选项

依赖项

最佳实践

限制与警告

🇺🇸English

NestJS Drizzle CRUD Generator

Overview

When to Use

Instructions

Step 1: Identify Feature Requirements

Step 2: Run the Generator

Step 3: Field Definition Format

Step 4: Integrate Module

Examples

Example 1: Generate a User module

Example 2: Generate a Product module

Quick Start

Step 1: Identify Feature Requirements

Step 2: Run the Generator

Step 3: Field Definition Format

Step 4: Example Commands

Generated Structure

Supported Field Types

Features

Module

Controller

Service

DTOs

Tests

Manual Integration

Field Options

Dependencies

Best Practices

Constraints and Warnings

最新 Skills