haskell/haskell-ide-engine
1
1
Fork 0
mirror of https://github.com/haskell/haskell-ide-engine.git synced 2024-09-11 11:05:30 +03:00
Code Issues Projects Releases Wiki Activity

List all possible hlint.yaml locations

Browse Source
This commit is contained in:
jneira 2020-01-14 13:15:05 +01:00
parent 848f9f095f
commit 0bbe5b78cb
1 changed files with 4 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
README.md
View File

@ -152,7 +152,10 @@ HIE builds from source code, so there's a couple of extra steps.
* `stack` must be in your PATH
* `git` must be in your PATH
* Stack local bin directory must be in your PATH. Get it with `stack path --local-bin`
* To make hlint suggestions work, `hie` must locate the [hlint configuration yaml file](https://raw.githubusercontent.com/ndmitchell/hlint/master/data/hlint.yaml). As last resort it will look for it in a subdirectory named `data` in the same directory where the `hie` executable is.
* To make hlint suggestions work, `hie` must locate the [hlint configuration yaml file](https://raw.githubusercontent.com/ndmitchell/hlint/master/data/hlint.yaml). The file is searched in order in the following locations:
* In the directory pointed by the environment variable `$HLINT_DATADIR`.
* If hie was installed using stack or cabal, in a tool-specific internal installation directory.
* And finally in a subdirectory named `data` inside the directory where the `hie` executable is.
Tip: you can quickly check if some command is in your path by running the command.
If you receive some meaningful output instead of "command not found"-like message