EntityFrameworkRuler 1.0.14-alpha.0.17

Prefix Reserved
This is a prerelease version of EntityFrameworkRuler.
There is a newer version of this package available.
See the version list below for details.
dotnet tool install --global EntityFrameworkRuler --version 1.0.14-alpha.0.17                
This package contains a .NET tool you can call from the shell/command line.
dotnet new tool-manifest # if you are setting up this repo
dotnet tool install --local EntityFrameworkRuler --version 1.0.14-alpha.0.17                
This package contains a .NET tool you can call from the shell/command line.
#tool dotnet:?package=EntityFrameworkRuler&version=1.0.14-alpha.0.17&prerelease                
nuke :add-package EntityFrameworkRuler --version 1.0.14-alpha.0.17                

Entity Framework Ruler

Automate the customization of the EF Core Reverse Engineered model. Supported changes include:

  • Class renaming
  • Property renaming (including both primitives and navigations)
  • Type changing (useful for enum mapping)
  • Skipping non-mapped columns.
  • Forcing inclusion of simple many-to-many entities into the model.

EF Ruler applies customizations from a rule document stored in the project folder. Rules can be fully generated from an EDMX (from old Entity Framework) such that the scaffolding output will align with the old EF6 EDMX-based model.

"EF Ruler provides a smooth upgrade path from EF6 to EF Core by ensuring that the Reverse Engineered model maps perfectly from the old EDMX structure."

Upgrading from EF6 couldn't be simpler:

  1. The the CLI tool to analyze the EDMX for all customizations and generate the rules.
  2. Discard the EDMX (optional of course).
  3. Reference EntityFrameworkRuler.Design from the EF Core project and run the ef dbcontext scaffold command.

Done.

Applying the Model Customizations:

There are two options for applying the rules to a DB context model:

  1. Simply reference EntityFrameworkRuler.Design from the EF Core project. Proceed with CLI scaffolding (as mentioned above). EntityFrameworkRuler.Design is a Design-Time reference package, meaning EF Core can use it during the scaffolding process to customize the generated model, but the assembly will NOT appear in the project build output. It can't get more automated than this.
  2. Use the CLI tool to apply changes to an already generated EF Core model. This approach uses Roslyn to apply code changes. The code analysis is reliable, but for very large models this option can take a minute.

Road Map:

  • EF Power Tools built-in support.
  • Editor library to manage the rules and edit the EF Core model structure with a UI.

This project is under development! Check back often, and leave comments here.

Product Compatible and additional computed target framework versions.
.NET net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

This package has no dependencies.

Version Downloads Last updated
1.3.48 139 9/28/2024
1.3.46 147 8/27/2024
1.3.46-alpha.0.1 45 8/27/2024
1.3.45 152 5/2/2024
1.3.44 103 5/2/2024
1.3.43 89 5/2/2024
1.3.42 77 5/2/2024
1.3.40 222 4/4/2024
1.3.9-alpha.0.1 67 4/4/2024
1.3.8 220 3/21/2024
1.3.7 162 3/21/2024
1.3.6 312 12/19/2023
1.3.5 186 11/29/2023
1.3.4 174 11/18/2023
1.2.40 277 10/26/2023
1.2.39 261 10/25/2023
1.2.38 227 10/24/2023
1.2.37 251 10/23/2023
1.2.36 362 7/17/2023
1.2.34-alpha.0.2 105 7/14/2023
1.2.33 255 7/12/2023
1.2.30 217 6/22/2023
1.2.30-alpha.0.1 86 6/21/2023
1.2.29-alpha.0.1 89 6/20/2023
1.2.28 262 6/20/2023
1.2.27 315 4/18/2023
1.2.26 393 3/23/2023
1.2.25 353 3/16/2023
1.2.22 318 3/7/2023
1.2.21 361 3/6/2023
1.2.21-alpha.0.4 106 3/6/2023
1.2.19 320 2/14/2023
1.2.19-alpha.0.4 105 2/14/2023
1.2.17 375 1/31/2023
1.2.16 369 1/27/2023
1.2.15 352 1/27/2023
1.2.14 363 1/26/2023
1.2.13 376 1/25/2023
1.2.10 353 1/25/2023
1.2.9 327 1/25/2023
1.2.8 343 1/25/2023
1.2.7 425 1/24/2023
1.2.6 390 1/24/2023
1.2.5 362 1/24/2023
1.2.4 347 1/18/2023
1.2.3 356 1/17/2023
1.2.3-alpha.0.1 145 1/9/2023
1.2.2 401 1/9/2023
1.2.1-alpha.0.2 168 1/6/2023
1.2.0 387 1/5/2023
1.1.8-alpha.0.16.4 137 1/5/2023
1.1.8-alpha.0.16.2 190 1/5/2023
1.1.8-alpha.0.16.1 196 1/5/2023
1.1.8-alpha.0.16 162 1/5/2023
1.1.8-alpha.0.15 189 1/4/2023
1.1.7 445 12/14/2022
1.1.6-alpha.0.5 119 12/14/2022
1.1.6-alpha.0.4 121 12/13/2022
1.1.6-alpha.0.2 109 12/13/2022
1.1.6-alpha.0.1 105 12/13/2022
1.1.5 408 12/9/2022
1.1.3 387 12/8/2022
1.1.3-alpha.0.2 95 12/8/2022
1.1.3-alpha.0.1 105 12/8/2022
1.1.2 359 12/8/2022
1.1.1 367 12/7/2022
1.1.0 387 12/6/2022
1.0.29-alpha.0.50 112 12/6/2022
1.0.29-alpha.0.48 113 12/6/2022
1.0.29-alpha.0.22 117 11/30/2022
1.0.28 439 11/18/2022
1.0.27 468 11/18/2022
1.0.26 423 11/18/2022
1.0.25 441 11/18/2022
1.0.22 428 11/17/2022
1.0.21 414 11/17/2022
1.0.20 374 11/16/2022
1.0.20-alpha.0.2 108 11/16/2022
1.0.20-alpha.0.1 109 11/16/2022
1.0.19 427 11/16/2022
1.0.18 419 11/16/2022
1.0.17-alpha.0.2 111 11/16/2022
1.0.17-alpha.0.1 118 11/15/2022
1.0.16 408 11/15/2022
1.0.16-alpha.0.2 104 11/15/2022
1.0.14-alpha.0.17 101 11/15/2022