DN.WebApi Source Code Generator

[trihugger]

I had started writing this for BH, but since I've been focusing on this and it makes it far more streamlined anyway, I've ported it to DN.Webapi.

The idea is having a source code generator that we can customize to our needs to quickly launch a new feature and get a large amount of the code scaffolded for us.

The project is now 90% there, and I wanted to know if you had any interest in adding into the repository. If yes, we might want to put it in a different trunk while we get it to a test or rc quality.

Here's a quick overview of how it works:

1. Create a Data Model in the Domain\Entities folder.
2. Add the properties following the conventions used in your project.
3. Run the SourceCodeGenerator project, which will list all available data models in the entities namespace.
4. Based on preset templates and customizable functions it will then generate all source code necessary to add the feature. This includes:
   4.1 Adding the constructor and update method to the data model file
   4.2 Adding the permissions to the permissions.cs file
   4.3 Create the dtos and supporting files, List Filter, Create/Update Request, and Create/Update validators, etc.
   4.4 Create the interface and implementation for the service class.
   4.5 Create Controller
   4.6 Update localization
   4.7 Add table definition to the Application Db Context

The project is a WPF app with a window that allows to select the data model from a list and then follows a workflow to generate the templates.

Added options to generate all files or pick one by one, and to backup all files or select which to backup as you go.

The project is structured into two folders the CodeGeneratorEngine and the files templates.

The Code Generation Engine is devided into to an EngineFunctions class, a static class of reusable methods to support the creation of the files, and the Code Generator Engine responsable to all the data model operations within the template file.

The template folder has a generic blank template to create new templates as future needs arise, and a template to all the files it currently generates. Its composed of a constructor where all the template settings are made, a code generation method where the file structure is define, and a sample method to generate code that might require special logic and used only in that template.

Engine Functions class include a properties generator with parameters to meet most common cases, as well as in line properties method for cases like method functions or request pass-through. It also contains the functions used to append code to an existing file that does the validation if it exists and to override/replace or ignore.

I'm in the process of finalizing the testing and refactoring some of the functions for easy development.

What I would like to know is if you are interested in adding it to the project (Please don't feel that you have to say yes after all you might need to help support this :) ), and if so if you would like to push to main or on a separate trunk. As for timing I should have it all finalized this weekend and fully tested by next weekend.

Let me know if you are any questions, thoughts, suggestions, or concerns and what your preference is.

Thank you,
Jeff

[iammukeshm]

Sounds Interesting. Could you attach some screenshots of the application? Wondering is there is a way to make it a CLI tool or a VS extension? If no, we can still proceed with WPF. We can probably add it under the repository/code-generator folder.

Since we are doing all the scaffolding part, is it also possible to add migrations for the newly added entity automatically? I think it should be possible. Let me know.

Cool work by the way. Be ready to write in some documentation at fullstackhero.net for this :p

Thanks

[trihugger]

Here's some screenshots. although they are pretty simple.

It is all basically one window just to provide some feedback, and here's is were you start (selecting the data model):

As you can see there is no Tenant, Brand, or Product, there is a simple exclusion list for models you don't want to overitten. In this case I choose to create 3 using a CRM example.

Here's were you get the feedback and the how I interact with the user, during data model properties loading, and during source code generation:

You can see here its asking if you want to generate all the code, or select which template to generate.

Migrations: funny you would mention that, because and I think here you are talking about the AddMigration and update-database, I think so, i might need your help or have to do some research on how do it, but I was even thinking also along the lines of if you want to migrate data from another application database to your project, of course that would be a lot more thinking but I do have a business use case that I might be able to at least see how possible and if there are any barriers to do that.

As for the question regarding being a CLI or VS extension, i'm pretty certain it can be a CLI, just thinking about what is involved, because we would just need, like Add-Migration, to point it at the model, so instead of having a screen that shows all the models it would just be a reference to the data model we want to generate, the rest is just interacting from the cli for feedback and questions, rather than the screen. I have not built a cli before but I'm sure we can figure it out if you want to go that route.

As for a VS Extension, never built one, but I would think it would be able to identity the project, I think we would have to create "Browse to file" to select the data model, instead of having it able to just "fetch it". Never built one but I am up to learning it :D

Let me know your thoughts and if you would like to look at the code first, which I'm pretty sure you would be a great help to make it more CA, as I'm not sure I trust my skill.

Thank you,

Jeff

[trihugger]

Update:

Added the ability to migrate, doesn't seems like it was that hard to figure out actually.

What I did was I added a separate button so you can migrate at any time, but included it at the end of the "generate" workflow to ask, you may not if you still need to make any adjustments, like adding other models.

I do have two questions:

1. We can use PowerShell or CommandLine, and I was wondering if you have a preference, also noting that some companies block/control PowerShell commands. (mine I feel I get the whole company calling me lol) and if that would be a consideration here.

2. Can you give me your recommended commands for adding migration and updating database? I know using the VS PowerShell console you don't have to give a lot of parameters, which in code we would have to specify the main project and migration project aside from the context.

Thank you,

Jeff

[trihugger]

@iammukeshm created a project to you can go over the code.

Source Code Generator

[Lokman-Simsek]

Thank you for such a work. I was planning to make such an application when I learned the structure of the project by examining the articles on Mukesh's blog. We had been working for four years to migrate our projects to the web. But we haven't been able to create the infrastructure we want yet. Mukesh showed me a new way out. I feel very lucky to have found him. Thank you for everything Mukesh.

You can add a section within the Master/Detail tables in your project. When tables and link fields are selected, you can create related files. This will be very helpful for novices like me.

I wish you success.

[trihugger]

Same here, I was actually using another boilerplate and it was so complicated and I think it was making the application "heavy" I could see slowness at points as we were testing it, and that is when I stopped and try looking for something better, which led me to Mukesh's project.

I'm trying to understand you suggestion, could you explain it a little more? It could just me not understanding based on the terminology, when you say master/detail tables are you referring to table relationships?

Thank you for your feedback.

[Lokman-Simsek]

The topic I want to talk about is table relations.

For example, it can be a structure such as Invoice headers (date, invoice number, customer) and invoice detail lines (price and quantity information of products). I suggested you add creating project files by selecting these two models or tables and the relation column between them.

I'm sorry for my bad english. I hope I was able to explain.

[trihugger]

No apologies for language please, bilingual here too :D (English/Portuguese).

I thought that's what it was, just wanted to make sure, and I would like to explain how it works now, because I believe it already does what you are asking.

Invoice.cs:

public class Invoice
{
    public DateTime InvoiceDate {get; set;}
    public string InvoiceNumber {get; set;}
    public Customer Customer {get; set;}
    public List<InvoiceDetail> InvoiceDetails {get; set;}
}

Basically you want to make sure it builds out the code for Invoice, Customer, and then the InvoiceDetails relationship. right?

Currently it does this by recognizing they are part of your project's data model, not like native or net types e.g DateTime, string, etc, and will create the necessary entries in Service, Controller, and others to reflect that.

Currently I have it as a todo to ask if you want to generate the customer and Invoice Details, which does not now, for simplicity sake. I want to make sure it works before adding that into the workflow, but is it my intent and I don't see it as having any issues doing this out-of-box.

Let me know if I'm on the right path.

Thank you,

Jeff

[Lokman-Simsek]

Hi Jeff

Yeah. This is the structure I want to describe. When we prepare the Invoice.cs file like this, CRUD operations and other project files are prepared in accordance with this model. Users will be able to easily create files with either a single module or master/detail modules.

Thus, it will be very easy for us to add a new section or feature to our current project.

Thanks again for everything and good luck.

[trihugger]

Awesome thank you 👍

[gfo2007]

hi @trihugger,
any update on the scaffolding tool?

Regards.

[Yoshuwa]

Hi @trihugger @iammukeshm
any update on the code generator?
thanking you in advance