Passing parameters to choco best practices

ferventcoder commented 6 years ago

For short or blended options like -y as compared to --confirm (the long option), use one dash (-). For long options, use two dashes (-- as in --confirm). Blended options are short options combined into one statement, like -y -d -v put together as -ydv.
Always use -y to ensure nothing stops and prompts for more than 30 seconds.
When using options prefer a longer name (--name versus the short -n) to make the scripts more self-documenting. The exception here is -y.
When using options that have a value passed, add an = between and surround the value with "''" (--name="'value'"). This ensures that the argument is not split between different versions/editions of Chocolatey. This also ensures that values like . and \ are not escaped by PowerShell.

These suggestions may need to be validated to ensure that Boxstarter will work with them due to some of its overrides.

ferventcoder commented 6 years ago

@mwrock thoughts?

mwrock commented 6 years ago

Boxstarter simply forwards the args "as is" on to choco. The only special thing that it does is adds -y if it is not included.

microsoft / windows-dev-box-setup-scripts