Skip to content
This repository was archived by the owner on Oct 7, 2020. It is now read-only.

Commit 0bbe5b7

Browse files
committed
List all possible hlint.yaml locations
1 parent 848f9f0 commit 0bbe5b7

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,10 @@ HIE builds from source code, so there's a couple of extra steps.
152152
* `stack` must be in your PATH
153153
* `git` must be in your PATH
154154
* Stack local bin directory must be in your PATH. Get it with `stack path --local-bin`
155-
* 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.
155+
* 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:
156+
* In the directory pointed by the environment variable `$HLINT_DATADIR`.
157+
* If hie was installed using stack or cabal, in a tool-specific internal installation directory.
158+
* And finally in a subdirectory named `data` inside the directory where the `hie` executable is.
156159

157160
Tip: you can quickly check if some command is in your path by running the command.
158161
If you receive some meaningful output instead of "command not found"-like message

0 commit comments

Comments
 (0)