Scaffolding: Enable text templates #27565

bricelam · 2022-03-04T03:58:00Z

This enables users to add T4 templates to their project which will be picked up by dotnet ef dbcontext scaffold to generate the DbContext and entity type classes.

It will look for templates in the following location. Note that the extension .t4 is used instead of the usual .tt so that Visual Studio doesn't try to transform them.

(Target project directory)
- CodeTemplates/ (updated in Scaffolding: Use "CodeTemplates" directory #27626)
  - EFCore/
    - DbContext.t4
    - EntityType.t4

Note, I haven't actually written any templates yet--that'll be my next PR. If anyone's eager to start playing with this, the templates would look something like the this: (you'll definitely need to add a few import directives)

<#@ template hostSpecific="true" #>
<#@ parameter name="NamespaceHint" type="System.String" #>
<#@ parameter name="Model" type="Microsoft.EntityFrameworkCore.Metadata.IModel" #>
<#@ parameter name="Options" type="Microsoft.EntityFrameworkCore.Scaffolding.ModelCodeGenerationOptions" #>
<#
    var services = (IServiceProvider)Host;
    var providerCode = services.GetRequiredService<IProviderConfigurationCodeGenerator>();
    var annotationCode = services.GetRequiredService<IAnnotationCodeGenerator>();
    var code = services.GetRequiredService<ICSharpHelper>();
#>
using Microsoft.EntityFrameworkCore;

namespace <#= NamespaceHint #>;

public partial class <#= Options.ContextName #> : DbContext
{
    <# foreach (var entityType in Model.GetEntityTypes()) { #>
    public virtual DbSet<<#= entityType.Name #>> <#= entityType["Scaffolding:DbSetName"] #> { get; set; }
    <# } #>

    protected override void OnConfiguring(DbContextOptionsBuilder options)
        => options<#= code.Fragment(providerCode.GenerateUseProvider(options.ConnectionString)) #>;

    protected override void OnModelCreating(ModelBuilder modelBuilder)
    {
        // TODO
    }
}

Part of #4038

To Do

Use T4 templates when present in the project (this PR)
Port the existing generators to T4. These will serve as the base templates that users can copy and tweak
Find a way to distribute the base templates. Either via dotnet new or using a new command in dotnet ef

ErikEJ · 2022-03-04T07:23:17Z

@bricelam Fantastic!

I plan to add this to Power Tools, so it can drop the files.

A user request I have had in connection with the handlebars templates is the ability supply your own set of "templates", I have enabled this by looking for a .zip file with templates in the project root.

Maybe the to level folder could be called "CodeTemplates" iso "Templates" ?

ErikEJ · 2022-03-04T07:26:16Z

src/EFCore.Design/Scaffolding/Internal/TextTemplatingModelGenerator.cs

+ }
+
+ public override bool HasTemplates(string projectDir)
+ => File.Exists(Path.Combine(projectDir, "Templates", "EFCore", "DbContext.t4"));


Maybe use "CodeTemplates" as base folder name?

Maybe. That’s what it used to be in EF6. I want to run this design by the MVC scaffolding team too and see if they have any future plans. I hinted at this on dotnet/Scaffolding#606 (comment)

@ErikEJ Do you have any additional reasons for preferring CodeTemplates? (Other than that's what EF6 used.)

It is used by the Handlebars templates. But that is most likely also an EF6 carry over.

Most likely not important. Assume you would never use both and Handlebars could do a breaking change.

src/EFCore.Design/Scaffolding/Internal/TextTemplatingModelGenerator.cs

bricelam · 2022-03-04T23:09:35Z

So, I had a crazy idea to generate an ER diagram using mermaid. Here's my template:

<#@ output extension=".md" #>
<#@ assembly name="Microsoft.EntityFrameworkCore" #>
<#@ assembly name="Microsoft.EntityFrameworkCore.Relational" #>
<#@ import namespace="System.Linq" #>
<#@ import namespace="Microsoft.EntityFrameworkCore" #>
<#@ import namespace="Microsoft.EntityFrameworkCore.Infrastructure" #>
<#@ import namespace="Microsoft.EntityFrameworkCore.Metadata" #>
<#@ parameter name="Model" type="Microsoft.EntityFrameworkCore.Metadata.IModel" #>
# <#= Model["Scaffolding:DatabaseName"] #>

```mermaid
erDiagram
<#
    foreach (var entityType in Model.GetEntityTypes().Where(t => t.GetViewName() == null && !t.GetForeignKeys().Any(fk => fk.GetReferencingSkipNavigations().Any())))
    {
#>
    <#= entityType.Name.ToUpper() #> {
<#
        foreach (var property in entityType.GetProperties().Where(p => !p.IsForeignKey()))
        {
            var type = property.GetColumnType();
            var lengthStart = type.IndexOf("(");
            if (lengthStart != -1)
                type = type.Substring(0, lengthStart);
#>
        <#= type #> <#= property.Name #>
<#
        }
#>
    }
<#
        foreach (var foreignKey in entityType.GetForeignKeys())
        {
#>
    <#= entityType.Name.ToUpper() #> <#= foreignKey.IsUnique ? "|" : "}" #>o--<#= foreignKey.IsRequired ? "|" : "o" #>| <#= foreignKey.PrincipalEntityType.Name.ToUpper() #> : <#= foreignKey.DependentToPrincipal.Name #>
<#
        }

        foreach (var skipNavigation in entityType.GetSkipNavigations().Where(n => n.JoinEntityType.FindPrimaryKey().Properties[0].GetContainingForeignKeys().First().PrincipalEntityType == entityType))
        {
#>
    <#= entityType.Name.ToUpper() #> }o--o{ <#= skipNavigation.TargetEntityType.Name.ToUpper() #> : <#= skipNavigation.Name #>
<#
        }
    }
#>

And here's what it generates when I point it at Northwind:

Northwind

erDiagram
    CATEGORY {
        int CategoryId
        nvarchar CategoryName
        ntext Description
        image Picture
    }
    CUSTOMER {
        nchar CustomerId
        nvarchar Address
        nvarchar City
        nvarchar CompanyName
        nvarchar ContactName
        nvarchar ContactTitle
        nvarchar Country
        nvarchar Fax
        nvarchar Phone
        nvarchar PostalCode
        nvarchar Region
    }
    CUSTOMER }o--o{ CUSTOMERDEMOGRAPHIC : CustomerTypes
    CUSTOMERDEMOGRAPHIC {
        nchar CustomerTypeId
        ntext CustomerDesc
    }
    EMPLOYEE {
        int EmployeeId
        nvarchar Address
        datetime BirthDate
        nvarchar City
        nvarchar Country
        nvarchar Extension
        nvarchar FirstName
        datetime HireDate
        nvarchar HomePhone
        nvarchar LastName
        ntext Notes
        image Photo
        nvarchar PhotoPath
        nvarchar PostalCode
        nvarchar Region
        nvarchar Title
        nvarchar TitleOfCourtesy
    }
    EMPLOYEE }o--o| EMPLOYEE : ReportsToNavigation
    EMPLOYEE }o--o{ TERRITORY : Territories
    ORDER {
        int OrderId
        money Freight
        datetime OrderDate
        datetime RequiredDate
        nvarchar ShipAddress
        nvarchar ShipCity
        nvarchar ShipCountry
        nvarchar ShipName
        nvarchar ShipPostalCode
        nvarchar ShipRegion
        datetime ShippedDate
    }
    ORDER }o--o| CUSTOMER : Customer
    ORDER }o--o| EMPLOYEE : Employee
    ORDER }o--o| SHIPPER : ShipViaNavigation
    ORDERDETAIL {
        real Discount
        smallint Quantity
        money UnitPrice
    }
    ORDERDETAIL }o--|| ORDER : Order
    ORDERDETAIL }o--|| PRODUCT : Product
    PRODUCT {
        int ProductId
        bit Discontinued
        nvarchar ProductName
        nvarchar QuantityPerUnit
        smallint ReorderLevel
        money UnitPrice
        smallint UnitsInStock
        smallint UnitsOnOrder
    }
    PRODUCT }o--o| CATEGORY : Category
    PRODUCT }o--o| SUPPLIER : Supplier
    REGION {
        int RegionId
        nchar RegionDescription
    }
    SHIPPER {
        int ShipperId
        nvarchar CompanyName
        nvarchar Phone
    }
    SUPPLIER {
        int SupplierId
        nvarchar Address
        nvarchar City
        nvarchar CompanyName
        nvarchar ContactName
        nvarchar ContactTitle
        nvarchar Country
        nvarchar Fax
        ntext HomePage
        nvarchar Phone
        nvarchar PostalCode
        nvarchar Region
    }
    TERRITORY {
        nvarchar TerritoryId
        nchar TerritoryDescription
    }
    TERRITORY }o--|| REGION : Region

test/EFCore.Design.Tests/Scaffolding/Internal/ModelCodeGeneratorTestBase.cs

src/EFCore.Design/Scaffolding/Internal/TextTemplatingModelGenerator.cs

src/EFCore.Design/EFCore.Design.csproj

bricelam · 2022-03-08T03:42:43Z

Tests pass locally on Linux. Not sure why they're timing out on CI...

NuGet.config

test/EFCore.Relational.Specification.Tests/TestUtilities/BuildReference.cs

AndriySvyryd · 2022-03-09T00:45:36Z

src/EFCore.Design/Scaffolding/Internal/TextTemplatingModelGenerator.cs

+ {
+ foreach (var entityType in model.GetEntityTypes())
+ {
+ // TODO: Should this be handled inside the template?


Part of dotnet#4038

ghost · 2022-03-09T03:25:21Z

Hello @bricelam!

Because this pull request has the auto-merge label, I will be glad to assist with helping to merge this pull request once all check-in policies pass.

p.s. you can customize the way I help with merging this pull request, such as holding this pull request until a specific person approves. Simply @mention me (`@msftbot`) and give me an instruction to get started! Learn more here.

ghost · 2022-03-09T03:37:32Z

Apologies, while this PR appears ready to be merged, I've been configured to only merge when all checks have explicitly passed. The following integrations have not reported any progress on their checks and are blocking auto-merge:

Azure Pipelines

These integrations are possibly never going to report a check, and unblocking auto-merge likely requires a human being to update my configuration to exempt these integrations from requiring a passing check.

Give feedback on this

From the bot dev team

We've tried to tune the bot such that it posts a comment like this only when auto-merge is blocked for exceptional, non-intuitive reasons. When the bot's auto-merge capability is properly configured, auto-merge should operate as you would intuitively expect and you should not see any spurious comments.

Please reach out to us at fabricbotservices@microsoft.com to provide feedback if you believe you're seeing this comment appear spuriously. Please note that we usually are unable to update your bot configuration on your team's behalf, but we're happy to help you identify your bot admin.

src/EFCore.Design/TextTemplating/Internal/TextTemplatingService.cs

smitpatel · 2022-03-17T19:30:26Z

src/EFCore.Design/TextTemplating/Internal/TextTemplatingService.cs

+/// any release. You should only use it directly in your code with extreme caution and knowing that
+/// doing so can result in application failures when updating to a new Entity Framework Core release.
+/// </summary>
+public class TextTemplatingService : ITextTemplating, ITextTemplatingEngineHost, IServiceProvider


The concrete class name seems somewhat inconsistent with the interface name

Uh this was merged but I do agree, some refinements are needed here.

Just because something has been merged doesn't mean it can't be changed...

We sure we want to spend our API naming vouchers on internal code?

As long as ITextTemplating interface which is public has right name, I am fine whatever the internal concrete type ends up being.

The fact that something is Internal doesn't mean it should be of lower quality. We don't review these names because we can change them at any point, not because we don't care

I take great care in my craft--that's why I chose the names I did. But I'm always happy to hear higher-quality name suggestions.

The concrete class name looks good to me, we'll discuss the interface names in API review.

Agreed. I’ve been thinking of ways we can improve improve things, and I think splitting the class may help. I’ll take a note to discuss it in API review.

P.S. I apologize for my previous comments. They seem out of character and a bit guarded or defensive to me today. I’ll strive for more openness in the future.

AraHaan · 2022-03-20T13:24:16Z

src/EFCore.Design/Scaffolding/Internal/TextTemplatingModelGenerator.cs

+ _host.Session = _host.CreateSession();
+ try
+ {
+ _host.Session.Add("EntityType", entityType);


Add option to inject Code into EntityType templates?

Use the new, more extensible pattern:

<#@ template hostSpecific="true" #> <# var serviceProvider = (IServiceProvider)Host; var code = serviceProvider.GetService<ICSharpHelper>();

bricelam requested a review from a team March 4, 2022 03:58

ErikEJ reviewed Mar 4, 2022

View reviewed changes

src/EFCore.Design/Scaffolding/Internal/TextTemplatingModelGenerator.cs Outdated Show resolved Hide resolved

ajcvickers reviewed Mar 7, 2022

View reviewed changes

test/EFCore.Design.Tests/Scaffolding/Internal/ModelCodeGeneratorTestBase.cs Show resolved Hide resolved

ajcvickers reviewed Mar 7, 2022

View reviewed changes

src/EFCore.Design/Scaffolding/Internal/TextTemplatingModelGenerator.cs Outdated Show resolved Hide resolved

ajcvickers reviewed Mar 7, 2022

View reviewed changes

src/EFCore.Design/EFCore.Design.csproj Show resolved Hide resolved

ajcvickers approved these changes Mar 7, 2022

View reviewed changes

bricelam force-pushed the t4 branch from 0fefe35 to aa1c989 Compare March 8, 2022 03:39

bricelam commented Mar 8, 2022

View reviewed changes

NuGet.config Outdated Show resolved Hide resolved

bricelam force-pushed the t4 branch 2 times, most recently from 81009ae to ba85b6d Compare March 8, 2022 21:55

bricelam commented Mar 8, 2022

View reviewed changes

test/EFCore.Relational.Specification.Tests/TestUtilities/BuildReference.cs Show resolved Hide resolved

AndriySvyryd reviewed Mar 9, 2022

View reviewed changes

Scaffolding: Enable text templates

1dd5484

Part of dotnet#4038

bricelam force-pushed the t4 branch from 911270b to 1dd5484 Compare March 9, 2022 03:22

bricelam added the auto-merge label Mar 9, 2022

ghost merged commit ac143e6 into dotnet:main Mar 9, 2022

bricelam deleted the t4 branch March 9, 2022 15:29

smitpatel reviewed Mar 17, 2022

View reviewed changes

src/EFCore.Design/TextTemplating/Internal/TextTemplatingService.cs Show resolved Hide resolved

smitpatel reviewed Mar 17, 2022

View reviewed changes

ajcvickers mentioned this pull request Mar 17, 2022

.NET Data Biweekly Updates (2022) #27185

Closed

AraHaan reviewed Mar 20, 2022

View reviewed changes

bricelam mentioned this pull request Mar 21, 2022

T4 and EF Core Reverse Engineering bricelam/bricelam.github.io#38

Closed

This pull request was closed.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Scaffolding: Enable text templates #27565

Scaffolding: Enable text templates #27565

bricelam commented Mar 4, 2022 •

edited

Loading

ErikEJ commented Mar 4, 2022

ErikEJ Mar 4, 2022 •

edited

Loading

bricelam Mar 4, 2022 •

edited

Loading

bricelam Mar 7, 2022

ErikEJ Mar 8, 2022

ErikEJ Mar 8, 2022

bricelam commented Mar 4, 2022

bricelam commented Mar 8, 2022

AndriySvyryd Mar 9, 2022

ghost commented Mar 9, 2022

ghost commented Mar 9, 2022

From the bot dev team

smitpatel Mar 17, 2022

AraHaan Mar 17, 2022 •

edited

Loading

ajcvickers Mar 17, 2022

bricelam Mar 17, 2022

smitpatel Mar 17, 2022

AndriySvyryd Mar 17, 2022

bricelam Mar 18, 2022

AndriySvyryd Mar 18, 2022

bricelam Mar 19, 2022

AraHaan Mar 20, 2022 •

edited

Loading

bricelam Mar 21, 2022

Scaffolding: Enable text templates #27565

Scaffolding: Enable text templates #27565

Conversation

bricelam commented Mar 4, 2022 • edited Loading

To Do

ErikEJ commented Mar 4, 2022

ErikEJ Mar 4, 2022 • edited Loading

Choose a reason for hiding this comment

bricelam Mar 4, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bricelam commented Mar 4, 2022

Northwind

bricelam commented Mar 8, 2022

Choose a reason for hiding this comment

ghost commented Mar 9, 2022

p.s. you can customize the way I help with merging this pull request, such as holding this pull request until a specific person approves. Simply @mention me (@msftbot) and give me an instruction to get started! Learn more here.

ghost commented Mar 9, 2022

From the bot dev team

Choose a reason for hiding this comment

AraHaan Mar 17, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

AraHaan Mar 20, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bricelam commented Mar 4, 2022 •

edited

Loading

ErikEJ Mar 4, 2022 •

edited

Loading

bricelam Mar 4, 2022 •

edited

Loading

p.s. you can customize the way I help with merging this pull request, such as holding this pull request until a specific person approves. Simply @mention me (`@msftbot`) and give me an instruction to get started! Learn more here.

AraHaan Mar 17, 2022 •

edited

Loading

AraHaan Mar 20, 2022 •

edited

Loading