aliases: Add new git-omz alias file #1831

NoahGorny · 2021-02-06T20:30:34Z

Description

Adds git-zsh alias file, with aliases copied from ohmyzsh.
Currently there is no simple way of updating the aliases easily, and maybe we need to think about it.

Motivation and Context

Prompted by #1191, this is a re-iteration of #1201.

How Has This Been Tested?

Locally

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 change)

Checklist:

My code follows the code style of this project.
If my change requires a change to the documentation, I have updated the documentation accordingly.
I have read the CONTRIBUTING document.
If I have added a new file, I also added it to clean_files.txt and formatted it using lint_clean_files.sh.
I have added tests to cover my changes, and all the new and existing tests pass.

cornfeedhobo · 2021-02-06T20:57:54Z

Anyone else torn on whether we should use zsh-<whatever> vs <whatever>-zsh?

NoahGorny · 2021-02-06T21:02:44Z

Anyone else torn on whether we should use zsh-<whatever> vs <whatever>-zsh?

I went with git-zsh as I wanted to keep it close to the git alias, it makes more sense this way IMO

NoahGorny · 2021-02-12T10:08:09Z

Hey @bittner, wanna take a look?

bittner · 2021-02-13T13:33:51Z

How will we keep this aligned with the Oh My Zsh project implementation?

In PR #1201 I tried to document a scripted approach. Would it make sense to do something similar here?

NoahGorny · 2021-02-13T14:42:14Z

How will we keep this aligned with the Oh My Zsh project implementation?

In PR #1201 I tried to document a scripted approach. Would it make sense to do something similar here?

This is indeed a problem, as the plugin will not work right out of the box..
Simply seding the file will still not work, as the aliases sometimes use the $(git_current_branch) variable.
We might vendor it, and add a file in init.d vendor directory which explains how to update, and also defines the needed functions. It will be maintained by us, and when we update, we will change the file if necessary.

The workflow might be git-vendor + removing uneeded file + seding the wanted file + adding git-zsh loader that defines the needed functions and load the wanted file

bittner · 2021-02-13T14:58:20Z

How many approvals does a PR need? 🤪

NoahGorny · 2021-02-24T17:08:23Z

How may approvals does a PR need? 🤪

haha, I still need to add some kind of script that updates this completion.. so its not ready yet.
thanks for the CR though @bittner

NoahGorny · 2021-08-03T20:48:00Z

I am also okay with vendoring it as it is right now- and update it once in a while. what do you think @cornfeedhobo @bittner ?

gaelicWizard · 2021-08-13T01:51:02Z

May I suggest that the new alias file be named git-omz? It's providing aliases from Oh My Zsh, not from Zsh itself. Just a nitpick... 😆

NoahGorny · 2021-08-14T08:03:32Z

May I suggest that the new alias file be named git-omz? It's providing aliases from Oh My Zsh, not from Zsh itself. Just a nitpick...

Nice idea- done!

git-vendor-name: ohmyzsh git-vendor-dir: vendor/github.com/ohmyzsh/ohmyzsh git-vendor-repository: https://github.com/ohmyzsh/ohmyzsh.git git-vendor-ref: master

NoahGorny · 2021-09-17T12:02:23Z

Howdy folks!
I have added ohmyzsh as a vendored library using git-vendor with @buhl changes. this will hopefully be easier to maintain, although I still changed some code from the plugin so it will be loaded successfully
let me know what you think @cornfeedhobo @bittner @gaelicWizard

cornfeedhobo · 2021-09-19T17:08:07Z

@NoahGorny I like it. The only question I have remaining is if you are open to the idea of applying patches to vendored libs and what that should look like. I still need to submit a patch to deal with pre-exec's clobbering of ignoreboth and ignorespace, and in the case of this PR, I'd rather not pollute the global namespace with the vaguely named is-at-least function.

gaelicWizard · 2021-09-19T19:49:30Z

The only question I have remaining is if you are open to the idea of applying patches to vendored libs and what that should look like. I still need to submit a patch to deal with pre-exec's clobbering of ignoreboth and ignorespace, and in the case of this PR, I'd rather not pollute the global namespace with the vaguely named is-at-least function.

@cornfeedhobo, I've already submitted a PR upstream for preexec's history shenanigans, based on an existing PR that they had been ignoring. They did accept an unrelated PR for unbound parameters, but no traction on this one yet.

As for weird function names, we can handle that in our loader. I'll give it a go and post it here later tonight.

I'd like to suggest that it's quite valuable to avoid, whenever possible, carrying any patches over vendor'd libs. I like Homebrew's stance on this: only carry patches that are already approved or merged in an upstream dev branch. But, that said, it might not be entirely right for Bash It.

cornfeedhobo · 2021-09-19T19:59:12Z

@gaelicWizard I think you saw my open issue with preexec. They aren't going to budge on this one. We either maintain a fork in our github organization, and patch that way, or figure out a scheme for patching on PR and documenting the diff.

gaelicWizard · 2021-09-19T20:13:25Z

@cornfeedhobo, I did a whole PR which keeps their desired behavior in place, but behaves properly when we change it. My idea was to let them have their way, and then we just set $HISTCONTROL back after we load them.

NoahGorny · 2021-09-20T11:54:43Z

@NoahGorny I like it. The only question I have remaining is if you are open to the idea of applying patches to vendored libs and what that should look like. I still need to submit a patch to deal with pre-exec's clobbering of ignoreboth and ignorespace, and in the case of this PR, I'd rather not pollute the global namespace with the vaguely named is-at-least function.

The problem with patches is that we need to apply them somewhere, probably during installation. We need to think about how we do this and how other places are doing it. Simply having patches around isn't going to cut it sadly. I also think that committing directly into the vendored file like I did isn't great, but it is the simplest solution currently

gaelicWizard · 2022-01-04T05:26:28Z

aliases/available/git.aliases.bash

@@ -2,6 +2,9 @@
 cite 'about-alias'
 about-alias 'common git abbreviations'

+# We can use this variable to make sure that we don't accidentally clash with git-zsh aliases
+_bash_it_git_aliases_enabled=true


Can you use _bash-it-component-item-is-enabled()?

Suggested change

_bash_it_git_aliases_enabled=true

if _bash-it-component-item-is-enabled aliases git-omz; then

_log_warning "The aliases from 'git' and from 'git-omz' conflict with each other; please only enable one."

return 1

fi

gaelicWizard · 2022-01-04T05:27:20Z

test/lib/search.bats

+  assert_line -n 0 -p '      aliases:'
+  for alias in 'git' 'gitsvn' 'git-omz'
+  do
+    echo $alias


Doesn't the echo defeat the test?

gaelicWizard · 2022-01-04T05:27:54Z

aliases/available/git-omz.aliases.bash

@@ -0,0 +1,33 @@
+# shellcheck shell=bash
+cite 'about-alias'


Shouldn't need this cite; "about-alias" is cited in bash_it.sh, so it never needs to be added to the alias files.

gaelicWizard · 2022-01-18T23:16:44Z

aliases/available/git-omz.aliases.bash

+if [[ -n $_bash_it_git_aliases_enabled ]]; then
+	_log_error "git-omz aliases are incompatible with regular git aliases"
+	return
+fi


Suggested change

if [[ -n $_bash_it_git_aliases_enabled ]]; then

_log_error "git-omz aliases are incompatible with regular git aliases"

return

fi

if _bash-it-component-item-is-enabled aliases git; then

_log_warning "git-omz aliases are incompatible with regular git aliases"

return 1

fi

gaelicWizard

I added suggested use of _bash-it-component-item-is-enabled aliases git. I think GitHub just lets you click accept if you like it and it commits it directly to the PR

samtsevich · 2023-05-27T13:42:08Z

Hello all,
Is there any news about merging these changes into master?

bittner · 2023-09-22T15:26:17Z

@NoahGorny Would you have a minute to resolve the conflicts of the PR and merge it, finally?

That would be great! 💯

samtsevich · 2024-03-10T00:30:00Z

Hello again :)
I asked this question a year ago and still would like to see this implementation merged into master.
Is there any chance of seeing this in the near future?

seefood

I think this is close to perfect.
@NoahGorny shall I merge it as is or do you want to give it the last round of improvements per the remarks posted?

NoahGorny force-pushed the add-git-zsh-aliases branch from 3087913 to 90fe8dc Compare February 6, 2021 21:35

bittner approved these changes Feb 13, 2021

View reviewed changes

NoahGorny force-pushed the add-git-zsh-aliases branch from 90fe8dc to e60c29a Compare August 3, 2021 20:47

NoahGorny force-pushed the add-git-zsh-aliases branch from e60c29a to 374f436 Compare August 14, 2021 08:03

NoahGorny changed the title ~~aliases: Add new git-zsh alias file~~ aliases: Add new git-omz alias file Aug 14, 2021

Noah Gorny added 2 commits September 17, 2021 14:45

Add "ohmyzsh" from "https://github.com/ohmyzsh/ohmyzsh.git@master"

9257d6b

git-vendor-name: ohmyzsh git-vendor-dir: vendor/github.com/ohmyzsh/ohmyzsh git-vendor-repository: https://github.com/ohmyzsh/ohmyzsh.git git-vendor-ref: master

vendor: Fix ohmyzsh git plugin so it can be sourced

a25a822

NoahGorny force-pushed the add-git-zsh-aliases branch from 374f436 to 9eceb42 Compare September 17, 2021 11:49

Noah Gorny added 2 commits September 17, 2021 14:59

aliases: Add new git-omz alias file

cf38115

aliases: Do not allow mix of git-omz and git

f7267d3

NoahGorny force-pushed the add-git-zsh-aliases branch from 9eceb42 to f7267d3 Compare September 17, 2021 11:59

NoahGorny requested a review from cornfeedhobo September 19, 2021 05:00

gaelicWizard requested changes Jan 4, 2022

View reviewed changes

gaelicWizard mentioned this pull request Jan 8, 2022

Align Git short aliases with Oh My Zsh #1191

Open

gaelicWizard reviewed Jan 18, 2022

View reviewed changes

gaelicWizard requested changes Jan 18, 2022

View reviewed changes

seefood added seems abandoned rattle the cage, and close if nobody wants to keep it going waiting-for-response labels Nov 7, 2024

seefood approved these changes Nov 7, 2024

View reviewed changes

Merge branch 'master' into add-git-zsh-aliases

eedf9c8

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

aliases: Add new git-omz alias file #1831

aliases: Add new git-omz alias file #1831

NoahGorny commented Feb 6, 2021

cornfeedhobo commented Feb 6, 2021

NoahGorny commented Feb 6, 2021

NoahGorny commented Feb 12, 2021

bittner commented Feb 13, 2021

NoahGorny commented Feb 13, 2021

bittner commented Feb 13, 2021 •

edited

Loading

NoahGorny commented Feb 24, 2021

NoahGorny commented Aug 3, 2021

gaelicWizard commented Aug 13, 2021

NoahGorny commented Aug 14, 2021

NoahGorny commented Sep 17, 2021

cornfeedhobo commented Sep 19, 2021 •

edited

Loading

gaelicWizard commented Sep 19, 2021 •

edited

Loading

cornfeedhobo commented Sep 19, 2021 •

edited

Loading

gaelicWizard commented Sep 19, 2021

NoahGorny commented Sep 20, 2021

gaelicWizard Jan 4, 2022 •

edited

Loading

gaelicWizard Jan 4, 2022

gaelicWizard Jan 4, 2022 •

edited

Loading

gaelicWizard Jan 18, 2022

gaelicWizard left a comment •

edited

Loading

samtsevich commented May 27, 2023

bittner commented Sep 22, 2023

samtsevich commented Mar 10, 2024

seefood left a comment

-_bash_it_git_aliases_enabled=true
+if _bash-it-component-item-is-enabled aliases git-omz; then
+    _log_warning "The aliases from 'git' and from 'git-omz' conflict with each other; please only enable one."
+    return 1
+fi

aliases: Add new git-omz alias file #1831

Are you sure you want to change the base?

aliases: Add new git-omz alias file #1831

Conversation

NoahGorny commented Feb 6, 2021

Description

Motivation and Context

How Has This Been Tested?

Types of changes

Checklist:

cornfeedhobo commented Feb 6, 2021

NoahGorny commented Feb 6, 2021

NoahGorny commented Feb 12, 2021

bittner commented Feb 13, 2021

NoahGorny commented Feb 13, 2021

bittner commented Feb 13, 2021 • edited Loading

NoahGorny commented Feb 24, 2021

NoahGorny commented Aug 3, 2021

gaelicWizard commented Aug 13, 2021

NoahGorny commented Aug 14, 2021

NoahGorny commented Sep 17, 2021

cornfeedhobo commented Sep 19, 2021 • edited Loading

gaelicWizard commented Sep 19, 2021 • edited Loading

cornfeedhobo commented Sep 19, 2021 • edited Loading

gaelicWizard commented Sep 19, 2021

NoahGorny commented Sep 20, 2021

gaelicWizard Jan 4, 2022 • edited Loading

Choose a reason for hiding this comment

gaelicWizard Jan 4, 2022

Choose a reason for hiding this comment

gaelicWizard Jan 4, 2022 • edited Loading

Choose a reason for hiding this comment

gaelicWizard Jan 18, 2022

Choose a reason for hiding this comment

gaelicWizard left a comment • edited Loading

Choose a reason for hiding this comment

samtsevich commented May 27, 2023

bittner commented Sep 22, 2023

samtsevich commented Mar 10, 2024

seefood left a comment

Choose a reason for hiding this comment

bittner commented Feb 13, 2021 •

edited

Loading

cornfeedhobo commented Sep 19, 2021 •

edited

Loading

gaelicWizard commented Sep 19, 2021 •

edited

Loading

cornfeedhobo commented Sep 19, 2021 •

edited

Loading

gaelicWizard Jan 4, 2022 •

edited

Loading

gaelicWizard Jan 4, 2022 •

edited

Loading

gaelicWizard left a comment •

edited

Loading