.Net Foundation Code Conversations, 29 Aug 2017

Previous Meeting

Next Meeting

⏯

youtube image

►

From YouTube: Sayed Hashimi on Open Source .NET Core Project Templates

Description

Sayed I. Hashimi overviews the new templating system for .NET Core 2.0.

A

Hi, welcome to code conversations today we're talking to sayed ibrahim hashimi.. What are you going to show us to today? hey, jon. today, we'll talk.

B

About opensource templates for net.

B

And, you know,. I've been working in the opensource spacefor templates for several years now.

B

Here, sunlight kind of big efforts: so, you know,, we created sidewaffle back in august, two thousand thirteen, and that was a way.

B

To create templates and share templates with people inside visual studio, you know,.

B

...Dot net core popped up and then we said hey. We really need an experience.

B

...Platform experience for you are creating these projects.

B

...Did there was basically there's a there's, a very popular yeomantool and that's like the scaffold...for, the web...

B

Is what they call it and ...twenty fourteen was...kind of when we started that effort and, you know,.

B

That's got a hundred eighteen thousand download and you know,.

B

These they've been pretty successful. These things?.

B

But, you know, it aspnetcore, really kind of change the world for example,.... I work on the.

B

...Team and ...shipping templates for these different tools and editors, so,.

B

For example, we've got visual studio. Twenty seventeen v-s for mac we've got.

B

Dotnet new and then we have a aspnet which is...yeoman.

B

Generator and each one of these has their own, like template, format...create a template in a certain way.

B

...You'll...Template and lycos very specific way.

A

And, now keeping them in sync across all of the...exactly, and let me tell you what,, you.

B

Know, I mean the creating a template for visual studio and maintaining that template.

B

Is incredibly difficult, like you wouldn't as.

B

Even...Sidewaffle, it's still like very error-prone so,.

B

You know,, we heard feedback, saying hey. I want to be able to create templates across these different.

B

Projects- and we also heard a lot of feedback- saying it's too difficult to create templates and.

B

...Difficult to maintain templates maintain maintenance is the real problem so, that we took a step back and we said: hey you.

B

Know, we want, we want to create a tool, that's going to enable us to create templates for.

B

These different tools and then also make it easier to create these templates so,.

B

Comes and now the template engine, which is an open source project that.

B

We're working on what we've been working on it for probably about a year actually and.

B

The idea is that you create a single template and then...nuget package and then you'll be able.

B

To leverage that, from dotnet new, from visual studio from visual studio for mac.

B

Also yo aspnet and then you can add as many arrows as you need here. These are really just.

B

...Starting point and right now: we've plugged in the template engine and.

B

To dotnet new and my team's working on plugging into visual studio and.

B

Then hopefully, at some point will then get the integration for v-s for mac and community members working.

B

On...Of the house as well, ok, so what I want to do today was.

B

Basically, show you how to create a template and then how to use dotnet.

B

New and how to exercise your template and then, depending on how much time way, I will see how much.

B

That we can go to basically sounds great...cool?.

B

Right so dull, so now let's go into using dotnet new.

B

...Clear everything out and...we, don't have anything in this folder now to start exploring.

B

Dotnet new: we can use the dash each option here and that all good and give.

B

...Some help and you can see, we've got a list option here and then today, actually.

B

Spits of the template list, but later on, we'll change...not spit out the template.

B

List by default, okay, so I can ask for the list: of...but it doesn't, yeah,,.

B

Exactly to ask for the less you'll say: non enu daschle...you'll see the template list. Okay and.

B

...We also have template specific help. So if I want to look at the nbc.

B

Template I can do dotnet new nbc dash, h.

B

And then here now I can get into the template specific parameter here. So I can see it's got.

B

An authentication option...default, none.

B

At the use-local-db option, which defaults to false so-you sql.

B

Lite and cross-platform, by default here and also framework option here.

B

I'm going to do is going create a console app and I'm going to.

B

...Building, on top of that one?

B

and,, that's dotnet, new console.

B

and,, then for the output. I want the output to go into a folder called c nine. The demo.

B

And,, if you...output name, that's also the project name, which is basically the name.

B

Of your project, and...to, look at the contents of this program: dot cs?.

B

We can see that wmi namespace has been change to see nine. The demo here.

B

I can restore and run this.

B

...Helloworld, let's take a look.

B

So, that's...restore...that are hello world here and now I'm going to open this guy up.

B

In the visual studio code, so this is that same folder that I.

B

Had opened up now, I'm just going to create a template out of this, creating a template.

B

Is pretty simple and d'amato and the model that we have is your template.

B

...Be runnable, so the crux of the crux of the.

B

Problem, maintaining templates is the fact that you take an existing.

B

Serve code and then you modified to become your template. You turn...a template...yeah,.

A

Exactly why not really the same...have two things to...so,.

B

Basically, the idea behind the template engine is your source. Is a template.

B

...So, instead of going...and, normally what I would do.

B

...Creating, a template, I'd go in and out change this namespace to some type of...dollar sign.

B

...Dollar sign rootnamespace or whatever it is right, but instead we kind of.

B

Flip that around we said hey instead of modifying your sewers, you just add a file. You tell us.

B

What needs to be replace, okay and then we'll process it. So that's the that's...here.

B

So I'm going to add a new folder...as. We called that template dot, config.

B

And, then, I'm going to add a file into that is called template. Dot, json.

B

And, then, I'm going to open up my other window, here.

B

That has the actual content and then we'll what do this?.

B

Right so pace...my...from, the existing from an existing template that I have but, is.

B

...Created for this most of the fields are pretty self-explanatory.

B

So leave them as they are there's two items I want to talk about here. The...

B

This is the name that users are going to use from the commandline, so we saw dotnet new nbc. That's a.

B

...For, something that's longer,, you know,, we have an identity field, okay and then the sourcename. Here's, the important parts of c.

B

...Demo, what that means: is...the name of my project and if there's a file that has.

B

That name, that file name will get replace with the user's project name and the.

B

Namespace,...And, all...and wherever...this particular string shows up. It will get.

B

Were placed okay, so,, that's how I had to do so now, I'm going to go into dotnet...

B

Enable this template and then we're going to exercise...template...to copy the path to this file.

B

And, then we change...folders as well.

B

Thanks so...my folder...nine I'll show that there's nothing here.

B

Okay, so,, the syntax, is the new dash, install folder path and.

B

In the current release, we have a bug...and with slash...that slash.

B

Okay, so, uninstall it ...the template list. I can see I've got my c nine starter web and the.

B

...Nine starter web comes very from here from the name. Ok, so now.

A

...The full...and.

B

Now...Really...That's, the human friendly name...the identity...

B

So, dotnet new, see nine web and ...I'll say the output should be a dac. Nine demo.

B

Kept program, dot cs still same steps. Let me go to and I'll make a change to the file.

B

Let's say the program: dot cs the helloworld.

B

From john and sayed.

B

Go back and...make into another folder here.

B

...Program dot csnotice, I didn't even have to make that call for dotnet new. I didn't.

A

Have any...you only need to call install if that metadata file changes? Otherwise it's.

B

Very it's always looking at the folder and every indication for non enu will get that folder. Basically.

A

Now, I'm...there's a similar command for a new for to install a nuget packages. Well,.

B

...So, that is, that how then you just created that template that.

A

You're using locally out of a folder, if you want to publish that you publish.

A

Set by creating a nuget package, that...the triangular published that.

B

...A nuget package and, at the end of the talk I'll show you that we have several community members.

B

Who already created these nuget packages and their sharing them on nuget.

B

...That they have instruction try to use it with dotnet new...yeah,.

B

Exactly that's the idea...

B

so, now. What I want to do is we've just created a consul.

B

Invocation, if I trade back and forth and...half-way between the.

B

Error rate, so now what I wanted is we've created a consul application at a unit.

B

Test this okay: let's see what that experience! My look like so, many switch back to my a.

B

B

Right so...go into the c nine demo...we have here: okay,.

B

...Right, so we go up on folder, I'm going to create a new test project.

B

Ok and that's dotnet new x unit and I'll say the output should be seen.

B

...Demo dot test.

B

...We have now we have to gnu projects here.

B

...Demo about...so now I'm going to do is earlier.

B

...Create, this template configfile...a template dot, json file.

B

With visual studio...creating, a single project, template is one thing and then creating a multi project.

A

...Different rights and nightmare: it's like orders of magnitude, more difficult, so,.

B

I'm going to do is take this template configfile and move it up. One level.

B

...Can't do that from there actually yeah,. You go right.

B

...This actuation copy it and then...here.

B

And, delete this...

B

right, so I just moved up a level basically right. So now I'm going to do is I made.

B

A call to dotnet new...

B

...Go back and I'm going to make that call again, but now I'm just going to go up.

B

One folder alleges moved away. I just move that that's...the whole instantly, right, yeah.

B

So, now I'm going to go back to my channel nine folder.

B

...Remove everything back to cleandirectory here then we make that same.

B

...Call that I made before.

B

for dotnet new see nine web.

A

Narrates, so you just created a multi projects, template exactly.

A

Way and like seconds...I haven't actually...together but,.

B

You know,, assuming that you have yet a project reference. Obviously all that...of work and.

B

...You know,, what I mean: okay so,. We made creating templates very simple whether it's.

B

A single project, template or multi project template and you know,. These template.

B

...Also be creating solution files, ...have sharp template, that's available for creating solution files and, you know,.

B

What I showed you guys...really just like be the one: the one-minute demo right,.

B

You know,...is really scratching the surface here, but there's really a lot.

B

Of basically time savers in this template, engine,, you know,.

B

Like...Are replacements, happen...a particular way: that, you know,.

B

The namespace can only contains certain characters and the name of the class can only.

B

Contains certain characters tool make those changes and the appropriate ways.

B

...Right and then users, don't really have to think about okay and then ...other aspect,, you know,.

B

This template engine is not limited to dot net core or even.

B

Dotnet necessarily, you can create any type of...with. The.

B

Template engine...text and...shows, where to go to find out more about this, yeah, of course?.

B

So,, the main place is dotnet. It's on ...github dot, com slash...slash...and, you know,.

B

I told you before that we had some available templates that have been created by the communitywe're.

B

Tracking that list here and wiki here under available.

B

...Templates think there's about twelve or thirteen, maybe even more now I.

B

Dunno, if you've heard about the...nbc...a graham mohammed but,,.

B

He was one of the one of the first community, guys that we reached out to cause he's, got.

B

A very popular existing visual studio extension right, so, he's actually.

B

Created he's created that, like before it was always a visual studio installer, and this now makes.

A

It available on any platform. That's right! That's right! While...As, pretty.

B

...And I've got some additional resources here for folks as well.

B

...Check have any additional content here and great will make sure to get these from.

A

...As well, yeah, rain thanks. I appreciate that all right, okay! Well thanks a bunch...and moi.