Added project template #9

shweaver-MSFT · 2021-12-07T19:21:33Z

Fixes #4

Template folder:

Visual Studio Solution Explorer:

Example output from dotnet new labsapp -n TemplateTest

I put together a simple project template with most of the parts that should make a good baseline for starting new labs projects. CounterButton is a custom button that increments when you click it. I figure this is a nice opportunity to show a few common patterns for creating templated controls.

Unit and UI Tests

All the tests work, including UI tests using WinAppDriver.

Documentation

The ProjectTemplate.md represents the documentation for the feature (it will be renamed during the generation process).

I've also included a README.md to cover the various parts of the template and how to use it.

dotnet new

To install the template for use from dotnet new, go to the Template directory and run the following command:

dotnet new --install ./

Once the template is installed, use the dotnet new command to generate a new copy of the template with a provided name:

cd C:/Git
dotnet new labsapp -n MyLabsApp

Let me know what you think!

TODO:

michael-hawker · 2021-12-07T19:37:40Z

We can worry about ui tests later too? They're not as common, as I think we can get away a lot with the VisualUITestBase (we should bring that over to the common folder to be able to reference in our unit test projects).

I guess when the template is copied/used for setup in the Labs directory, it'd replace 'CounterButton' automatically with whatever the name of the experiment is?

shweaver-MSFT · 2021-12-07T19:44:37Z

@michael-hawker you bring up an interesting point. I put the CounterButton in there expecting the dev to strip it out and rename the projects. The process of doing that will show them everywhere they need to update with their own code. I didn't plan on doing any auto renaming.

The other approach is to put no examples in the template, leave it bare, and expect the dev to follow the comments.

I lean towards option 1 because it gives them something to use as an example, and if we ever detect "CounterButton" we know there is more work to do.

michael-hawker · 2021-12-07T19:50:13Z

@shweaver-MSFT yeah, I do like having example code that does something that they can modify. I just know sometimes it can be hard to get every namespace and config thing (especially in some project files) when it comes to renaming things, so it'd be cool if the template setup step could do that bit for them. We could leave the component in the library file still called 'CounterButton'. I think it'd just be all the project names and things.

This would also make sure it's less likely they dev doesn't change the library namespace/package name that we'd still want to follow the pattern of CommunityToolkit.Labs.Uwp.ExperimentName (or maybe we want Windows over UWP as it may target Uno and eventually WinUI or something as well, we haven't gotten to that point yet though).

Updates namespaces Improved unit tests

shweaver-MSFT · 2021-12-07T21:56:38Z

@michael-hawker I agree, some auto-replacement of names would be nice. I made a few changes. Let me know what you think. @Arlodotexe @XAML-Knight you guys too!

Moved common code to shared project

…all-sample" apps, organization and cleanup.

Made projects use assets in common folder Minor tweaks to CounterButton

…owing in VS dropdown

…-projects Enabling x-plat, adding sample page libraries

Template/ProjectTemplate.Library/CounterButton.cs

shweaver-MSFT · 2021-12-10T19:58:17Z

@XAML-Knight sorry you hit those issues with the template. @michael-hawker brought up a good idea about encapsulating the setup in a newexperiment.bat file. I'll spend some time setting up the script to handle all the dotnet new bits. You're right, we shouldn't expect devs to need to know the CLI to spit out a template 🙂

Updates namespaces Improved unit tests

Made projects use assets in common folder Minor tweaks to CounterButton

…/Toolkit-Labs-Test into shweaver/template

michael-hawker · 2021-12-10T21:30:47Z

Looks like this branch is really far behind main and is missing common things you'll need.

I think the goal here was to just get the infrastructure setup and explore some of the testing bits, then we could coordinate better with everything merged together.

Though it looks like Shane may have merged main in at least.

I think we do need to test if the template is happy of we reference a props file that wouldn't exist in the template directory until the template is created, though again think we can fix and explore that after we know what our final sample environment looks like.

Also fixed up Style key creation/default style setup. Renamed assembly name to include ProjectTemplate as well.

…ltiple Labs and use

michael-hawker · 2021-12-13T20:12:51Z

New-Experiment.ps1

+
+    # Does an experiment by this name already exist in the Labs folder?
+    # If so, we'll need to re-prompt for the experiment name and re-validate until the name is determined to be unique.
+    while (Test-Path "./Labs/$($ExperimentName)" -PathType Container)


Do we want a loop or to just terminate the command and they can just run it again with a different name?

I vote for terminating so it's easier to integrate with other tooling

mrlacey · 2022-03-17T15:38:31Z

Template/ProjectTemplate.sln

+MinimumVisualStudioVersion = 10.0.40219.1
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Documentation", "Documentation", "{3D695A5F-0860-46E0-B52F-5C80F692617A}"
+	ProjectSection(SolutionItems) = preProject
+		..\..\License.md = ..\..\License.md


This path goes to a file that may not be available in the generated solution as it isn't in the template and relies on the new solution being created in a specific location.

mrlacey · 2022-03-17T15:51:17Z

Template/README.md

@@ -0,0 +1,21 @@
+# Windows Community Toolkit Labs - Project Template


What's the purpose of this file?
Is it documenting the code that is then packaged into a template?
Or, is it intended to explain the generated solution to the developer who created a new lab from the template?

If the first, why is it in the generated solution?

If the second, it needs actionable content. It would also be good to have this open by default when the solution is opened for the first time.

In either case, it would be useful to have some placeholder content in each section that indicates what will eventually go under each heading.

shweaver-MSFT · 2022-03-17T16:58:18Z

JFYI, I don't have any intentions of working on this PR anymore. It was a fun hackathon project, but I had a hard time completing it without more clarity around what the requirements are for this template feature. @michael-hawker you can do with this what you like :)

@mrlacey would you be interested in taking this on and working with Michael to find the right template pattern?

mrlacey · 2022-03-17T17:01:03Z

JFYI, I don't have any intentions of working on this PR anymore. It was a fun hackathon project, but I had a hard time completing it without more clarity around what the requirements are for this template feature. @michael-hawker you can do with this what you like :)

@mrlacey would you be interested in taking this on and working with Michael to find the right template pattern?

Thanks.
I started making a few comments as I was looking through it before realizing there were bigger things going on that would likely prevent this from being merged. :)

michael-hawker · 2022-03-17T19:06:18Z

JFYI, I don't have any intentions of working on this PR anymore. It was a fun hackathon project, but I had a hard time completing it without more clarity around what the requirements are for this template feature. @michael-hawker you can do with this what you like :)

Thanks @shweaver-MSFT! This is going to be super useful for the future. We've just been figuring out where everything is going to land, so want to make sure we create the template bit after we know how everything fits together. Matt just joined our team here, so he's digging into all this stuff as we shore up what our requirements are and move forward.

michael-hawker · 2022-05-10T08:08:36Z

Superseded by #76, closing this out now. Thanks @shweaver-MSFT for all this early investigation work!

Added project template

cc24689

Arlodotexe and others added 7 commits December 7, 2021 14:07

Refactored to use shared project for MainPage and App files #1

071ef5c

Moved assets and appxmanifest to shared project #1

36899a9

Fixed temp publisher display name

c0bbaa9

Fixed missing depoy flag

4d0ea85

Fixed default display name for common sample apps

3fe2ced

Fixed target platform version

bc8cf18

Moved assets to common folder

2931019

Updates namespaces Improved unit tests

Arlodotexe and others added 14 commits December 7, 2021 17:15

Merge pull request #10 from michael-hawker/refactor/shared-project-setup

86010e3

Moved common code to shared project

Made existing projects Uno-capable, added Wasm projects, added root "…

91d8d7b

…all-sample" apps, organization and cleanup.

Added UI test app

5242f7e

Made projects use assets in common folder Minor tweaks to CounterButton

Removed old todo file

f30af5a

Renamed sln file

9a18f72

Moved WASM assets to common shared project

70f6e6f

Show WASM assets in shared project

dd625a6

Moved appxmanifests to each UWP project, fixed uber-sample app not sh…

3ea6292

…owing in VS dropdown

Added support for dotnet new template generation

917c5fc

Updated folder names

9e492cb

Fixed missing manifest in WASM projects

254af77

Fixed missing deploy flags

a883356

Tweaked template project for cleaner output

a838cee

Merge pull request #11 from michael-hawker/refactor/xplat-sample-page…

bfba86d

…-projects Enabling x-plat, adding sample page libraries

Arlodotexe reviewed Dec 9, 2021

View reviewed changes

Template/ProjectTemplate.Library/CounterButton.cs Outdated Show resolved Hide resolved

shweaver-MSFT added 3 commits December 9, 2021 10:21

Fixed DataContext issue in CounterButton example

6145ed8

Rewrote CounterButton to be more better

1d0f42a

Bug fix

2aced5f

shweaver-MSFT added the in progress 🚧 label Dec 10, 2021

shweaver-MSFT added 12 commits December 10, 2021 12:00

Added project template

4a87bb1

Moved assets to common folder

dc757af

Updates namespaces Improved unit tests

Added UI test app

aca1e75

Made projects use assets in common folder Minor tweaks to CounterButton

Removed old todo file

04d2cf2

Renamed sln file

8129c0e

Added support for dotnet new template generation

76ae10d

Updated folder names

6682958

Tweaked template project for cleaner output

18184bb

Fixed DataContext issue in CounterButton example

202c1bc

Rewrote CounterButton to be more better

a8a85e0

Bug fix

75d5e2a

Merge branch 'shweaver/template' of https://github.com/michael-hawker…

30dff88

…/Toolkit-Labs-Test into shweaver/template

michael-hawker and others added 4 commits December 10, 2021 14:21

Move CounterButton XAML to its own file in Template Project

392ffcf

Also fixed up Style key creation/default style setup. Renamed assembly name to include ProjectTemplate as well.

Flatten/Clean-up Namespaces used for Template so easier to install mu…

061d7b6

…ltiple Labs and use

Add a bit more info to Project Template file

1ac43ad

WIP new experiment script

cf65522

michael-hawker reviewed Dec 13, 2021

View reviewed changes

michael-hawker mentioned this pull request Mar 16, 2022

Template Infrastructure #4

Closed

mrlacey reviewed Mar 17, 2022

View reviewed changes

michael-hawker marked this pull request as draft March 17, 2022 18:09

michael-hawker closed this May 10, 2022

niels9001 deleted the shweaver/template branch June 22, 2023 14:23

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added project template #9

Added project template #9

shweaver-MSFT commented Dec 7, 2021 •

edited by michael-hawker

Loading

michael-hawker commented Dec 7, 2021 •

edited

Loading

shweaver-MSFT commented Dec 7, 2021 •

edited

Loading

michael-hawker commented Dec 7, 2021 •

edited

Loading

shweaver-MSFT commented Dec 7, 2021

shweaver-MSFT commented Dec 10, 2021

michael-hawker commented Dec 10, 2021

michael-hawker Dec 13, 2021

Arlodotexe Dec 13, 2021

mrlacey Mar 17, 2022

mrlacey Mar 17, 2022

shweaver-MSFT commented Mar 17, 2022

mrlacey commented Mar 17, 2022

michael-hawker commented Mar 17, 2022

michael-hawker commented May 10, 2022

		@@ -0,0 +1,21 @@
		# Windows Community Toolkit Labs - Project Template

Added project template #9

Added project template #9

Conversation

shweaver-MSFT commented Dec 7, 2021 • edited by michael-hawker Loading

Unit and UI Tests

Documentation

dotnet new

TODO:

michael-hawker commented Dec 7, 2021 • edited Loading

shweaver-MSFT commented Dec 7, 2021 • edited Loading

michael-hawker commented Dec 7, 2021 • edited Loading

shweaver-MSFT commented Dec 7, 2021

shweaver-MSFT commented Dec 10, 2021

michael-hawker commented Dec 10, 2021

michael-hawker Dec 13, 2021

Choose a reason for hiding this comment

Arlodotexe Dec 13, 2021

Choose a reason for hiding this comment

mrlacey Mar 17, 2022

Choose a reason for hiding this comment

mrlacey Mar 17, 2022

Choose a reason for hiding this comment

shweaver-MSFT commented Mar 17, 2022

mrlacey commented Mar 17, 2022

michael-hawker commented Mar 17, 2022

michael-hawker commented May 10, 2022

shweaver-MSFT commented Dec 7, 2021 •

edited by michael-hawker

Loading

michael-hawker commented Dec 7, 2021 •

edited

Loading

shweaver-MSFT commented Dec 7, 2021 •

edited

Loading

michael-hawker commented Dec 7, 2021 •

edited

Loading