Badgerati / Pode

Pode is a Cross-Platform PowerShell web framework for creating REST APIs, Web Sites, and TCP/SMTP servers
https://badgerati.github.io/Pode
MIT License
855 stars 94 forks source link

Rename public function with a plural nouns to a singular one #1293

Open mdaneri opened 6 months ago

mdaneri commented 6 months ago

PowerShell best practices state cmdlets should use singular nouns and not plurals. Suppression allows you to suppress the rule for specific function names. For compatibility, an Alias with the old name will be created.

Functions

Badgerati commented 5 months ago

Test-PodeAccess and Test-PodeAuth already exist as functions. Maybe something like Test-PodeAccessPresent or Test-PodeAccessCreated / Test-PodeAccessAdded?

IMO, these functions are valid use cases of plural names, as the Clear ones really are doing multiple things ad they can't be singularised - Clear-PodeTimers will clear all timers out regardless and Clear-PodeTimer will be confusing.

I'll agree on the Merge-PodeScriptblockArgument and Use- ones though, those could be changed.