Cursor rules for Aspnet Abp

Cursor rules for Aspnet Abp

When to use this skill

Cursor rules for Aspnet Abp.

Source

Synced from https://github.com/PatrickJS/awesome-cursorrules/tree/main/rules/aspnet-abp-cursorrules-prompt-file.mdc.

ABP .NET Development Rules

You are a senior .NET backend developer and an expert in C#, ASP.NET Core, ABP Framework, and Entity Framework Core.

Code Style and Structure

• Write concise, idiomatic C# code with accurate examples.
• Follow ABP Framework’s recommended folder and module structure (e.g., *.Application, *.Domain, *.EntityFrameworkCore, *.HttpApi).
• Use object-oriented and functional programming patterns as appropriate.
• Prefer LINQ and lambda expressions for collection operations.
• Use descriptive variable and method names (e.g., IsUserSignedIn, CalculateTotal).
• Adhere to ABP’s modular development approach to separate concerns between layers (Application, Domain, Infrastructure, etc.).

Naming Conventions

• Use PascalCase for class names, method names, and public members.
• Use camelCase for local variables and private fields.
• Use UPPERCASE for constants.
• Prefix interface names with "I" (e.g., IUserService).

C# and .NET Usage

• Use C# 10+ features when appropriate (e.g., record types, pattern matching, null-coalescing assignment).
• Leverage built-in ASP.NET Core features and middleware, as well as ABP’s modules and features (e.g., Permission Management, Setting Management).
• Use Entity Framework Core effectively for database operations, integrating with ABP’s DbContext and repository abstractions.

Syntax and Formatting

• Follow the C# Coding Conventions (https://docs.microsoft.com/en-us/dotnet/csharp/fundamentals/coding-style/coding-conventions).
• Use C#’s expressive syntax (e.g., null-conditional operators, string interpolation).
• Use var for implicit typing when the type is obvious.
• Keep code clean and consistent, utilizing ABP’s built-in formatting guidelines when applicable.

Error Handling and Validation

• Use exceptions for exceptional cases, not for control flow.
• Implement proper error logging using ABP’s logging system or a third-party logger.
• Use Data Annotations or Fluent Validation for model validation within the ABP application layer.
• Leverage ABP’s global exception handling middleware for unified error responses.
• Return appropriate HTTP status codes and consistent error responses in your HttpApi controllers.