Change default shell if installing ZSH

[jacobwoffenden]

Changes default shell to /bin/zsh

Resolves #324

[samruddhikhandale]

Added my thoughts to the original issue #324 (comment)

Hi @jacobwoffenden 👋 ,

As a heads up, we're discussing splitting up the common-utils Feature: #67 where we have discussed of creating a new feature for Zsh.

When using the common-utils feature, and setting installZsh to true (default behaviour), I think it would be useful to change the default shell for the determined ${USERNAME}

This is a good point and makes sense to me. However, making this change now could be a little disruptive for the users who expects bash as their default shell when they use this common-utils Feature. Also, most of the dev container images rely on this common-utils Feature. The community using these images have also been expecting bash as the default shell. We could add a command to change the shell to bash for the image but again it would be little contradictory.

I wonder if we could hold on making this change in #325 for now as it will be soon addressed by #67 (comment)? I can add this suggestion to ensure that zsh is configured for the default user when the zsh Feature is used. We could also add a new isConfigured: true property for the Feature so that anyone could disable and simply install zsh. (That'll be useful for the dev container images)

@jacobwoffenden what do you think?

[jacobwoffenden]

@microsoft-github-policy-service agree

[samruddhikhandale]

Thank you, appreciate it! Left some comments

[samruddhikhandale]

Looks amazing! Thank you 👏