Alias "list" to "ls" - Githubissues

andsens / homeshick

git dotfiles synchronizer written in bash

MIT License

2.07k stars 147 forks source link

Alias "list" to "ls" #199

Closed johnmaguire closed 3 years ago

johnmaguire commented 3 years ago

First of all, thanks - homeshick is great software.

I frequently try to list the available castles using homeshick ls instead of homeshick list. I fixed this in my own .zshrc but figured this might be a common typo, so I implemented it in homeshick.

Figured I'd see if this change is welcome.

andsens commented 3 years ago

Fine by me! Could you send the PR to the development branch instead? Also, I would think the helptext would need some expansion. here and here.

johnmaguire commented 3 years ago

@andsens I think I got all the help text spots and pointed it at the development branch correctly.

Two thoughts:

Originally, I duplicated the list completion for ls in the fish autocomplete file. Looking closer, none of the other aliases have completions for fish, so I left it out this time. Let me know if you'd like it added back in.
Not sure if there is any test coverage you care for. I'm not familiar with bats, but can try to whip something up if you had something in mind.

andsens commented 3 years ago

Looks good to me! Merging.

It's good that you left out the autocompletion. That's not really where aliases belong. With ls you'll just get a prompt when completion from l, even though it's unambiguous which command you mean. Whether you complete to ls or list doesn't really matter, so there's no reason to prompt the user for a disambiguation.

Regarding the testing I think it's fine. It's green across the board, so I don't think you have broken anything, the change is trivial enough to skip this part.