Add control library templates #1005

jmarolf · 2019-06-18T21:50:54Z

jmarolf · 2019-06-19T17:39:25Z

@cartermp do we want to add new templates for WPF for 3.0 at this point? Who was the team member from XAML that asked for this?

cartermp · 2019-06-19T17:43:36Z

Yes. Control library templates are essential to getting to experience parity with desktop WPF. @vatsan-madhavan this work is critical to landing the full WPF experience, as there are customers who will need access to this library type for .NET Core.

cartermp · 2019-06-19T17:44:30Z

Or rather, people aren't technically blocked because they could:

Create a .NET Core 3.0 library project
Add the correct designators to their project file
Add user controls

But this is not the norm for WPF users and certainly wouldn't be the expected experience.

jmarolf · 2019-06-19T17:45:09Z

@cartermp can you port dotnet/project-system#4715 to this repo as per their guidelines?

cartermp · 2019-06-19T18:32:06Z

I don't have permissions to move the issue. Is copy/paste sufficient?

stevenbrix · 2019-06-20T18:49:53Z

@cartemp, copy/paste should be good, thank you!

Do these templates have the same expectation of user experience when opened in VS/Blend that is being discussed in #1007?

jmarolf · 2019-06-20T23:55:56Z

Moved the bug over here: #1036

This is about having the WPF experience being at parity between .NET Framework and .NET Core

vatsan-madhavan · 2019-06-21T04:47:03Z

Were you able to validate that the resultant nuget packages for project tempaltes - both in its structure, and functionally within VS & Blend?

vatsan-madhavan · 2019-06-21T04:59:39Z

Are these xcopy'd from .NET framework templates?

....Dotnet.Wpf.ProjectTemplates/content/WpfControlLibrary-CSharp/.template.config/template.json

vatsan-madhavan · 2019-06-21T05:23:13Z

Consider naming the paths WpfUserControLibrary-CSharp rather than WpfControlLibrary-CSharp etc.

vatsan-madhavan · 2019-06-27T00:01:03Z

Removing NO MERGE since #1100 is completed and master has switched to Preview 8. This PR can continue on with usual due-diligence.

vatsan-madhavan

If this is something the VS team would like to target for Preview8, we'd like to take this earlier rather than later in the milestone. Working through the changes in the next 1-2 weeks would be ideal.

cartermp · 2019-07-01T18:07:32Z

We definitely want this for Preview 8. Is there anything we can do to help?

vatsan-madhavan · 2019-07-11T21:00:26Z

@jmarolf do you have an idea when you expect to have an update addressing feedback?

/cc @chabiss

jmarolf · 2019-07-16T17:46:08Z

@vatsan-madhavan ready for review

vatsan-madhavan · 2019-07-17T22:40:49Z

After installing the generated project template package (dotnet new -i Microsoft.DotNet.Wpf.ProjectTemplates::3.0.0-dev --nuget-source C:\src\repos\wpf\artifacts\packages\Debug\Shipping) , I see this, which is mostly good.

Note that WPF user control is missing VB.

`> dotnet new `
Usage: new [options]

Options:
  -h, --help          Displays help for this command.
  -l, --list          Lists templates containing the specified name. If no name is specified, lists all templates.
  -n, --name          The name for the output being created. If no name is specified, the name of the current directory is used.
  -o, --output        Location to place the generated output.
  -i, --install       Installs a source or a template pack.
  -u, --uninstall     Uninstalls a source or a template pack.
  --nuget-source      Specifies a NuGet source to use during install.
  --type              Filters templates based on available types. Predefined values are "project", "item" or "other".
  --dry-run           Displays a summary of what would happen if the given command line were run if it would result in a template creation.
  --force             Forces content to be generated even if it would change existing files.
  -lang, --language   Filters templates based on language and specifies the language of the template to create.
  --update-check      Check the currently installed template packs for updates.
  --update-apply      Check the currently installed template packs for update, and install the updates.


Templates                                         Short Name               Language          Tags                                 
----------------------------------------------------------------------------------------------------------------------------------
Console Application                               console                  [C#], F#, VB      Common/Console                       
Class library                                     classlib                 [C#], F#, VB      Common/Library                       
WPF Application                                   wpf                      [C#], VB          Common/WPF                           
WPF Custom Control Library                        wpfcustomcontrollib      [C#], VB          Common/WPF                           
WPF User Control Library                          wpfcontrollib            [C#]              Common/WPF                           
Windows Forms (WinForms) Application              winforms                 [C#], VB          Common/WinForms                      
Worker Service                                    worker                   [C#]              Common/Worker/Web                    
Unit Test Project                                 mstest                   [C#], F#, VB      Test/MSTest                          
NUnit 3 Test Project                              nunit                    [C#], F#, VB      Test/NUnit                           
NUnit 3 Test Item                                 nunit-test               [C#], F#, VB      Test/NUnit                           
xUnit Test Project                                xunit                    [C#], F#, VB      Test/xUnit                           
Razor Component                                   razorcomponent           [C#]              Web/ASP.NET                          
Razor Page                                        page                     [C#]              Web/ASP.NET                          
MVC ViewImports                                   viewimports              [C#]              Web/ASP.NET                          
MVC ViewStart                                     viewstart                [C#]              Web/ASP.NET                          
Blazor (server-side)                              blazorserverside         [C#]              Web/Blazor                           
ASP.NET Core Empty                                web                      [C#], F#          Web/Empty                            
ASP.NET Core Web App (Model-View-Controller)      mvc                      [C#], F#          Web/MVC                              
ASP.NET Core Web App                              webapp                   [C#]              Web/MVC/Razor Pages                  
ASP.NET Core with Angular                         angular                  [C#]              Web/MVC/SPA                          
ASP.NET Core with React.js                        react                    [C#]              Web/MVC/SPA                          
ASP.NET Core with React.js and Redux              reactredux               [C#]              Web/MVC/SPA                          
Razor Class Library                               razorclasslib            [C#]              Web/Razor/Library/Razor Class Library
ASP.NET Core Web API                              webapi                   [C#], F#          Web/WebAPI                           
ASP.NET Core gRPC Service                         grpc                     [C#]              Web/gRPC                             
dotnet gitignore file                             gitignore                                  Config                               
global.json file                                  globaljson                                 Config                               
NuGet Config                                      nugetconfig                                Config                               
Dotnet local tool manifest file                   tool-manifest                              Config                               
Web Config                                        webconfig                                  Config                               
Solution File                                     sln                                        Solution                             
Protocol Buffer File                              proto                                      Web/gRPC                             

Examples:
    dotnet new mvc --auth Individual
    dotnet new react --auth Individual
    dotnet new --help

When I try to create a control library, it doesn't work. Custom controls get created ok.

λ dotnet new controllib
Couldn't find an installed template that matches the input, searching online for one that does...
Usage: new [options]

The following templates partially match the input. Be more specific with the template name and/or language.

Templates                       Short Name               Language      Tags
---------------------------------------------------------------------------------
WPF Custom Control Library      wpfcustomcontrollib      [C#], VB      Common/WPF
WPF User Control Library        wpfcontrollib            [C#]          Common/WPF

Examples:
    dotnet new wpfcustomcontrollib
    dotnet new --help

λ dotnet new wpfcontrollib
Couldn't find an installed template that matches the input, searching online for one that does...
Usage: new [options]

...

WPF User Control Library (C#)
Author: Microsoft
Description: A project for creating a user control library for .NET Core WPF Applications
Options:
  -f|--framework  The target framework for the project.
                      netcoreapp3.0    - Target netcoreapp3.0
                  Default: netcoreapp3.0

  --langVersion   Sets langVersion in the created project file
                  text - Optional

  --no-restore    If specified, skips the automatic restore of the project on create.
                  bool - Optional
                  Default: false / (*) true


* Indicates the value used if the switch is provided without a value.

Comparing the files for the custom control template with those of .NET Framework (generated by Visual Studio Project->New), I see a few files missing.

==

Was this tested to validate that each of the new templates works for both C# and VB?
Were the templates compared against .NET Framework templates?
Any other validation/testing details?

jmarolf · 2019-07-18T21:31:54Z

Comparing the files for the custom control template with those of .NET Framework (generated by Visual Studio Project->New), I see a few files missing.

Those files are blank on .NET Framework. We tend to try and have .NET Core templates only produce the minimal set of files needed now.

vatsan-madhavan · 2019-07-22T19:11:00Z

UserControl - C#:

UserControl template lays down two versions of C# files - UserControl.xaml.cs and UserControl1.xaml.cs
UserControl.xaml is still missing the namespace prefix
- x:Class="UserControl1" should be x:Class="usercontrol.UserControl1"

vatsan-madhavan · 2019-07-22T20:39:52Z

Looks good to me - thanks @jmarolf!

We have couple of outstanding things to puzzle out.

We had to test against 3.0.100-preview7-012821 because the latest sdk 3.0.100-preview8-013379 seems to have trouble building VB. Where should we open an issue for this?
This condition did not evaluate for you - so you had to drop the condition and make this unconditional. We need to chase this down.
- <LangVersion Condition="'$(langVersion)' != ''">$(ProjectLanguageVersion)</LangVersion>

The rest looks good to me.

Marking for auto_merge as soon as the build completes successfully!

/cc @diverdan92, @chabiss

ghost · 2019-07-22T20:40:10Z

Hello @vatsan-madhavan!

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 requested review from vatsan-madhavan, rladuca, ryalanms and stevenbrix June 18, 2019 21:50

ghost added the PR metadata: Label to tag PRs, to facilitate with triage label Jun 18, 2019

jmarolf mentioned this pull request Jun 18, 2019

add shim templates for control libraries dotnet/templates#128

Merged

vatsan-madhavan added the * NO MERGE * metadata: The PR is not ready for merge yet (see discussion for detailed reasons) label Jun 19, 2019

vatsan-madhavan mentioned this pull request Jun 19, 2019

open xaml file first in editor #1007

Merged

vatsan-madhavan reviewed Jun 21, 2019

View reviewed changes

....Dotnet.Wpf.ProjectTemplates/content/WpfControlLibrary-CSharp/.template.config/template.json Outdated Show resolved Hide resolved

vatsan-madhavan reviewed Jun 21, 2019

View reviewed changes

....Dotnet.Wpf.ProjectTemplates/content/WpfControlLibrary-CSharp/.template.config/template.json Outdated Show resolved Hide resolved

vatsan-madhavan removed the * NO MERGE * metadata: The PR is not ready for merge yet (see discussion for detailed reasons) label Jun 27, 2019

vatsan-madhavan requested changes Jul 1, 2019

View reviewed changes

jmarolf force-pushed the add-control-library-templates branch from c61a848 to c3c2767 Compare July 15, 2019 23:37

jmarolf force-pushed the add-control-library-templates branch from c3c2767 to cd10804 Compare July 18, 2019 21:27

jmarolf added 15 commits July 20, 2019 04:50

adding custom control

a1708f8

Add user control library

e581943

align names

2287cd3

open both code and xaml files

f7cadb4

rename folder from WpfControlLibrary-* to WpfUserControlLibrary-*

f9dbbc7

fix typo in template

7672247

remove extra line

c23292e

remove namespace

92e10f3

use wpfusercontrollib as the short name

444300b

adding code files

483ae98

adding default namespaces

92e113f

remove unnecessary namespaces

82679d0

remove un-needed InitializeComponent

f0d84fd

rename files to include xaml

05112d2

add InitializeComponent

8239fe3

jmarolf force-pushed the add-control-library-templates branch from 7cc51f8 to 8239fe3 Compare July 20, 2019 11:53

jmarolf added 5 commits July 22, 2019 12:27

delete duplicate file

0a5d445

prefix class with namespace

a64a546

do not fully qualify VB xaml class name

7c55031

correctly name vb file

432f4ac

do not condition use of root namespace

bb1850e

vatsan-madhavan approved these changes Jul 22, 2019

View reviewed changes

vatsan-madhavan added the auto_merge bot-command label Jul 22, 2019

ghost merged commit c16a1af into dotnet:master Jul 22, 2019

vatsan-madhavan mentioned this pull request Jul 26, 2019

Support Control Library project templates #1036

Closed

grubioe mentioned this pull request Jul 29, 2019

July Update for WPF on .NET Core #1472

Closed

ghost locked as resolved and limited conversation to collaborators Apr 16, 2022

This pull request was closed.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add control library templates #1005

Add control library templates #1005

jmarolf commented Jun 18, 2019

jmarolf commented Jun 19, 2019 •

edited

Loading

cartermp commented Jun 19, 2019

cartermp commented Jun 19, 2019

jmarolf commented Jun 19, 2019

cartermp commented Jun 19, 2019

stevenbrix commented Jun 20, 2019

jmarolf commented Jun 20, 2019

vatsan-madhavan commented Jun 21, 2019

vatsan-madhavan commented Jun 21, 2019

vatsan-madhavan commented Jun 21, 2019

vatsan-madhavan commented Jun 27, 2019

vatsan-madhavan left a comment

cartermp commented Jul 1, 2019

vatsan-madhavan commented Jul 11, 2019

jmarolf commented Jul 16, 2019

vatsan-madhavan commented Jul 17, 2019

jmarolf commented Jul 18, 2019

vatsan-madhavan commented Jul 22, 2019

vatsan-madhavan commented Jul 22, 2019

ghost commented Jul 22, 2019

Add control library templates #1005

Add control library templates #1005

Conversation

jmarolf commented Jun 18, 2019

jmarolf commented Jun 19, 2019 • edited Loading

cartermp commented Jun 19, 2019

cartermp commented Jun 19, 2019

jmarolf commented Jun 19, 2019

cartermp commented Jun 19, 2019

stevenbrix commented Jun 20, 2019

jmarolf commented Jun 20, 2019

vatsan-madhavan commented Jun 21, 2019

vatsan-madhavan commented Jun 21, 2019

vatsan-madhavan commented Jun 21, 2019

vatsan-madhavan commented Jun 27, 2019

vatsan-madhavan left a comment

Choose a reason for hiding this comment

cartermp commented Jul 1, 2019

vatsan-madhavan commented Jul 11, 2019

jmarolf commented Jul 16, 2019

vatsan-madhavan commented Jul 17, 2019

jmarolf commented Jul 18, 2019

vatsan-madhavan commented Jul 22, 2019

vatsan-madhavan commented Jul 22, 2019

ghost commented Jul 22, 2019

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.

jmarolf commented Jun 19, 2019 •

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.