MCAkbayir.XFramework.Generator.Tool 1.0.5

MCAkbayir.XFramework.Generator.Tool

CLI tool for automatic code generation in XFramework projects. Scaffolds a full CRUD stack from a single entity — DTOs, Mapper, Validators, Service, Controller, and DbSet — with one command.

🚀 Installation

dotnet tool install --global MCAkbayir.XFramework.Generator.Tool

📖 Usage

Run from your project directory (where the *.sln file is located):

# Generate all components for an entity
xgen Product

# Skip specific components
xgen Product --skip Mapper
xgen Product --skip Mapper,Validator

# Run via dotnet
dotnet xgen Order --skip Controller,DbSet

Available --skip values

Dto, Mapper, Validator, Service, Controller, DbSet

⚙️ Generated Components

🔍 How It Works

1. Builds DAL — Automatically runs dotnet build on your DAL project
2. Loads entity via reflection — Reads properties from the compiled assembly
3. Filters audit fields — Excludes CreatedAt, CreatedBy, UpdatedAt, UpdatedBy, IsActive, DeletedBy, DeletedAt, Revision from DTOs
4. Generates code — Creates all selected component files in their correct locations

⚠️ Important Notes

• Validators are only generated for AddDto & UpdateDto — The base EntityDto does not get a validator since it's used for read operations.
• Revision property is added back to UpdateDto — Even though it's an audit field, it's included in UpdateDto for concurrency control.
• Id is excluded from AddDto & UpdateDto — Only the base EntityDto contains the Id property.
• Navigation properties and collections are excluded — Only value types, strings, and Guids are included in DTOs.
• //Generated entities comment is required — The DbSet generator looks for this comment in your DbContext to know where to insert. If missing, you'll need to add the DbSet manually.
• DAL must build successfully — The tool runs dotnet build on your DAL project before generation. If it fails, no code will be generated.

📋 Requirements

• A *.sln file in the project root
• Standard XFramework project structure: DAL, BLL, API, and Dtos projects
• A //Generated entities comment in your DbContext for automatic DbSet insertion

📄 License

MIT