PowerShell / Modules

MIT License
113 stars 25 forks source link

[SecretsManagement] Remove Plurality from Secret Commands #35

Closed JustinGrote closed 4 years ago

JustinGrote commented 4 years ago

Powershell convention dictates that plurality should not be present in cmdlet names, so the following changes should be made: Get-SecretsVault -> Get-SecretVault Register-SecretsVault -> Register-SecretVault Unregister-SecretsVault -> Unregister-SecretVault

tommymaynard commented 4 years ago

I came here to open this same issue, but @JustinGrote beat me to it. For years now, the community has been instructing people to use the \-<SingluarNoun(s)InCamelCase> format. Please (please [please]) see that this is corrected before GA. I'd take it one further, and change the module name, as well. Even that doesn't need "secrets," over "secret." As someone that's worked closely with AWS and their PowerShell cmdlets, I've always wondered which came first: All the plural aliases they have, or plural cmdlets names that were changed to singular, followed by all the plural aliases. Regardless, I say we skip the need for aliases in this module. Thank you!

bergmeister commented 4 years ago

Well, technically it is singular because it is not SecretsVaults 😅 But I still agree that SecretVault sounds much better. But to be honest, why not take it further and just call it Vault only? People call it different things like e.g. KeyVault in the case of Azure and it can store secrets, keys and certificates. Therefore the word Secret in SecretVault isn't describing anything specific and a vault by definition already stores something valuable that only certain authorized people should be allowed access to, hence why I think including the word Secret in the name does not add any meaning and is rather superfluous and potentially confusing. And whilst we're at it, is the module not rather a VaultManagement module?

JustinGrote commented 4 years ago

@bergmeister The reason for the Secret prefix is to identify the module in a pseudonamespace way, the same way that Az is prepended to all azure commands. This is proper since this is probably not going to be a "in-the-box" module and those should probably be reserve for the future.

I'd agree module name should be probably Microsoft.Powershell.SecretManagement instead.

PaulHigin commented 4 years ago

Cmdlets, classes, module name has all been changed. So there is now a new module Microsoft.PowerShell.SecretManagement in the repo.