{"id":16293564,"url":"https://github.com/badsyntax/vscode-entity-framework","last_synced_at":"2025-03-20T03:31:09.850Z","repository":{"id":65068644,"uuid":"581573616","full_name":"badsyntax/vscode-entity-framework","owner":"badsyntax","description":"Manage Entity Framework migrations in VS Code.","archived":false,"fork":false,"pushed_at":"2025-03-17T12:09:27.000Z","size":1246,"stargazers_count":13,"open_issues_count":6,"forks_count":2,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-03-17T14:22:10.529Z","etag":null,"topics":["dotnet","entity","entity-framework","migrations"],"latest_commit_sha":null,"homepage":"https://marketplace.visualstudio.com/items?itemName=richardwillis.vscode-entity-framework","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/badsyntax.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-12-23T15:37:39.000Z","updated_at":"2025-02-24T10:54:25.000Z","dependencies_parsed_at":"2024-10-27T21:44:37.062Z","dependency_job_id":"3dc6529e-d89a-4a63-80e9-f16e1adcf8a7","html_url":"https://github.com/badsyntax/vscode-entity-framework","commit_stats":null,"previous_names":[],"tags_count":20,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/badsyntax%2Fvscode-entity-framework","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/badsyntax%2Fvscode-entity-framework/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/badsyntax%2Fvscode-entity-framework/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/badsyntax%2Fvscode-entity-framework/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/badsyntax","download_url":"https://codeload.github.com/badsyntax/vscode-entity-framework/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244543786,"owners_count":20469562,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["dotnet","entity","entity-framework","migrations"],"created_at":"2024-10-10T20:11:44.559Z","updated_at":"2025-03-20T03:31:09.526Z","avatar_url":"https://github.com/badsyntax.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Entity Framework\n\n[![Build \u0026 Publish](https://github.com/badsyntax/vscode-entity-framework/actions/workflows/main.yml/badge.svg)](https://github.com/badsyntax/vscode-entity-framework/actions/workflows/main.yml)\n\nA VS Code extension to manage Entity Framework migrations.\n\n\u003cimg src=\"./images/treeview-screenshot.png\" width=\"460\" alt=\"Entity Framework Migrations\" /\u003e\n\n## Requirements\n\n- [dotnet sdk](https://dotnet.microsoft.com/download)\n- [efcore tools](https://learn.microsoft.com/en-us/ef/core/cli/dotnet)\n- [Microsoft.EntityFrameworkCore.Design](https://www.nuget.org/packages/Microsoft.EntityFrameworkCore.Design) must be installed in one of the projects\n\n## Features\n\n- List migrations by [`DbContext`](https://learn.microsoft.com/en-us/dotnet/api/microsoft.entityframeworkcore.dbcontext)\n- Add / Remove / Run / Undo migrations\n- Show migration applied status\n- Reset (Squash) Migrations\n- Export `DbContext` as SQL script\n- View `DbContext` information\n- [Scaffold](https://learn.microsoft.com/en-us/ef/core/cli/dotnet#dotnet-ef-dbcontext-scaffold) `DbContext` \u0026 entity types\n- Generate ER Diagram (Requires EF Core 7+)\n\n## Getting Started\n\nSet the `project` and `startupProject` configuration for the workspace by clicking on the `Configure` icon in the tree view:\n\n\u003cimg src=\"./images/configure.png\" width=\"460\" alt=\"Entity Framework Extension Configure\" /\u003e\n\n## Extension Settings\n\nThis extension contributes the following settings:\n\n- `entityframework.project`: [Target Project](https://learn.microsoft.com/en-us/ef/core/cli/dotnet#target-project-and-startup-project)\n  \u003cdetails\u003e\u003csummary\u003eExample\u003c/summary\u003e\n\n  ```json\n  {\n    \"entityframework.project\": \"src/Infrastructure\"\n  }\n  ```\n\n- `entityframework.startupProject`: [Startup Project](https://learn.microsoft.com/en-us/ef/core/cli/dotnet#target-project-and-startup-project)\n  \u003cdetails\u003e\u003csummary\u003eExample\u003c/summary\u003e\n\n  ```json\n  {\n    \"entityframework.startupProject\": \"ExampleAPI\"\n  }\n  ```\n\n- `entityframework.commands`: Custom commands\n  \u003cdetails\u003e\u003csummary\u003eExample\u003c/summary\u003e\n\n  ```json\n  {\n    \"entityframework.commands\": {\n      \"addMigration\": [\n        \"dotnet\",\n        \"ef\",\n        \"migrations\",\n        \"add\",\n        \"\\\"$migrationName\\\"\",\n        \"--project\",\n        \"\\\"$project\\\"\",\n        \"--startup-project\",\n        \"\\\"$startupProject\\\"\",\n        \"--context\",\n        \"\\\"$dbContext\\\"\"\n      ],\n      \"removeMigration\": [\n        \"dotnet\",\n        \"ef\",\n        \"migrations\",\n        \"remove\",\n        \"--project\",\n        \"\\\"$project\\\"\",\n        \"--startup-project\",\n        \"\\\"$startupProject\\\"\",\n        \"--context\",\n        \"\\\"$dbContext\\\"\"\n      ],\n      \"runMigration\": [\n        \"dotnet\",\n        \"ef\",\n        \"database\",\n        \"update\",\n        \"--project\",\n        \"\\\"$project\\\"\",\n        \"--startup-project\",\n        \"\\\"$startupProject\\\"\",\n        \"--context\",\n        \"\\\"$dbContext\\\"\",\n        \"\\\"$migrationId\\\"\"\n      ],\n      \"generateScript\": [\n        \"dotnet\",\n        \"ef\",\n        \"dbcontext\",\n        \"script\",\n        \"--project\",\n        \"\\\"$project\\\"\",\n        \"--startup-project\",\n        \"\\\"$startupProject\\\"\",\n        \"--context\",\n        \"\\\"$dbContext\\\"\"\n      ],\n      \"listDbContexts\": [\n        \"dotnet\",\n        \"ef\",\n        \"dbcontext\",\n        \"list\",\n        \"--project\",\n        \"\\\"$project\\\"\",\n        \"--startup-project\",\n        \"\\\"$startupProject\\\"\"\n      ],\n      \"listMigrations\": [\n        \"dotnet\",\n        \"ef\",\n        \"migrations\",\n        \"list\",\n        \"--context\",\n        \"\\\"$context\\\"\",\n        \"--project\",\n        \"\\\"$project\\\"\",\n        \"--startup-project\",\n        \"\\\"$startupProject\\\"\"\n      ],\n      \"dbContextInfo\": [\n        \"dotnet\",\n        \"ef\",\n        \"dbcontext\",\n        \"info\",\n        \"--context\",\n        \"\\\"$dbContext\\\"\",\n        \"--project\",\n        \"\\\"$project\\\"\",\n        \"--startup-project\",\n        \"\\\"$startupProject\\\"\"\n      ],\n      \"scaffold\": [\n        \"dotnet\",\n        \"ef\",\n        \"dbcontext\",\n        \"scaffold\",\n        \"\\\"$connectionString\\\"\",\n        \"\\\"$provider\\\"\",\n        \"--output-dir\",\n        \"\\\"$outputDir\\\"\",\n        \"--context\",\n        \"\\\"$context\\\"\",\n        \"--project\",\n        \"\\\"$project\\\"\",\n        \"--context-dir\",\n        \"\\\"$contextDir\\\"\",\n        \"--namespace\",\n        \"\\\"$namespace\\\"\"\n      ],\n      \"generateERD\": [\n        \"dotnet\",\n        \"ef\",\n        \"dbcontext\",\n        \"scaffold\",\n        \"\\\"$connectionString\\\"\",\n        \"\\\"$provider\\\"\",\n        \"--context\",\n        \"\\\"$context\\\"\",\n        \"--project\",\n        \"\\\"$project\\\"\",\n        \"--output-dir\",\n        \"\\\"$outputDir\\\"\",\n        \"--use-database-names\"\n      ]\n    }\n  }\n  ```\n\n  \u003c/details\u003e\n\n- `entityframework.erDiagram.ignoreTables`: A list of tables to ignore from the ER Diagram\n  \u003cdetails\u003e\u003csummary\u003eExample\u003c/summary\u003e\n\n  ```json\n  {\n    \"entityframework.erDiagram\": {\n      \"ignoreTables\": [\".*Tracking$\"]\n    }\n  }\n  ```\n\n- `entityframework.env`: Custom environment variables\n  \u003cdetails\u003e\u003csummary\u003eExample\u003c/summary\u003e\n\n  ```json\n  {\n    \"entityframework.env\": {\n      \"ASPNETCORE_ENVIRONMENT\": \"LocalDev\",\n      \"TenantId\": \"12345\"\n    }\n  }\n  ```\n\n  \u003c/details\u003e\n\n### ER Diagram\n\nWhen generating an ER diagram, a [`Mermaid`](https://mermaid.js.org/syntax/entityRelationshipDiagram.html) [`.t4`](https://learn.microsoft.com/en-us/ef/core/managing-schemas/scaffolding/templates) template will be installed into the project. You can ignore this file (by adding it to `.gitignore`), or add it to source control. The template file is used to generate the ER Diagram, feel free to customise it. If you delete it, it will be regenerated next time you generate an ER Diagram.\n\n\u003cimg src=\"./images/er-diagram.png\" alt=\"Entity Framework ER Diagram\" /\u003e\n\n## Performance\n\nThe EF tools execute application code at design time to get information about the project, thus _performance on large projects can be slow_.\n\n## Support\n\n- 👉 [Submit a bug report](https://github.com/badsyntax/vscode-entity-framework/issues/new?assignees=badsyntax\u0026labels=bug\u0026template=bug_report.md\u0026title=)\n- 👉 [Submit a feature request](https://github.com/badsyntax/vscode-entity-framework/issues/new?assignees=badsyntax\u0026labels=enhancement\u0026template=feature_request.md\u0026title=)\n\n## License\n\nSee [LICENSE.md](./LICENSE.md).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbadsyntax%2Fvscode-entity-framework","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbadsyntax%2Fvscode-entity-framework","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbadsyntax%2Fvscode-entity-framework/lists"}