{"id":1456,"date":"2024-11-20T16:23:19","date_gmt":"2024-11-20T16:23:19","guid":{"rendered":"https:\/\/rssfeedtelegrambot.bnaya.co.il\/index.php\/2024\/11\/20\/dotnet-scaffold-next-generation-project-creation-for-net\/"},"modified":"2024-11-20T16:23:19","modified_gmt":"2024-11-20T16:23:19","slug":"dotnet-scaffold-next-generation-project-creation-for-net","status":"publish","type":"post","link":"https:\/\/rssfeedtelegrambot.bnaya.co.il\/index.php\/2024\/11\/20\/dotnet-scaffold-next-generation-project-creation-for-net\/","title":{"rendered":"dotnet scaffold \u2013 Next Generation Project Creation for .NET"},"content":{"rendered":"

Scaffolding in Visual Studio for ASP.NET Core projects has been a long-standing
\nfeature which was added shortly after ASP.NET Core was
\nreleased. We have also had support for scaffolding from the command line
\nfor many years. From that command line experience, we have heard
\nfeedback from many users that we need an interactive CLI experience for
\nscaffolding. To that goal, we have been working on a new interactive<\/strong>
\nCLI tool, dotnet scaffold. This CLI tool has now been released as a
\npreview. In this post we will describe how you can acquire and use this
\nnew command line tool. This tool is open source, you can view the code
\nin the scaffolding repo<\/a>. That
\nrepository contains the code for the dotnet scaffold tool as well as
\nother scaffolding related code.<\/p>\n

Installing dotnet scaffold<\/h2>\n

To install this tool we will use the dotnet tool command. Execute the
\ncommand below to get the latest released version installed.<\/p>\n

dotnet tool install –global Microsoft.dotnet-scaffold<\/p>\n

To install a specific version, visit the package on
\nnuget.org<\/a>.
\nTo install a specific version, visit the package on
\nnuget.org<\/a>.
\nFor more info on how to manage dotnet tools see the docs at .NET
\ntools \u2013 .NET CLI | Microsoft
\nLearn<\/a>.
\nIn the command above we are installing the tool globally, but you can
\nalso install tools local to a folder. The .NET tools docs has more info
\non both of those approaches.
\ntools \u2013 .NET CLI | Microsoft
\nLearn](https:\/\/learn.microsoft.com\/dotnet\/core\/tools\/global-tools).
\nIn the command above we are installing the tool globally, but you can
\nalso install tools local to a folder. The .NET tools docs has more info
\non both of those approaches.<\/p>\n

Using dotnet scaffold<\/h2>\n

By default, dotnet scaffold is an interactive tool, meaning that you
\ninvoke it, and it will prompt you for info as needed. For automation,
\nyou can pass in all the parameter values, but we will discuss that in a
\nfuture post. Before running dotnet scaffold, make sure to change
\ndirectories (cd) to a folder where a .NET Core project exists. dotnet
\nscaffold has support for the following ASP.NET Core project types.<\/p>\n

Web app
\nWeb API
\n.NET Aspire
\nBlazor<\/p>\n

In this post we will focus on the Web app option to show you around
\ndotnet scaffold, but all the scaffolders follow the same patterns and
\nprompts.<\/p>\n

I created a new ASP.NET Core 9 web app using dotnet new with the command
\ndotnet new webapp -o MyWebApp. Then I used cd<\/strong> to change into that
\ndirectory. When you run dotnet scaffold, you\u2019ll be prompted to select
\nthe scaffolding category. See the screenshot below.<\/p>\n\n

In the image above dotnet scaffold shows a list of the scaffolding
\ncategories that are currently supported. To navigate this menu, you will
\nuse the up and down arrow keys on your keyboard to select the desired
\ncategory. In the future as we add more scaffolders more categories may
\nappear. Here you\u2019ll select the category of what you are wanting to
\ngenerate into your project. For example, let\u2019s explore the Razor Pages
\noption. To select a category, navigate to it and type Return. That will
\ntake you into the selected option. If you select an incorrect option,
\nyou can always use Back under Navigation to go back to the previous
\nselection. After entering the Razor Pages option, you will see the
\nfollowing options.<\/p>\n\n

Now dotnet scaffold is prompting for the specific scaffolder which
\nshould be invoked. In this case we see two options, the first option is
\nto create a new empty Razor Page. The second option will generate Razor
\nPages based on a model class that is a part of the project. Values will
\nbe persisted using Entity Framework into the selected database provider.
\nLet\u2019s first run through the Empty scaffolder and then the CRUD one. The
\nempty scaffolder will generate a new Razor page with an associated code
\nfile. This is equivalent to running dotnet new page. The generated files
\nwill not have any customizations.<\/p>\n

When you have the option Razor Page \u2013 Empty<\/strong>, selected hit the Return
\nkey to go into that option. After that you\u2019ll be prompted to select the
\ntarget project.<\/p>\n\n

In this case we only have one, so we will select MyWebApp and hit the
\nReturn key. Then it will prompt for the name of the Razor Page to
\ncreate. Give it the name About and hit the Return key. You\u2019ll see the
\ncommand working and then you should see the result below.<\/p>\n\n

After this has completed you should see the files About.cshtml and
\nAbout.cshtml.cs in the current working directory. When running this
\nscaffold, it will use the current directory as the output location. Now
\nlet\u2019s move on to see how the Razor Page EF option behaves.<\/p>\n

Before invoking the EF scaffolders you need a model class for it to
\nscaffold content for. I\u2019ve created a new web app with the same command
\nas before, dotnet new webapp -o MyWebApp and I\u2019ve added the following
\nclass in the root of the project.<\/p>\n

namespace MyWebApp;<\/p>\n

public class Contact
\n{
\n public int Id { get; set; }<\/p>\n

public string? Firstname { get; set; }<\/p>\n

public string? Lastname { get; set; }<\/p>\n

public string? Email { get; set; }
\n}<\/p>\n

This is a very basic model class that can be used with Entity Framework.
\nNow we are ready to invoke dotnet scaffold. After starting it, select
\nthe Razor Pages category and then the Razor Pages with Entity
\nFramework (CRUD)<\/strong> option. It will prompt you to select the project,
\nsince there is only one project in this case you can hit Return because
\nit\u2019s already selected. Next dotnet scaffold will prompt you to select
\nthe model class as shown below.<\/p>\n\n

Select Contact and hit the Return key to proceed. The next screen will
\nprompt you for the name of the database context. For this example, give
\nit the name ContactDbContext and hit the Return key. It\u2019s recommended
\nfor this value to end with DbContext based on convention, but that is
\nnot required. See the following image.<\/p>\n\n

After you hit the Return key, you will be prompted to select the
\ndatabase provider.<\/p>\n\n

The following list summarizes the options on that screen.<\/p>\n

npgsql-efcore = PostgreSQL
\nsqlserver-efcore = SQL Server
\nsqlite-efcore = SQLite
\ncosmos-efcore = Cosmos DB<\/p>\n

To keep things simple, we will select the sqlite-efcore option. SQLite
\nis a file based database and doesn\u2019t have any external dependencies.
\nSelect that option and hit Return. You\u2019ll be prompted to select what
\noperations should be scaffolded. See the next image.<\/p>\n\n

You can select an individual item to be created, or you can select the
\nCRUD option to scaffold the full set of pages. Select the CRUD option.
\nNext, you\u2019ll be prompted if you want to include prerelease packages.
\nSince we are working with .NET 9 preview, select Yes for that option and
\nhit Return. After that the scaffolding operation will start. You\u2019ll see
\na spinner showing that it is running, and it will emit messages for the
\noperations that are taking place. When it is complete you should see a
\nresult similar to the following screenshot.<\/p>\n\n

After performing this operation, the following changes will have been
\napplied to the project.<\/p>\n

The project file has package references added for Entity Framework
\nProgram.cs has been updated to initialize the database connection
\nappsettings.json has been updated with connection information
\nContactDbContext.cs has been created and added to the project root
\ndirectory
\nRazor Pages for CRUD operations has been added to the Pages folder<\/p>\n

The content has been generated but the database has not yet been
\ninitialized. To prep the database, we need to create a migration and
\nthen update the database. Do that with the following commands.<\/p>\n

dotnet ef migrations add initialMigration<\/p>\n

This will add a new migration named initialMigration. You can give
\nit whatever name you prefer here.<\/p>\n

dotnet ef database update<\/p>\n

This will apply the migrations to the database<\/p>\n

After running those commands, you should be ready to run the app with
\nthe dotnet run<\/strong> command. After the app starts the URL will be shown
\nin the terminal, open that URL in your browser with \/ContactPages at the
\nend of the URL. You should see something like the following.<\/p>\n\n

Using this page you can create new contacts and manage existing ones as
\nwell. After you add some contacts they will appear on this page as shown
\nbelow.<\/p>\n\n

Now you have an ASP.NET Core Razor Pages web app which can manage a
\ncontact list. After scaffolding you will likely want to customize the
\ngenerated content to suit your needs. You can use dotnet scaffold to
\nscaffold other content as you develop your app.<\/p>\n

Recap<\/h2>\n

In this post we have used dotnet scaffold to add Razor Pages to a new
\nASP.NET Core .NET 9 web app. Keep an eye on this blog for more
\ninformation on changes to dotnet scaffold. We are hoping that you will
\ntry out this new command line tool and provide us some feedback so that
\nwe can improve this going forward. In particular, we are very interested in
\nfeedback on the interactivity of this command line tool.
\nThe following section has info on how you can provide feedback.<\/p>\n

Feedback<\/h2>\n

You can share feedback with us by filing an issue in the Scaffolding
\nrepo<\/a>. You can also send feedback
\nvia the Developer
\nCommunity<\/a>: report any
\nbugs or issues via report a
\nproblem<\/a>
\nand share your suggestions for new
\nfeatures<\/a>
\nor improvements to existing ones. Let us know what you think in the comment below.<\/p>\n

The post dotnet scaffold \u2013 Next Generation Project Creation for .NET<\/a> appeared first on .NET Blog<\/a>.<\/p>","protected":false},"excerpt":{"rendered":"

Scaffolding in Visual Studio for ASP.NET Core projects has been a long-standing feature which was added shortly after ASP.NET Core […]<\/p>\n","protected":false},"author":0,"featured_media":0,"comment_status":"","ping_status":"","sticky":false,"template":"","format":"standard","meta":{"site-sidebar-layout":"default","site-content-layout":"","ast-site-content-layout":"default","site-content-style":"default","site-sidebar-style":"default","ast-global-header-display":"","ast-banner-title-visibility":"","ast-main-header-display":"","ast-hfb-above-header-display":"","ast-hfb-below-header-display":"","ast-hfb-mobile-header-display":"","site-post-title":"","ast-breadcrumbs-content":"","ast-featured-img":"","footer-sml-layout":"","ast-disable-related-posts":"","theme-transparent-header-meta":"","adv-header-id-meta":"","stick-header-meta":"","header-above-stick-meta":"","header-main-stick-meta":"","header-below-stick-meta":"","astra-migrate-meta-layouts":"default","ast-page-background-enabled":"default","ast-page-background-meta":{"desktop":{"background-color":"var(--ast-global-color-4)","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""},"tablet":{"background-color":"","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""},"mobile":{"background-color":"","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""}},"ast-content-background-meta":{"desktop":{"background-color":"var(--ast-global-color-5)","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""},"tablet":{"background-color":"var(--ast-global-color-5)","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""},"mobile":{"background-color":"var(--ast-global-color-5)","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""}},"footnotes":""},"categories":[7],"tags":[],"class_list":["post-1456","post","type-post","status-publish","format-standard","hentry","category-dotnet"],"_links":{"self":[{"href":"https:\/\/rssfeedtelegrambot.bnaya.co.il\/index.php\/wp-json\/wp\/v2\/posts\/1456","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/rssfeedtelegrambot.bnaya.co.il\/index.php\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/rssfeedtelegrambot.bnaya.co.il\/index.php\/wp-json\/wp\/v2\/types\/post"}],"replies":[{"embeddable":true,"href":"https:\/\/rssfeedtelegrambot.bnaya.co.il\/index.php\/wp-json\/wp\/v2\/comments?post=1456"}],"version-history":[{"count":0,"href":"https:\/\/rssfeedtelegrambot.bnaya.co.il\/index.php\/wp-json\/wp\/v2\/posts\/1456\/revisions"}],"wp:attachment":[{"href":"https:\/\/rssfeedtelegrambot.bnaya.co.il\/index.php\/wp-json\/wp\/v2\/media?parent=1456"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/rssfeedtelegrambot.bnaya.co.il\/index.php\/wp-json\/wp\/v2\/categories?post=1456"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/rssfeedtelegrambot.bnaya.co.il\/index.php\/wp-json\/wp\/v2\/tags?post=1456"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}