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

Commit

Permalink
Merge pull request #1573 from jneira/hlint-data-docs
Browse files Browse the repository at this point in the history
Mention hlint data file handling in readme
  • Loading branch information
jneira authored Jan 15, 2020
2 parents 92ac896 + 0bbe5b7 commit 3b38880
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
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

0 comments on commit 3b38880

Please sign in to comment.