-
Notifications
You must be signed in to change notification settings - Fork 353
adding scaffolding skill and test #329
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. Weβll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
46 commits
Select commit
Hold shift + click to select a range
b7315de
adding scaffolding skill and test
sayedihashimi 574eb73
Update tests/dotnet-data/scaffold-generate-aspnet/fixtures/blazor-cruβ¦
sayedihashimi 5dc017d
updating pr based on copilot feedback
sayedihashimi 309f0a5
updating pr based on copilot feedback
sayedihashimi 185ae11
Update tests/dotnet-data/scaffold-generate-aspnet/fixtures/blazor-cruβ¦
sayedihashimi 6d39c5a
Update tests/dotnet-data/scaffold-generate-aspnet/fixtures/blazor-cruβ¦
sayedihashimi 1c3c4f0
Update tests/dotnet-data/scaffold-generate-aspnet/fixtures/blazor-cruβ¦
sayedihashimi f47bcde
Update plugins/dotnet-data/skills/scaffold-generate-aspnet/SKILL.md
sayedihashimi 97eeb2a
Update tests/dotnet-data/scaffold-generate-aspnet/fixtures/minimal-apβ¦
sayedihashimi ac2a68d
Merge branch 'main' into sayedha/scaffold02
sayedihashimi 98dedb8
fixing warnings in test projects
sayedihashimi d6b4701
Merge branch 'main' into sayedha/scaffold02
sayedihashimi c69e162
Merge branch 'main' into sayedha/scaffold02
c82387b
fixing ci build issues
sayedihashimi b9fa3d5
Merge branch 'main' into sayedha/scaffold02
sayedihashimi 05998ba
fixing eval.yaml
sayedihashimi 1dba4a2
Merge branch 'main' into sayedha/scaffold02
cdc6e17
Merge branch 'main' into sayedha/scaffold02
sayedihashimi d3e6559
Merge branch 'sayedha/scaffold02' of https://github.com/sayedihashimiβ¦
sayedihashimi d567b5e
Potential fix for pull request finding
sayedihashimi 1948e29
Potential fix for pull request finding
sayedihashimi e7b1f9b
Merge branch 'main' into sayedha/scaffold02
sayedihashimi 1e6cdbe
Fix unresolved Copilot review comments on PR #329
sayedihashimi 881208c
Merge branch 'main' into sayedha/scaffold02
9472b38
Merge branch 'main' into sayedha/scaffold02
sayedihashimi a97fc50
updating code owners for scaffold-generate-aspnet
sayedihashimi 43dc366
Merge branch 'sayedha/scaffold02' of https://github.com/sayedihashimiβ¦
sayedihashimi f6c3c4e
Update tests/dotnet-data/scaffold-generate-aspnet/fixtures/blazor-cruβ¦
sayedihashimi b4372cc
Update tests/dotnet-data/scaffold-generate-aspnet/eval.yaml
sayedihashimi 1f2372e
Update tests/dotnet-data/scaffold-generate-aspnet/fixtures/blazor-cruβ¦
sayedihashimi fd9ea69
Update plugins/dotnet-data/skills/scaffold-generate-aspnet/SKILL.md
sayedihashimi fd8278e
Update tests/dotnet-data/scaffold-generate-aspnet/eval.yaml
sayedihashimi 1ee504d
Update tests/dotnet-data/scaffold-generate-aspnet/eval.yaml
sayedihashimi fd72609
Merge branch 'main' into sayedha/scaffold02
AbhitejJohn ea3df52
Merge branch 'main' into sayedha/scaffold02
webreidi 21fb4b3
Merge branch 'main' into sayedha/scaffold02
webreidi df9d719
Apply suggestion from @webreidi
webreidi 8014ceb
Apply suggestion from @webreidi
webreidi 590f441
Apply suggestion from @webreidi
webreidi 534b53e
Add Blazor CRUD application structure and initial components
webreidi 25c8eb8
Remove SKILL.md documentation for ASP.NET Core scaffolding
webreidi 58e08fb
Refactor eval.yaml to enhance scaffolding scenarios and improve gradiβ¦
webreidi 8db0216
Add scaffolding for Minimal API and MVC with existing DbContext, inclβ¦
webreidi 820c306
Merge branch 'main' into sayedha/scaffold02
webreidi 6800e15
Refine evaluation criteria for create-datadriven-aspnetcore skill by β¦
webreidi 068711e
Merge branch 'main' into sayedha/scaffold02
webreidi File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
211 changes: 211 additions & 0 deletions
211
plugins/dotnet-data/skills/create-datadriven-aspnetcore/SKILL.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,211 @@ | ||
| --- | ||
| name: create-datadriven-aspnetcore | ||
| description: Generate or scaffold ASP.NET Core code β Razor Pages, Blazor components, MVC controllers, views, and Minimal API endpoints β without using ASP.NET Core CLI scaffolding/code-generation tools. Use when (1) adding CRUD pages, views, or API endpoints backed by Entity Framework (EF Core) and a database, (2) generating code to create, read, update, and delete data using a DbContext, (3) scaffolding UI components that match the project's existing CSS framework and coding patterns, or (4) creating data-driven forms, tables, and navigation for a model class. Do not use for non-ASP.NET projects or when CLI-based scaffolding is preferred. | ||
| --- | ||
|
|
||
| # Generate or Scaffold ASP.NET Core Code | ||
|
|
||
| Generate ASP.NET Core scaffolded code β controllers, views, Razor Pages, Blazor components, Minimal API endpoints. The generated code matches the project's existing CSS framework, layout conventions, and coding patterns. No CLI-based scaffolding/code-generation tools are used; standard `dotnet` CLI commands for build, restore, and migrations are still expected. | ||
|
|
||
| ## When to Use | ||
|
|
||
| - Adding CRUD pages, views, or components for a model in an ASP.NET Core project | ||
| - Scaffolding API controllers or Minimal API endpoints with Entity Framework Core | ||
| - Generating Razor Pages, MVC views, or Blazor components backed by a DbContext | ||
|
|
||
| ## When Not to Use | ||
|
|
||
| - The project is not an ASP.NET Core project | ||
| - You need to scaffold non-web artifacts (class libraries, console apps, etc.) | ||
|
|
||
| ## Inputs | ||
|
|
||
| | Input | Required | Description | | ||
| |-------|----------|-------------| | ||
| | Scaffolding request | Yes | Natural-language description of what to scaffold (see format below) | | ||
| | Project file path | Yes | Full path to the target `.csproj` file | | ||
| | Solution root path | Recommended | Path to the solution root for multi-project solutions | | ||
|
|
||
| ### Scaffolding Request Format | ||
|
|
||
| The scaffolding request should be a natural-language description of what to scaffold. The request must include the target project path and enough detail for the agent to generate the correct code. Examples: | ||
|
|
||
| **Razor Pages with EF:** | ||
| ``` | ||
| Scaffold Razor Pages with CRUD for the `<ModelName>` model (from `<Namespace>`) in project `<path-to-csproj>`. | ||
| Create a new DbContext `<DbContextName>` using <database-provider>. | ||
| Also scaffold CRUD for any entity that `<ModelName>` depends on via required foreign keys, so parent entities can be created first. | ||
| ``` | ||
|
|
||
| **Blazor CRUD components:** | ||
| ``` | ||
| Scaffold Blazor CRUD components for the `<ModelName>` model (from `<Namespace>`) in project `<path-to-csproj>`. | ||
| Create a new DbContext `<DbContextName>` using <database-provider>. | ||
| ``` | ||
|
|
||
| **Minimal API endpoints:** | ||
| ``` | ||
| Scaffold Minimal API endpoints for the `<ModelName>` model (from `<Namespace>`) in project `<path-to-csproj>`. | ||
| Name the endpoints class `<EndpointsClassName>`. | ||
| Create a new DbContext `<DbContextName>` using <database-provider>. | ||
| Enable OpenAPI support. | ||
| ``` | ||
|
|
||
| **MVC Controller with views:** | ||
| ``` | ||
| Scaffold an MVC controller with views and Entity Framework for the `<ModelName>` model (from `<Namespace>`) in project `<path-to-csproj>`. | ||
| Name the controller `<ControllerName>`. | ||
| Use existing DbContext `<DbContextName>`. | ||
| Generate views. | ||
| ``` | ||
|
|
||
| **Empty items (no EF):** | ||
| ``` | ||
| Scaffold an empty Razor Page named `<PageName>` in project `<path-to-csproj>`. | ||
| ``` | ||
|
|
||
| ## Workflow | ||
|
|
||
| ### Step 1: Understand the Scaffolding Request | ||
|
|
||
| Parse the scaffolding request to identify: | ||
| - **Scaffolder type**: Razor Pages, Blazor components, MVC controller, Minimal API, empty page/view/component | ||
| - **Model class** and its namespace | ||
| - **DbContext**: new or existing, database provider (SQLite, SQL Server, etc.) | ||
| - **Named items**: controller name, endpoints class name, page name, view name, area name | ||
| - **Options**: OpenAPI, async actions, partial view, custom layout | ||
| - **FK scope**: whether to also scaffold CRUD for parent entities referenced by required foreign keys | ||
|
|
||
| ### Execution Checklists | ||
|
|
||
| Complete the applicable checklist in order. Do not stop after creating only the requested child resource when a required foreign key makes a parent resource necessary. | ||
|
|
||
| **All EF scaffolders** | ||
|
|
||
| 1. Inspect the project file, `Program.cs`, target model, validation attributes, navigation properties, and foreign keys before editing. | ||
| 2. Reuse the requested existing `DbContext`; otherwise create the requested context. Add only the required provider package and register it with `AddDbContext` using the requested provider and connection string. You will need to add Microsoft.EntityFrameworkCore.Design (PrivateAssets="all") when migrations are needed and it's missing. | ||
| 3. Generate complete CRUD for the requested entity and every required parent entity: list, details, create, edit, and delete. | ||
| 4. Use the EF migration lifecycle: create a migration and apply it. Never call `EnsureCreated` or seed the database in `Program.cs`. | ||
| 5. Restore, build, and test the generated project. Fix errors before reporting completion. | ||
|
|
||
| **MVC, Razor Pages, and Blazor** | ||
|
|
||
| 1. Inspect the existing layout, CSS, and representative UI before generating markup. | ||
| 2. Generate the complete child and required-parent UI flows, including a navigation path to each resource so users can create a parent before creating a child. | ||
| 3. Match the existing UI framework and conventions; preserve existing render-mode configuration for Blazor. | ||
|
|
||
| **Minimal APIs** | ||
|
|
||
| 1. Use a route group for each resource and map `GET` (list and by ID), `POST`, `PUT`, and `DELETE` endpoints for both child and required-parent resources. | ||
| 2. Add OpenAPI metadata to every endpoint: unique name, tags, description, success/error response metadata, and `WithOpenApi` when OpenAPI is enabled. | ||
| 3. Create an executable `.http` file with every CRUD request. Create parent records first, capture or clearly reuse their returned IDs in child requests, and run the requests in dependency order. | ||
|
|
||
| ### Step 2: Discover UI Style (non-API scaffolders only) | ||
|
|
||
| Skip this step for API controllers and Minimal API endpoints. | ||
|
|
||
| 1. Inspect the project's layout file (`_Layout.cshtml`, `MainLayout.razor`, or equivalent) | ||
| 2. Inspect the main CSS file (`site.css`, `app.css`, Tailwind config, etc.) | ||
| 3. Inspect 1β2 existing pages, views, or components in the project | ||
|
|
||
| All generated files MUST match the existing UI framework, CSS classes, and conventions. If Bootstrap is used, generate Bootstrap markup. If Tailwind is used, generate Tailwind markup. | ||
|
|
||
| ### Step 3: Apply Blazor-Specific Rules (Blazor scaffolders only) | ||
|
|
||
| Skip this step for non-Blazor scaffolders. | ||
|
|
||
| - `[SupplyParameterFromForm]` properties MUST use `= new()` (not `null!`) β prevents `EditForm` crash on initial GET | ||
| - `Program.cs` must chain `.AddInteractiveServerComponents()` on `AddRazorComponents()` and `.AddInteractiveServerRenderMode()` on `MapRazorComponents<App>()`. only add interactive server services/render mode when the generated components actually use @rendermode InteractiveServer (or the project already does). | ||
| - Do not replace existing chained render mode calls (e.g., `.AddInteractiveWebAssemblyRenderMode()`) | ||
|
|
||
| ### Step 4: Generate Code | ||
|
|
||
| Generate all code files manually. Follow these constraints: | ||
|
|
||
| - **DO NOT** use any scaffolding CLI tools | ||
| - **DO NOT** add packages beyond those required for the scaffolded functionality (e.g., do not add `RuntimeCompilation`, or other convenience packages) | ||
| - Match the coding style of existing files in the project (naming conventions, indentation, namespace patterns) | ||
|
|
||
| #### Enrich API Endpoints with OpenAPI Metadata (API scaffolders only) | ||
|
|
||
| When generating Minimal API or MVC API endpoints with OpenAPI support enabled, add rich metadata to every endpoint so the OpenAPI document is descriptive and useful: | ||
|
|
||
| - `.WithName("GetTodoItems")` β unique operation ID for each endpoint | ||
| - `.WithTags("TodoItems")` β group endpoints by resource | ||
| - `.WithDescription("Returns all todo items")` β human-readable summary | ||
| - `.Produces<List<TodoItem>>(StatusCodes.Status200OK)` β document success response type | ||
| - `.Produces(StatusCodes.Status404NotFound)` β document error responses | ||
| - `.ProducesValidationProblem()` β for endpoints that validate input | ||
| - `.WithOpenApi()` β opt the endpoint into OpenAPI generation (if not already globally enabled) | ||
|
|
||
| Example for a Minimal API GET endpoint: | ||
| ```csharp | ||
| group.MapGet("/", async (TodoDbContext db) => | ||
| await db.TodoItems.ToListAsync()) | ||
| .WithName("GetAllTodoItems") | ||
| .WithTags("TodoItems") | ||
| .WithDescription("Returns all todo items") | ||
| .Produces<List<TodoItem>>(StatusCodes.Status200OK); | ||
| ``` | ||
|
|
||
| ### Step 5: Set Up Entity Framework (if applicable) | ||
|
|
||
| Skip this step if the scaffolding request does not involve Entity Framework. | ||
|
|
||
| - **DO NOT** seed the database in `Program.cs` β always use migrations | ||
| - For `dotnet ef`: prefer `dotnet tool restore` from a local tool manifest. Only install globally if no manifest exists | ||
| - Inspect the model for navigation properties and foreign keys. Ensure CRUD endpoints/pages exist for referenced entities | ||
| - For API scaffolders: the `.http` file MUST create parent entities before child entities. Use FK values consistent with creation order | ||
|
|
||
| ### Step 6: Generate .http File (API scaffolders only) | ||
|
|
||
| Skip this step for non-API scaffolders. | ||
|
|
||
| 1. Create a `.http` file named `{ModelName}.http` in the project directory. If a file with that name exists, append a numeric suffix (`Product2.http`, `Product3.http`) until unique | ||
| 2. Include sample requests for every CRUD endpoint scaffolded, including endpoints for parent/dependent entities | ||
| 3. Every request must target the correct URL path matching an actual mapped endpoint | ||
| 4. Request labels must accurately describe the action (e.g., "Create a category" must POST to the categories endpoint) | ||
| 5. Order requests by dependency: create parent entities before child entities | ||
| 6. When possible, capture IDs from parent creation responses using your HTTP client's variable/templating features and reuse them as foreign key values in child-entity POST payloads | ||
| 7. If your client cannot capture response values, add comments indicating which FK IDs must be updated after running the parent creation requests; do not leave unrealistic placeholder or assumed FK values that do not correspond to actual parent records when executing the requests | ||
|
|
||
| ### Step 7: Verify | ||
|
|
||
| 1. Run `dotnet restore && dotnet build` from the project directory | ||
| 2. If Entity Framework is used and this is the first verification: | ||
| - Run `dotnet ef migrations add InitialCreate` | ||
|
webreidi marked this conversation as resolved.
|
||
| - Run `dotnet ef database update` | ||
| - You will need to change "InitialCreate" to something else if you run this more than once, as EF Core requires unique migration names. | ||
| 3. If API scaffolder: | ||
| - Inspect `Properties/launchSettings.json` β if a profile named `https` exists, use `dotnet run --launch-profile https` | ||
| - Execute EVERY `.http` request one at a time in dependency order | ||
| - Report method, URL, and status code for each request | ||
| - Stop and fix if any request returns non-2xx | ||
| 4. Fix all errors until a clean build succeeds | ||
|
|
||
| ## Validation | ||
|
|
||
| - [ ] All generated files match the project's existing CSS framework and conventions | ||
| - [ ] `dotnet build` succeeds with zero errors | ||
| - [ ] EF migrations apply cleanly (if applicable) | ||
| - [ ] All `.http` requests return 2xx status codes (if API scaffolder) | ||
| - [ ] No forbidden packages were added (`RuntimeCompilation`, etc.) | ||
| - [ ] No CLI scaffolding tools were invoked | ||
| - [ ] Blazor `[SupplyParameterFromForm]` properties use `= new()` (if Blazor scaffolder) | ||
|
|
||
| ## Common Pitfalls | ||
|
|
||
| | Pitfall | Solution | | ||
| |---------|----------| | ||
| | Generated UI doesn't match project's CSS framework | Always inspect layout and CSS files before generating code (Step 2) | | ||
| | Blazor `EditForm` crashes on initial GET | Use `= new()` not `null!` for `[SupplyParameterFromForm]` properties | | ||
| | EF migration fails due to missing parent entity CRUD | Scaffold CRUD for FK-dependent entities when request mentions foreign keys | | ||
| | `.http` file has wrong FK values | Order requests by dependency; use values consistent with creation order | | ||
| | `dotnet ef` not found | Try `dotnet tool restore` first; only install globally as fallback | | ||
| | Added unnecessary packages | Only add packages explicitly required for the scaffolded functionality | | ||
| | Generated code uses different naming conventions | Inspect existing project files to match naming patterns before generating | | ||
|
|
||
| ## References | ||
|
|
||
| - [Entity Framework Core DbContext Lifetime, Configuration, and Initialization](https://learn.microsoft.com/en-us/ef/core/dbcontext-configuration/) | ||
| - [OpenAPI overview in ASP.NET Core](https://learn.microsoft.com/en-us/aspnet/core/fundamentals/openapi/overview?view=aspnetcore-10.0) β .NET 10 specific; similar pages exist for other versions | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.