Skip to content

Please consider renaming the executable #16

@rbq

Description

@rbq

Hi, you chose an abbreviated name for the executable that differs from the Gem name to anticipate a heavy users will to set up a congruent alias. I believe that's a bad idea for the following reasons:

  • One or two letter names are often set up by users as an alias for stuff they use regularly. In my case the tm alias is the shortcut for "open with TextMate or open the current directory if no file name given" for years. I was quite surprised that this alias was broken when I installed a Gem that is not even called "tm". I don't see an easy way to keep my existing alias and add another one (like "ticket" or "ticketmaster") other than forking and keeping a local checkout (or remove/rename the executable after each update).
  • Users may not want to use tm as their alias. I myself don't use the executable atm, but if I did on a daily basis, I'd probably end up creating even shorter aliases like ta to add and tl to list tickets. For everything else I'd probably prefer entering tick[tab].
  • It's plain confusing if a Gem "a" provides an executable "b". I think people who use the executable infrequently are likely to forget that, enter ticket[tab] and wonder why there isn't a binary available. The other way around you may discover a "tm" executable sitting in your Rubygems bin directory but gem list tm only mentions "tmail". Imho consistency should take priority over (assumed) ease of access.

Would love to hear other opinions. Is it just me or is naming executables after the Gem considered best practice?

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions