Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Review default emoji format #1247

Closed
3 tasks done
mikelorant opened this issue Jan 15, 2024 · 3 comments · Fixed by #1248
Closed
3 tasks done

Review default emoji format #1247

mikelorant opened this issue Jan 15, 2024 · 3 comments · Fixed by #1248

Comments

@mikelorant
Copy link
Contributor

mikelorant commented Jan 15, 2024

Discussion

There are significant inconsistencies with some Git remote repository providers such as BitBucket when displaying Emoji shortcodes. BitBucket does display shortcodes for the commit title, but not the PR title and list of PRs.

There is also requirement to modify the pager (or other tricks) to allow git log to display correctly.

After investigation it became clear for the reasoning why shortcodes were chosen as the default.

The reason behind this was to be able to use the shortcode to favour the readability on certain terminals that do not support Emojis!
#630 (comment)

While the decision may have been appropriate 8 year ago when gitmoji-cli was first released, it does beg the question, is it worth considering changing the default behaviour now?

Terminals are considerably more advanced on all platforms and the standard Gitmoji set is simple enough that all terminals would display them correctly nowadays. I am at a loss to come up with any other reason to keep the shortcode format as the default.

As someone who has developed their own implementation of gitmoji-cli, I still aim to maintain consistency and so have kept the shortcode format the default for my CLI tool as well. However, I think it may be now worth reviewing this decision and seeing if emoji makes more sense going forward.

Validations

@mikelorant
Copy link
Contributor Author

@carloscuesta Any thoughts on this proposal?

@carloscuesta
Copy link
Owner

Hey!

Thanks for opening the issue 8 years ago already your comment made me feel old 🤣
I think you have a valid point and still while some terminals will not support it people can always change back to the :shortcode: format so looks good to me!

@mikelorant
Copy link
Contributor Author

Pull request #1248 created making this change.

Unit tests pass successfully and deleting my global config and creating a new one with gitmoji -g showed the correct default set.

carloscuesta pushed a commit that referenced this issue Jan 28, 2024
The default emoji format was originally set to `code` for the following
reason:

> The reason behind this was to be able to use the shortcode to favour
> the readability on certain terminals that do not support Emojis!
> @carloscuesta

Terminals are considerably more advanced on all platforms and the
standard Gitmoji set is simple enough that all terminals would display
them correctly nowadays.

This change updates the default format from `code` to `emoji`.

The benefits of this change:

- Improve display of emojis in commit titles, pull request titles and
  list of pull requests on some remote repository providers.

- Removes need to modify the pager to allow `git log` to display
  emojis.

Issue: #1247

Signed-off-by: Michael Lorant <michael.lorant@nine.com.au>
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jan 30, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants