RamblingCookieMonster / PSDepend

PowerShell Dependency Handler
MIT License
283 stars 76 forks source link

Can we talk about naming? #80

Closed Jaykul closed 5 years ago

Jaykul commented 6 years ago

Why is it that the main install function is named Invoke-PSDepend instead of Install-BuildDependencies or something appropriate like that?

gaelcolas commented 6 years ago

It's not really installing IMO... but I feel like Restore would fit well: Restore-PSDependencies Naming is hard.

I'm not convinced about using Build in the noun, although it would probably in a build job or task, you might be resolving test dependencies, data dependencies, DSC resources dependencies... I find that build could induce confusion depending how it's used.

Jaykul commented 6 years ago

I guess I'm pretty confused about who and what you would use this for apart from build-time. Especially when you say it's not really installing.

What are you using it for?

RamblingCookieMonster commented 6 years ago

Borrowed a lot from PSDeploy, thus, Invoke-PSDeploy became Invoke-PSDepend (couldn't come up with a reason to change it back then).

A few things I've used it for:

For the most part, yeah, the end result is an install, but Invoke-PSDepend has some other things built in:

Basically... it's a convenient way to invoke psdepend : P

Cheers!

rlvandaveer commented 5 years ago

Invoke-PSDepend is very similar to how you execute other similar modules e.g., psake: Invoke-Psake, pester: Invoke-Pester, etc.

Jaykul commented 5 years ago

That doesn't make "invoke" a good verb. In fact, of these tools are doing it wrong, because they are all following Pester's anti-pattern approach to naming. Remember, Pester is the module that couldn't be bothered to follow verb-noun, and introduced Ruby-like syntax to PowerShell.

Invoke-PSDepend is only a good name if "Depend" is the name of a command or method.

Having said that, a year ago, I cared. Now, I don't. It's been badly named all this time, and nobody else cares (and I decided not to use it) so it doesn't matter.