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

Mention hlint data file handling in readme #1573

Merged
merged 2 commits into from
Jan 15, 2020
Merged

Mention hlint data file handling in readme #1573

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
848f9f0
Mention hlint data file handling
jneira Jan 14, 2020
0bbe5b7
List all possible hlint.yaml locations
jneira Jan 14, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -152,6 +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). 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
Expand Down