search

madskristensen / Community.VisualStudio.Toolkit

A community toolkit for writing Visual Studio extensions
Other
24 stars 3 forks source link

VSSDK Community Toolkit (Microsoft.Toolkit.VSSDK) #2

Closed yannduran closed 3 years ago

yannduran commented 3 years ago

As James suggested, using a name like VSSDK Community Toolkit would fit in well with:

And a perfect namespace could be Microsoft.Toolkit.VSSDK, again in line with the namespaces in the toolkits mentioned above.

A natural extension (no pun intended) would be namespaces like:

If this idea is accepted, I'd also suggest that the repo should be renamed Microsoft.Toolkit.VSSDK. It's early enough that only a few people would have to adjust. Or maybe just create a new repo, and archive this one.

madskristensen commented 3 years ago

I like the Toolkit naming idea. The official VSSDK NuGet package name is Microsoft.VisualStudio.SDK. So what if we called our package Community.VisualStudio.SDK?

The namespace would then also be Community.VisualStudio.SDK

yannduran commented 3 years ago

I don't hate Community.VisualStudio.SDK, but there's no indication that it's a toolkit rather than some new SDK. Are we aiming to make the existing VS SDK easier to use, or are we aiming for it to be a new SDK? See what I'm getting at?

I initially thought of Microsoft.Toolkit.VisualStudio.SDK. I like it a lot, but that seemed maybe a bit long.

I see the pattern you're going with, but it's totally different to the pattern used by the existing community toolkit namespaces in the Windows, MVVM, UWP toolkits etc. Just a thought to maybe be consistent. Or not.

image ..

image

It could slot into the above pattern quite nicely. If nobody agrees with me, it could also be Community.ToolKit.VisualStudio.SDK, but I kinda think that's a bit repetitive with both community and toolkit.

I don't necessarily love the Microsoft.ToolKit prefix, although it groups the toolkits together nicely, but it's what's out there, and we have the choice to match it or go alone.

IMNSHO, regardless of what's chosen, the repo name, the package name, the toolkit name and the namespace should all match.

I guess we should ask the question, what do people prefer, and why?

  1. Community.VisualStudio.SDK
  2. Community.ToolKit.VisualStudio.SDK
  3. Microsoft.Toolkit.VisualStudio.SDK
  4. Microsoft.Toolkit.VSSDK
reduckted commented 3 years ago

Microsoft.Toolkit.VisualStudio? Does it need to include SDK in the name?

Also, are there any issues using Microsoft in the name if it's not officially supported by Microsoft?

yannduran commented 3 years ago

Good point! I'd be happy either with or without.

madskristensen commented 3 years ago

Good points @yannduran. I agree with your logic here. The NuGet package can't start with the name Microsoft. - only official Microsoft packages can. So, that limits our options a bit. Here's a list of suggestions:

  1. Community.Toolkit.VisualStudio
  2. VisualStudio.Community.Toolkit
  3. VisualStudio.Toolkit.SDK
  4. VisualStudio.SDK.Toolkit
  5. other...?
yannduran commented 3 years ago

If we can't use Microsoft.Toolkit.xxx then most of what I proposed is moot as we can't match the existing toolkit pattern anymore. That was really the only reason that I was suggesting using Microsoft.Toolkit in the name.

So I think that Mads' suggestion of VisualStudio.SDK.Toolkit would perhaps be the best choice as it at least matches the existing NuGet package, minus the Microsoft. and with the addition of a .Toolkit suffix showing that it's based on, and extends the SDK.

So instead of matching the existing toolkit naming pattern, it would match the existing NuGet package name instead.

That would leave us with:

Repo Name : VisualStudio.SDK.Toolkit Namespace : VisualStudio.SDK.Toolkit Nuget Name: Visual Studio SDK Toolkit

Nice and neat! (and consistent lol)

madskristensen commented 3 years ago

Nooo, the package can't start with **VisualStudio.*** either - it's reserved. How about these:

I vote VSSDK.Community.Toolkit.

yannduran commented 3 years ago

I give up!

madskristensen commented 3 years ago

@yannduran haha, yeah, it's not easy. Let's just settle on a name so we can move forward.

reduckted commented 3 years ago

VSSDK.Community.Toolkit gets my vote. "Visual Studio SDK Community Toolkit" sounds like a good name.

madskristensen commented 3 years ago

VSSDK is also a reserved name, so now I'm trying Community.VisualStudio.Toolkit