Update C# templates to introduce file scoped namespaces

[haonanttt]

Purpose

Regarding to #3329, creating this PR to introduce file scoped namespaces.

What have changed

For all .cs files inside dev/VSIX/ItemTemplates and dev/VSIX/ProjectTemplates, the template code format have been changed to file scoped namespaces:

namespace MyNamespace;

public sealed partial class MainWindow : Window
{
    public MainWindow()
    {
        ...
    }
}

[haonanttt]

1 more thing to be confirmed:
Should the .cs files inside dev/VSIX/Extension and dev/VSIX/Shared also be changed?

[michael-hawker]

1 more thing to be confirmed: Should the .cs files inside dev/VSIX/Extension and dev/VSIX/Shared also be changed?

I'm not as familiar with those, but it doesn't hurt to apply this change to every C# file across the entire repo.

File-scoped namespaces were added for .NET 6, which should be everything here.

[michael-hawker]

🦙❤️ Awesome, thanks @haonanttt for putting this together! 🎉🎉🎉 Couple of suggestions to improve partial class coverage for AOT and source generators.

I thought I remembered another small thing related to templates, but can't find it in my chat history. Nothing came to mind when going through the review. @niels9001 want to do a quick pass to see if I missed anything?

[niels9001]

@haonanttt Love these changes 🚀! Since we are removing the Button click event, we should remove it from the Cpp templates as well?

With .NET9 WPF now comes with modern theming and has Mica enabled as default maybe this is something we should enable as well? Especially since this is something that is a default design pattern across Windows, and are just a 3 lines of XAML.

[michael-hawker]

@niels9001 good call out! This may have been what I was thinking about unconsciously. It was pretty jarring to see the difference with the new WPF template/theming enabled and the WinUI window just being a black box during our .NET Conf demo:

[haonanttt]

@haonanttt please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.

@microsoft-github-policy-service agree [company="{your company}"]

Options:

• (default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.

@microsoft-github-policy-service agree

• (when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.

@microsoft-github-policy-service agree company="Microsoft"

Contributor License Agreement

@microsoft-github-policy-service agree company="Microsoft"

[haonanttt]

Current changes:

1. introduce file scoped namespaces for .cs files inside dev/VSIX
2. Make sure all .cs files using partial classes
3. Enable Mica for all window-level files

Need discussion:

1. Shall we still keep the button and handler or make everything empty grid

[michael-hawker]

Looking great! Just did a quick pass to apply some C# style guidelines as suggestions which can be applied in batch. Mostly to remove this. and the m_ to just _ for window. (I linked to references in those first comments.) The only thing I couldn't make as a suggest was moving the _window member to the top of the class.

Thanks so much for going through this with us, this is going to be a great improvement to the templates to make it more streamlined for devs to get work done! 🦙❤️

Stale, feedback addressed

[haonanttt]

Current status:

• Comments from Michael and Niels have been resolved.

Next steps:

• Will move on the PR after Scott's review

[michael-hawker]

FYI @Scottj1s, Niels and I are all good here as external approvers; we really appreciate the work @haonanttt has done with us here to modernize the templates and bring them up-to-date with all the latest .NET features/patterns. 🦙❤️

I believe we addressed @codendone's initial concern about the Button in the comment thread, but happy to chat about any concerns you have, feel free to ping me if you have any - otherwise hopefully we can just merge. Thanks!

[Scottj1s]

@haonanttt I'll add my thanks too, as well as to @mrlacey, @dotMorten, who were involved in an earlier discussion on this, and to @wjk, who authored a similar PR a few years ago, later closed. I appreciate the need for discussion, but we clearly never got around to one, and the frustrations remain. My preference is to bias for action here and course correct if necessary.

A few things to consider:

• There is much history here, which I myself don't recall. The C# templates were inspired by the C++, in turn cribbed from C++/WinRT. I have no problem with divergence from the C++/WinRT templates, but we should at least be consistent between C++ and C# templates here - removing the Button in both (see William's PR).
• Ideally, we would also remove the unused C++ project template MyProperty (see William's PR) - however, there may be a technical limitation that requires at least one member in the class IDL.
• Since we're removing the Button, we could consider adding a readme.txt, as we have for the C++ templates (e.g., here), to include a link to the Windows App SDK Samples, and/or add a comment in the Xaml/C# with that link.

[Scottj1s]

... we should at least be consistent between C++ and C# templates here - removing the Button in both (see William's PR).

Ah, wasn't paying close attention - I see we've removed Button across the board

[michael-hawker]

@Scottj1s I like the idea of a readme, but I know for UWP VS would just pop open the 'getting started' guide when you started a new project to get these resources:

They do have this comment in the MainPage.xaml.cs:

// The Blank Page item template is documented at https://go.microsoft.com/fwlink/?LinkId=402352&clcid=0x409

---

For WinUI 3 by comparison, that 'getting started' guide does not appear - are we missing a flag or something - or was this just never ported over in VS?

And we already have this comment in the MainWindow.xaml.cs file:

// To learn more about WinUI, the WinUI project structure,
// and more about our project templates, see: http://aka.ms/winui-project-info.

But this landing page is a bit sparse, should we use a different aka.ms link here or improve that doc page? FYI @niels9001

[michael-hawker]

@Scottj1s could we merge these technical improvements into the templates now? And then take a follow-up with a task to talk about improving the getting started pages in VS across the board? It seems that may be unique to UWP, but a great feature. Like WPF doesn't do it either and just throws you into MainWindow.xaml:

Our other templates don't add readmes (as then folks tend to never go update those so we could get repos people push to GitHub that just have that file everywhere muddling search results). It really seems to be supplanting this feature that seems supported by VS somehow/somewhere for at least some project types, so it'd be great if we could work to improve this everywhere for everyone for all project types working across the VS ecosystem.

And in the interim, we should update the existing link's comment or improve the page it points to in the docs. @niels9001 is that a good aka.ms link which of those two comment options should we take?

[dotMorten]

oh YES! This is such a nice cleanup of the starter template! Ship it!

Also regarding the readme discussion. Please don't add junk to the project structure. This might be better as a Visual Studio feature, with the little yellow tips bar that is sometimes on top of the file tabs (I've seen MAUI often use this)

[michael-hawker]

Leaving this here for the future, @niels9001 found the introduction to start pages in VS blog here: https://devblogs.microsoft.com/visualstudio/walkthrough-creating-a-custom-start-page-part-1/

Seems like we should create follow-on tasks for both WPF and WinUI here (for both C++ and C#) to work to adding these into the templates.

[RyanLua]

I haven't seen this mentioned here but the default .NET .editorconfig file defines block scoped namespace so Visual Studio or other tools using .editorconfig may format using block scoped.

csharp_style_namespace_declarations = block_scoped

Just letting my thoughts since I don't see this being addressed. Nothing that I think this PR can do since this is more of a Visual Studio problem than WASDK.

[ghost1372]

Hi @michael-hawker
The link you provided is an old article and the links and templates are not available.
After a few hours of struggling, I was able to load a user control into the Tool Window.😁

[ghost1372]

I haven't seen this mentioned here but the default .NET .editorconfig file defines block scoped namespace so Visual Studio or other tools using .editorconfig may format using block scoped.

csharp_style_namespace_declarations = block_scoped

Just letting my thoughts since I don't see this being addressed. Nothing that I think this PR can do since this is more of a Visual Studio problem than WASDK.

Absolutely correct
I have faced this problem before and had to use the .editorconfig file for my VSIX.
file scoped namespaces should be fixed by Visual Studio. The only solution is to add the .editorconfig file via VSIX.

[michael-hawker]

@haonanttt @Scottj1s now that we have this approved, what's left before we merge? How do these get integrated into releases from the repo here? Will it just be in the next latest drop on NuGet that pulls these in?

[haonanttt]

/azp run

[azure-pipelines]

Azure Pipelines successfully started running 1 pipeline(s).

[michael-hawker]

Looks like some of the auxiliary project types target older .NET runtimes or something?

dev\VSIX\Extension\Cs\Dev17\VSPackage.cs(10,1): Error CS8370: Feature 'file-scoped namespace' is not available in C# 7.3. Please use language version 10.0 or greater.

dev\VSIX\Extension\Cs\Dev17\VSPackage.cs

WindowsAppSDK/dev/VSIX/Extension/Cs/Dev17/WindowsAppSDK.Cs.Extension.Dev17.csproj

Line 14 in bc1af23

<TargetFramework>net472</TargetFramework>

If this is just for the package itself, we should be fine to just add <LangVersion> to the csproj here? Otherwise, we can put it back for this one, it matters less if it's not consumed by external folks and just a helper class (I'm not familiar with the specific of the VSIX config here beyond the C# templates).

dev\VSIX\Shared\WizardImplementation.cs

The same csproj above manages this file as well, though there's also an include of it in the C++ project as well?

WindowsAppSDK/dev/VSIX/Extension/Cpp/Dev17/WindowsAppSDK.Cpp.Extension.Dev17.csproj

Line 82 in bc1af23

<Compile Include="..\..\..\Shared\WizardImplementation.cs" Link="WizardImplementation.cs" />

Not as sure what this even means here. If these are just internal files to the VSIX, we don't have to update the scope here, or we can try adding <LangVersion> to both projects and see if that resolves it.

[haonanttt]

Investigated and informed the file dev\VSIX\Extension\Cs\Dev17\VSPackage.cs and dev\VSIX\Shared\WizardImplementation.cs is used for project setup, will not show as some templates. So decide to revert the file scoped namespace for them to get less impact for those files.

[haonanttt]

/azp run

[azure-pipelines]

Azure Pipelines successfully started running 1 pipeline(s).