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

Consider a different name for the hie.yaml file #248

Open
ndmitchell opened this issue Sep 12, 2020 · 9 comments
Open

Consider a different name for the hie.yaml file #248

ndmitchell opened this issue Sep 12, 2020 · 9 comments

Comments

@ndmitchell
Copy link
Contributor

The current hie.yaml is an abbreviation for Haskell IDE Engine. That's meaningless to most people, and no longer represents the IDE we recommend. A name like haskell-ide.yaml would make it clearer to users who encounter a file what that file was doing.

I don't imagine migration will be too hard - we can search for both filenames.

@fendor
Copy link
Collaborator

fendor commented Sep 12, 2020

I don't feel strongly about this. I am fine with either.

@ndmitchell
Copy link
Contributor Author

Would be good to get some other opinions, e.g. @pepeiborra @alanz

@alanz
Copy link

alanz commented Sep 12, 2020

I am happy with this idea.

@pepeiborra
Copy link
Contributor

+1 This is a great idea

@jneira
Copy link
Member

jneira commented Sep 13, 2020

i like short names if possible, and it seems to me that haskell ide engine is generic enough to survive the outdated impl.
But I am not strongly against so if you like it, go ahead.

@michaelpj
Copy link
Contributor

A name like haskell-ide.yaml would make it clearer to users who encounter a file what that file was doing.

That suggests to me that it configures the "whole IDE". But it doesn't - it configures specifically the part where it figures out how to build my project. If, say, we added some unrelated persistent settings for HLS (that weren't covered by LSP configuration), then where would we put them? Certainly we can't put them in the file hie-bios reads, so it would have to go somewhere else. So it's more like haskell-project-build-info.yaml.

Perhaps HLS should have haskell-language-server.yaml, which contains a sub-stanza that it could pass to hie-bios directly when it invokes it, rather than hie-bios having a separate configuration file. Then we really could have a config file for "everything HLS".

@ndmitchell
Copy link
Contributor Author

Perhaps HLS should have haskell-language-server.yaml, which contains a sub-stanza that it could pass to hie-bios directly

I like that. It also seems more reasonable for HLS to know where configuration files etc live, rather than hie-bios to go hunting around. E.g. HLS might decide not to descend up past the current workspace directory.

@Avi-D-coder
Copy link
Contributor

Perhaps HLS should have haskell-language-server.yaml, which contains a sub-stanza that it could pass to hie-bios directly

I would very much like to avoid this. If cradle info is mixed in with other configs, gen-hie will have to only modify the relevant section, and try to respect formatting. A separate hie-bios config file (whatever it's called), makes my life much simpler.

@jneira
Copy link
Member

jneira commented Sep 22, 2020

Another argument to not move the config is imho that config will (and should) be removed, when the build tools give enough info to hie-bios to not make users duplicate the build info in two config files (.cabal and hie.yaml/whatever other config file).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

7 participants