refactor(aliases): sort by georgettica · Pull Request #1743 · Bash-it/bash-it

georgettica · 2020-12-16T14:45:27Z

move all comments to the same line so they wont be jumbled

georgettica · 2020-12-16T14:45:40Z

related to #1732

georgettica · 2020-12-16T15:21:51Z

now it's partially related to #1696

davidpfarrell · 2020-12-16T17:17:38Z

Greetings!

A straight sort is useful, but I'm inclined to think that grouping by sub-command or maybe related actions has value too:

#
# Adding
#
alias ga* ...
...

# 
# Branching
# 
alias gb* ...
...

# 
# Committing
# 
alias gc* ...
...

The alias file serves as its own documentation, as there's (currently) no other way to know what aliases an alias file introduces, nor to get detailed info on a specific alias, other than to look inside the alias file itself.

To that end, I think we should have some kind of goal for alias files to read well.

georgettica · 2020-12-16T17:27:37Z

It was just very hard to sort with the comments sparsed that way.
I thought maybe we could give it. A try this way but can put comments back if you want.

Or if you have a good sorting technique that keeps comments bear them I would be glad to hear about it

davidpfarrell · 2020-12-23T19:24:38Z

Hi again,

It was just very hard to sort with the comments sparsed that way.
I thought maybe we could give it. A try this way but can put comments back if you want.

My comment wasn't related to the idea of moving alias doc-comments to a single line - It was related the idea of blindly sorting sorting the aliases in general. (I understand that, when moving these around en-mass, moving the alias comments to the same line makes it easier to keep them with their associated alias)

I think that, if we're going to re-arrange the aliases, we should have a better goal than just plainly sorting them.

Organizing them by some common feature/function makes more sense to me. THIS is what I referring to in my comment.
NOTE: This may result in aliases not ending up in precisely sorted order, which is OK.

Additionally, I think you may have added too many changes to this PR, ie changes to the following files:

containerized_lint.sh
install.sh
testing.Dockerfile

These changes don't really ave anything to do with the git aliases themselves.

They seem useful, but they should be part of a separate, stand-alone PR and not part of this one. I recommend moving them into a separate, new PR so we can discuss them (and possibly merge them) regardless of what happens here in this PR.

-DF

NoahGorny · 2020-12-23T21:16:40Z

@georgettica I agree with @davidpfarrell

Move the docker commit to a separate PR and remove it and the auto-reload one from this PR, and then we can continue with this one.

Great job by the way! Keep up the good work 😄

georgettica · 2020-12-23T23:21:53Z

That sounds great!
A. I am glad you are onboard.
B. I will sort based on what you wanted @davidpfarrell
C. I will split into multiple pieces

related to Bash-it#1743

georgettica · 2020-12-27T16:55:28Z

diverged dockerfile and linting into #1753
removed duplication from here, and tried to fix comments as was requested, please tell me if it looks ok now

NoahGorny · 2020-12-27T17:30:18Z

nice work @georgettica!

I think that what you did with the git stash and git switch aliases is the way we should do it. The actual order does not have to be alphabetical- but rather sorted by command- git add, git branch, git commit, etc...

Lemme know what you think!

georgettica · 2020-12-27T17:47:19Z

I am fine with that :)

NoahGorny · 2021-01-07T17:47:40Z

any updates @georgettica ?

georgettica · 2021-01-07T20:38:18Z

You want more sections? Or is that enough

NoahGorny · 2021-01-07T21:59:12Z

I want to do this all in this PR, so we can make sure the file will stay sorted after your PR. If you can finish this up with sections as I said it would be amazing!

georgettica · 2021-01-08T06:02:42Z

Now that I know, I'll do that

NoahGorny · 2021-01-08T22:50:29Z

hey @georgettica, I updated your PR with a rebase on master and some changes, you are welcome to look at my addition (c3a01db) and see if you like it

@cornfeedhobo @davidpfarrell @nwinkler @tbhaxor
can one of you CR this as I also made some changes myself?

georgettica

Thanks @NoahGorny fixing as you see fit, it really pushes this PR to conclusion I think.

For me it looks ok (though I can't approve)

NoahGorny · 2021-01-09T18:50:07Z

@cornfeedhobo wanna take a look?

davidpfarrell

I think the new organization strategy looks good!

I spent some time comparing the old and new versions of the file to confirm that every alias was covered. Everything appears to be there.

Best I can tell, this is good to go - thanks for the effort !

davidpfarrell · 2021-01-10T01:40:08Z

As a side note : We may need to adopt a more nuanced policy regarding quotes used for alias definitions ... The "Always use ' " policy feels a little stifling

- move all comments to the same line so they wont be jumbled - also add to clean_files.txt

NoahGorny

Rebased again, and merging as @davidpfarrell approved.
Thank you guys for the effort you put in @georgettica @davidpfarrell ! You rock!

georgettica · 2021-01-13T17:45:42Z

Thanks for helping aswell @NoahGorny

georgettica force-pushed the georgettica/sort-git-aliases branch from 83d4745 to eb5d222 Compare December 16, 2020 14:57

georgettica added a commit to georgettica/bash-it that referenced this pull request Dec 27, 2020

feat(lint): make testing lint easier

44b9941

related to Bash-it#1743

georgettica mentioned this pull request Dec 27, 2020

feat(lint): make testing lint easier #1753

Closed

georgettica force-pushed the georgettica/sort-git-aliases branch 2 times, most recently from e5234f5 to 4a9e342 Compare December 27, 2020 16:48

NoahGorny force-pushed the georgettica/sort-git-aliases branch 2 times, most recently from 0534601 to c3a01db Compare January 8, 2021 22:49

georgettica commented Jan 9, 2021

View reviewed changes

davidpfarrell approved these changes Jan 10, 2021

View reviewed changes

georgettica and others added 3 commits January 13, 2021 18:24

refactor(aliases): sort git aliases file and lint it

436381d

- move all comments to the same line so they wont be jumbled - also add to clean_files.txt

aliases: git: Sort all commands, even miniscule ones

8723fc5

aliases: git: Add shellcheck header

dd4e410

NoahGorny force-pushed the georgettica/sort-git-aliases branch from 805477a to dd4e410 Compare January 13, 2021 16:25

NoahGorny approved these changes Jan 13, 2021

View reviewed changes

NoahGorny enabled auto-merge January 13, 2021 16:26

NoahGorny merged commit bac5041 into Bash-it:master Jan 13, 2021

NoahGorny mentioned this pull request Jan 13, 2021

Added git alias to list only conflicted files #1733

Merged

georgettica deleted the georgettica/sort-git-aliases branch January 13, 2021 17:45

Conversation

georgettica commented Dec 16, 2020

Uh oh!

georgettica commented Dec 16, 2020

Uh oh!

georgettica commented Dec 16, 2020

Uh oh!

davidpfarrell commented Dec 16, 2020

Uh oh!

georgettica commented Dec 16, 2020

Uh oh!

davidpfarrell commented Dec 23, 2020

Uh oh!

NoahGorny commented Dec 23, 2020

Uh oh!

georgettica commented Dec 23, 2020

Uh oh!

georgettica commented Dec 27, 2020

Uh oh!

NoahGorny commented Dec 27, 2020

Uh oh!

georgettica commented Dec 27, 2020

Uh oh!

NoahGorny commented Jan 7, 2021

Uh oh!

georgettica commented Jan 7, 2021

Uh oh!

NoahGorny commented Jan 7, 2021

Uh oh!

georgettica commented Jan 8, 2021

Uh oh!

NoahGorny commented Jan 8, 2021

Uh oh!

georgettica left a comment

Choose a reason for hiding this comment

Uh oh!

NoahGorny commented Jan 9, 2021

Uh oh!

davidpfarrell left a comment

Choose a reason for hiding this comment

Uh oh!

davidpfarrell commented Jan 10, 2021

Uh oh!

NoahGorny left a comment

Choose a reason for hiding this comment

Uh oh!

georgettica commented Jan 13, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants