feat(git_commit): Add only_detached option

[ybc37]

Description

This adds a new option only_detached to the git_commit module. It doesn't change default behavior as its default value is false. Set to true, it will only show the commit hash if the repo is in detached HEAD state; if HEAD is on a branch, it will not output the hash. Also see #706.

Motivation and Context

Closes #706

Types of changes

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)

Screenshots (if appropriate):

How Has This Been Tested?

• I have tested using MacOS
• I have tested using Linux
• I have tested using Windows

Checklist:

• I have updated the documentation accordingly.
• I have updated the tests accordingly.

[matchai]

Sorry for not getting to this PR sooner. 😅

This feature looks great! In fact, I think it should be the default behavior for this module.

I'd be in favor of enabling the git_commit module by default if only_detached is true by default:

Thoughts @starship/astronauts? 👩‍🚀👨‍🚀

[jletey]

@matchai I think that this is a splendid idea! And very useful too! Ship it 🚀

[ybc37]

I'm happy to get it merged :) Just let me know if I should change the defaults once there's a consensus or feel free to change it yourself, of course :)

OT: Other prompts have this combined. If on branch show master, if detached only show hash ba18e1a (instead of HEAD). So basically merge the two modules git_branch and git_commit. But I understand this doesn't work for people, who prefer to always have the hash in the prompt. Or would it be an option to show the branch and the hash in one module?

[matchai]

Unfortunately this PR got lost in the mix.
I would still love to see this merged in, but testing it locally, it seems to be showing the hash when I'm on master.

Can anyone else verify that it's working for them?

[ybc37]

It works here, just checked. Have you set only_detached = true for the git_commit module? Default behavior is still to always show the hash, but as said before, just let me know if I should change that.
(Also, I forced pushed (maybe a day) after submitting this PR to fix a logical bug, so make sure to be up-to-date 😉)

Edit: I also rebased on master right now.

[matchai]

There we go! Yep, looked like a blunder on my end. 😅
Everything looks like it works well. 👍

Could you please set the default behavior to the following:

disabled = false
only_detached = true

You'll want to update the config, docs, and remove these lines here:

starship/src/modules/git_commit.rs

Lines 12 to 14 in 452ea5b

	if config.disabled {
	return None;
	};

[ybc37]

Sure, I changed it :)

Maybe someone can have a look at the commit. Especially the tests, if it's ok this way, or needs more work (I only apply the minimal changes to the tests, but maybe we want to change them, so they reflect the default better?).

About the line you suggested to remove: I'm not sure if understand. Isn't that still needed if someone wants to disable the module?

[matchai]

About the line you suggested to remove: I'm not sure if understand. Isn't that still needed if someone wants to disable the module?

That line was there due to us not yet implementing logic to handle disabled-by-default modules. We do, however, have logic to handle manually disabled modules via configuration here: https://github.com/starship/starship/blob/master/src/context.rs#L106-L113

[ybc37]

Ok, I see. Thanks for explaining! :)

Removed that and rebased the branch on master.

[matchai]

Looks good to me! 👍
Thank you for seeing this PR through. 😊

I went ahead and removed the updates to the localized docs since those are automatically done by Crowdin.