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

Mismatch of names of the binary and package #479

Open
yegor256 opened this issue Aug 30, 2024 · 3 comments · May be fixed by #494
Open

Mismatch of names of the binary and package #479

yegor256 opened this issue Aug 30, 2024 · 3 comments · May be fixed by #494
Labels
(ci) Related to CI (cli) Related to the normalizer command-line interface (eo pipeline) Related to the CI pipeline with the EO compiler (normalizer) Related to the normalizer application (site) Related to the site

Comments

@yegor256
Copy link
Member

I'm doing this:

stack install --resolver lts-22.16 eo-phi-normalizer

I expect to have eo-phi-normalizer to be installed. However, I'm getting this file:

~/.local/bin/normalizer

Would be good to renamed it to eo-phi-normalizer, I believe.

@yegor256
Copy link
Member Author

@deemp please, pay attention

@deemp
Copy link
Member

deemp commented Aug 30, 2024

@yegor256 Haskell packages may expose multiple executables. Hence, it's not mandatory to use the same name for a package and an executable exposed by that package.

I prefer the name normalizer because it implies less typing.

However, this name is also used for the charset_normalizer executable that was installed on my machine, and one of my teammates was confused about getting a message from that executable after running normalizer --help.

I expect to have eo-phi-normalizer to be installed.

Please explain why you expected an executable with this name to be installed. Perhaps we need to improve our documentation on Installation (link).

@yegor256
Copy link
Member Author

@deemp it seems reasonable to install XYZ and then run XYZ. Just easier to remember. I also have the same collision of names on my machine with charset_normalizer -- this situation makes it impossible to run normalizer (I have to call it using full path, thus more typing, not less)

@deemp deemp added (normalizer) Related to the normalizer application (ci) Related to CI (site) Related to the site (eo pipeline) Related to the CI pipeline with the EO compiler (cli) Related to the normalizer command-line interface labels Sep 4, 2024
@deemp deemp linked a pull request Sep 16, 2024 that will close this issue
@deemp deemp linked a pull request Sep 16, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
(ci) Related to CI (cli) Related to the normalizer command-line interface (eo pipeline) Related to the CI pipeline with the EO compiler (normalizer) Related to the normalizer application (site) Related to the site
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants