search

poshbotio / PoshBot

Powershell-based bot framework
MIT License
538 stars 108 forks source link

Inconsistent parameter names for builtin commands #7

Closed devblackops closed 7 years ago

devblackops commented 7 years ago

Expected Behavior

Parameter names are consistent

Current Behavior

Parameter names in the builtin commands are not consistent with each other. For instance, Install-Plugin uses -Plugin to reference the plugin to install and Get-Role using -Role to reference the role to get. In both cases they should use -Name which is the PowerShell convention.

Possible Solution

Rename all parameters in the builtin commands to use a common naming convention.

Context

A common naming convention will help with usability as most PowerShell users are familiar with the naming convention for parameters.

michaeltlombardi commented 7 years ago

I can work on this. Should we alias the parameters for now or just accept it as a pre 1.0.0 breaking change?

devblackops commented 7 years ago

At this point I think we can make a breaking change. This hasn't been published to the PSGallery yet. Once that is done, we should be more diligent about change stuff like this. Thanks for grabbing this!

michaeltlombardi commented 7 years ago

I'll start digging in!

Also, per Semantic Versioning, the api/project is not considered 'stable' until 1.0.0 - so even though this is a breaking change, it'd be marked as a minor bump instead of a major.