| hlint-1.8.3: Source code suggestions | Contents | Index

Language.Haskell.HLint

Description
This module provides a library interface to HLint. The current interface is strongly modelled on the command line interface, and is expected to evolve.
Synopsis

hlint :: [String] -> IO [Suggestion]
data Suggestion
suggestionLocation :: Suggestion -> SrcLoc

Documentation
hlint :: [String] -> IO [Suggestion]

This function takes a list of command line arguments, and returns the given suggestions. To see a list of arguments type `hlint --help` at the console. This function writes to the stdout/stderr streams, unless `--quiet` is specified.

As an example:

     do hints <- hlint ["src", "--ignore=Use map","--quiet"]
        when (length hints > 3) $ error "Too many hints!"

data Suggestion

A suggestion - the `Show` instance is of particular use.
Instances

Eq Suggestion |
Ord Suggestion |
Show Suggestion |

suggestionLocation :: Suggestion -> SrcLoc
From a suggestion, extract the file location it refers to.
Produced by Haddock version 2.7.2