Initial commit

This commit is contained in:
Zhongwei Li
2025-11-30 08:18:45 +08:00
commit 07ecb03cf0
8 changed files with 288 additions and 0 deletions

View File

@@ -0,0 +1,52 @@
---
name: generating-orm-code
description: |
This skill enables Claude to generate ORM models and database schemas. It is triggered when the user requests the creation of ORM models, database schemas, or wishes to generate code for interacting with databases. The skill supports various ORMs including TypeORM, Prisma, Sequelize, SQLAlchemy, Django ORM, Entity Framework, and Hibernate. Use this skill when the user mentions terms like "ORM model", "database schema", "generate entities", "create migrations", or specifies a particular ORM framework like "TypeORM entities" or "SQLAlchemy models". It facilitates both database-to-code and code-to-database schema generation.
allowed-tools: Read, Write, Edit, Grep, Glob, Bash
version: 1.0.0
---
## Overview
This skill empowers Claude to automate the creation of Object-Relational Mapping (ORM) models and database schemas, significantly accelerating backend development. It handles generating code for various ORM frameworks, simplifying database interactions.
## How It Works
1. **Identify ORM and Language**: The skill parses the user's request to determine the target ORM framework (e.g., TypeORM, SQLAlchemy) and programming language (e.g., TypeScript, Python).
2. **Schema/Model Definition**: Based on the request, the skill either interprets an existing database schema or defines a new schema based on provided model specifications.
3. **Code Generation**: The skill generates the corresponding ORM model code, including entities, relationships, and any necessary configuration files, tailored to the chosen ORM framework.
## When to Use This Skill
This skill activates when you need to:
- Create ORM models from a database schema.
- Generate a database schema from existing ORM models.
- Generate model code for a specific ORM framework (e.g., TypeORM, Prisma).
## Examples
### Example 1: Generating TypeORM entities
User request: "Generate TypeORM entities for a blog with users, posts, and comments, including relationships and validation rules."
The skill will:
1. Generate TypeScript code defining TypeORM entities for `User`, `Post`, and `Comment`, including properties, relationships (e.g., one-to-many), and validation decorators.
2. Output the generated code, ready to be integrated into a TypeORM project.
### Example 2: Creating a SQLAlchemy schema
User request: "Create a SQLAlchemy schema for an e-commerce application with products, categories, and orders."
The skill will:
1. Generate Python code defining SQLAlchemy models for `Product`, `Category`, and `Order`, including relationships (e.g., many-to-one), data types, and primary/foreign key constraints.
2. Output the generated code, ready to be used with SQLAlchemy.
## Best Practices
- **Specificity**: Be as specific as possible about the desired ORM framework and data model.
- **Relationships**: Clearly define relationships between entities (e.g., one-to-many, many-to-many).
- **Validation**: Specify validation rules to ensure data integrity.
## Integration
This skill integrates with other code generation tools and plugins within Claude Code, allowing for seamless integration into existing projects and workflows. It can be used in conjunction with database migration tools to create and manage database schemas.

View File

@@ -0,0 +1,13 @@
# Assets
Bundled resources for orm-code-generator skill
- [ ] templates/typeorm_entity.ts.template: Template for generating TypeORM entity files.
- [ ] templates/prisma_schema.prisma.template: Template for generating Prisma schema files.
- [ ] templates/sequelize_model.js.template: Template for generating Sequelize model files.
- [ ] templates/sqlalchemy_model.py.template: Template for generating SQLAlchemy model files.
- [ ] templates/django_model.py.template: Template for generating Django model files.
- [ ] templates/entity_framework_entity.cs.template: Template for generating Entity Framework entity files.
- [ ] templates/hibernate_entity.java.template: Template for generating Hibernate entity files.
- [ ] examples/ecommerce_database_schema.sql: Example SQL schema for an e-commerce database.
- [ ] examples/blog_typeorm_model.ts: Example TypeORM model for a blog application.

View File

@@ -0,0 +1,14 @@
# References
Bundled resources for orm-code-generator skill
- [ ] orm_best_practices.md: A comprehensive guide to ORM best practices, including security considerations, performance optimization, and code maintainability.
- [ ] typeorm_api_reference.md: Detailed API reference for TypeORM, including code examples and usage guidelines.
- [ ] prisma_api_reference.md: Detailed API reference for Prisma, including code examples and usage guidelines.
- [ ] sequelize_api_reference.md: Detailed API reference for Sequelize, including code examples and usage guidelines.
- [ ] sqlalchemy_api_reference.md: Detailed API reference for SQLAlchemy, including code examples and usage guidelines.
- [ ] django_orm_api_reference.md: Detailed API reference for Django ORM, including code examples and usage guidelines.
- [ ] entity_framework_api_reference.md: Detailed API reference for Entity Framework, including code examples and usage guidelines.
- [ ] hibernate_api_reference.md: Detailed API reference for Hibernate, including code examples and usage guidelines.
- [ ] database_schema_examples.md: Examples of database schemas for various use cases (e.g., e-commerce, social media, blog).
- [ ] orm_model_examples.md: Examples of ORM model definitions for various ORMs and use cases.

View File

@@ -0,0 +1,8 @@
# Scripts
Bundled resources for orm-code-generator skill
- [ ] generate_model.py: Generates ORM model code based on a database schema or user-defined model definition.
- [ ] generate_schema.py: Generates database schema based on an ORM model definition.
- [ ] validate_model.py: Validates the ORM model definition against best practices and common pitfalls.
- [ ] migration_generator.py: Generates migration files for different ORMs based on model changes.