https://discord.umbraco.com logo
Nuget Reserved Names
# package-development
l
Just a quick question, I'm trying to register a NuGet package on LP.Umbraco.SomePackageName, but it gets rejected because of reserved names. Now I know that Umbraco is reserved, but I thought reservations are only checked at the start of the Name. So I can't name my package Umbraco.*, but I thought Something.Umbraco should work. Am I mistaken? Or is LP somehow reserved? It doesn't say on what grounds it's rejected and support hasn't been really helpful so far...
w
Think @Sebastiaan knows a fair bit about this from memory. I would have thought it would be Umbraco.* disallowed and Umbraco.Community.* is allowed Like you I didn't think it would be Umbraco anywhere in it
l
Yeah the alternative is that LP.* is reserved. It's not impossible, but I find it very unlikely. There aren't many packages that start with LP that would suggest it's an important thing that warrants a reservation
w
Yeh I just done a quick search as well for LP - does the error give any specific reason as to help you identify what the conflict is
l
No that's the annoying part. You can't actually see why it's rejected. And there is no list somewhere you can check
w
I get it that you want to try and promote your name/initials but is there any objection to
Umbraco.Community.
as seems to be a common prefix within the community and it might help with package visibility/discoverability with people just searching on Nuget
l
Yeah it's exactly like you say. I absolutely want to help and give back, so my package will be MIT and open source, no question. But it's also a bit personal branding. Sure, I'm not self employed, so it's maybe less important than if you are, but still.
w
Think there are other ways to help promote your name/brand as assume will be on your own personal github repo, the nuget listing and marketplace listing will say who its by
Unless your doing something commercial/corporate I might consider a different name/prefix
To me anything called
Umbraco.Community.*
without looking at the readme or the repo, I would assume its MIT/Open Source. To me it indicates a community style project that you want to offer to the wider community to work on together and make better, but thats how I just read into it
l
I think that's fair. But on the other hand I'm a bit hessitant in using a lot of community packages. There are many packages of questionable quality and maintained by only one person. Yes, I know the idea is that you can all work on it and I don't want to speak badly about anyone taking the effort of creating something great. But I've seen too many packgaes (also outside of the scope of Umbraco) that don't get maintained after some time. Or if it gets too hard, they just don't do it, like the upgrade to Umbraco 17 for example. So to me, seeing a name on a package that I know is from someone that takes care of it and has a good track record is valuable. Maybe that's me talking also from an agency perspective. I just can't afford using packages without knowing at least something about the track record. So Umbraco.Community to me is also an ocean of varying quality and supported packages. Now it's not as black and white as I'm stating here ofcourse, just giving a different perspective 🙂
s
I can't actually find our list of reservations now (the NuGet site... sucks) Umbraco.* is for sure reserved and I just saw someone cleverly working around it by removing the dot.. UmbracoProject is allowed apparently (😱) is LP.UmbracoCool.Something could be allowed - which is fine with me, but starting with Umbraco should not be allowed since we need to protect the brand and trust. I do not know why it wouldn't be allowed in the middle of a name though. I'll investigate.
l
Since they won't tell me what the reserved part is, it's very much possible that the Umbraco part isn't even the issue... I didn't even try the name with Umbraco because I know it's reserved :D. I might still change it to Umbraco.Community.* though, I'll think about it.
p
Just use LP.Insexnyckel.* instead, that's what it's actually called anyway.
w
Totally valid & I put my hands up as a being a bad maintainer, love to create things and share them, but I am not always great at maintaining things, but with it being in the open my thoughts is that they can either bring the code in house and maintain as part of the agency's/client project codebase or reach out to offer to help with maintenance. One for a package team discussion for sure 🙂
s
l
Thanks for the effort Sebastiaan!
w
Ace - maybe add it into docs about creating packages perhaps so people are aware what the restrictions might be
h
I agree Warren I was actually looking for that information recently about naming restrictions and was surprised they were available in the docs somewhere
l
Did you add it where you expected to find it @Hooky ?! Or does this still need doing?
h
I hadn’t got round to it unfortunately. Did submit a PR today for a fix for the marketplace metadata that’s incorrect in the docs though (“Categories” property should be “category” according to the validator)
l
Good spot, I believe it should be
Category
! Ok, you get a gold star ⭐ 😆
l
I just named the package Umbraco.Community.AdvancedPermissions. Saved me a lot of headaches 😄 It's in beta right now 🙂
3 Views