<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Language.Haskell.HLint</title><link href="ocean.css" rel="stylesheet" type="text/css" title="Ocean" /><script src="haddock-util.js" type="text/javascript"></script><script type="text/javascript">//<![CDATA[
window.onload = function () {pageLoad();setSynopsis("mini_Language-Haskell-HLint.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/Language-Haskell-HLint.html">Source</a></li><li><a href="index.html">Contents</a></li><li><a href="doc-index.html">Index</a></li></ul><p class="caption">hlint-1.8.7: Source code suggestions</p></div><div id="content"><div id="module-header"><p class="caption">Language.Haskell.HLint</p></div><div id="description"><p class="caption">Description</p><div class="doc"><p>This module provides a library interface to HLint. The current
interface is strongly modelled on the command line interface,
and is expected to evolve.
</p></div></div><div id="synopsis"><p id="control.syn" class="caption expander" onclick="toggleSection('syn')">Synopsis</p><ul id="section.syn" class="hide" onclick="toggleSection('syn')"><li class="src short"><a href="#v:hlint">hlint</a> :: [<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a>] -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> [<a href="Language-Haskell-HLint.html#t:Suggestion">Suggestion</a>]</li><li class="src short"><span class="keyword">data</span> <a href="#t:Suggestion">Suggestion</a> </li><li class="src short"><a href="#v:suggestionLocation">suggestionLocation</a> :: <a href="Language-Haskell-HLint.html#t:Suggestion">Suggestion</a> -> <a href="/usr/share/doc/ghc/html/libraries/haskell-src-exts-1.10.2/Language-Haskell-Exts-SrcLoc.html#t:SrcLoc">SrcLoc</a></li><li class="src short"><a href="#v:suggestionSeverity">suggestionSeverity</a> :: <a href="Language-Haskell-HLint.html#t:Suggestion">Suggestion</a> -> <a href="Language-Haskell-HLint.html#t:Severity">Severity</a></li><li class="src short"><span class="keyword">data</span> <a href="#t:Severity">Severity</a> <ul class="subs"><li>= <a href="#v:Ignore">Ignore</a> </li><li>| <a href="#v:Warning">Warning</a> </li><li>| <a href="#v:Error">Error</a> </li></ul></li></ul></div><div id="interface"><h1>Documentation</h1><div class="top"><p class="src"><a name="v:hlint" class="def">hlint</a> :: [<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a>] -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> [<a href="Language-Haskell-HLint.html#t:Suggestion">Suggestion</a>]<a href="src/HLint.html#hlint" class="link">Source</a></p><div class="doc"><p>This function takes a list of command line arguments, and returns the given suggestions.
To see a list of arguments type <code>hlint --help</code> at the console.
This function writes to the stdout/stderr streams, unless <code>--quiet</code> is specified.
</p><p>As an example:
</p><pre> do hints <- hlint ["src", "--ignore=Use map","--quiet"]
when (length hints > 3) $ error "Too many hints!"
</pre></div></div><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:Suggestion" class="def">Suggestion</a> <a href="src/HLint.html#Suggestion" class="link">Source</a></p><div class="doc"><p>A suggestion - the <code>Show</code> instance is of particular use.
</p></div><div class="subs instances"><p id="control.i:Suggestion" class="caption collapser" onclick="toggleSection('i:Suggestion')">Instances</p><div id="section.i:Suggestion" class="show"><table><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Eq.html#t:Eq">Eq</a> <a href="Language-Haskell-HLint.html#t:Suggestion">Suggestion</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Ord.html#t:Ord">Ord</a> <a href="Language-Haskell-HLint.html#t:Suggestion">Suggestion</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Text-Show.html#t:Show">Show</a> <a href="Language-Haskell-HLint.html#t:Suggestion">Suggestion</a></td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><a name="v:suggestionLocation" class="def">suggestionLocation</a> :: <a href="Language-Haskell-HLint.html#t:Suggestion">Suggestion</a> -> <a href="/usr/share/doc/ghc/html/libraries/haskell-src-exts-1.10.2/Language-Haskell-Exts-SrcLoc.html#t:SrcLoc">SrcLoc</a><a href="src/HLint.html#suggestionLocation" class="link">Source</a></p><div class="doc"><p>From a suggestion, extract the file location it refers to.
</p></div></div><div class="top"><p class="src"><a name="v:suggestionSeverity" class="def">suggestionSeverity</a> :: <a href="Language-Haskell-HLint.html#t:Suggestion">Suggestion</a> -> <a href="Language-Haskell-HLint.html#t:Severity">Severity</a><a href="src/HLint.html#suggestionSeverity" class="link">Source</a></p><div class="doc"><p>From a suggestion, determine how severe it is.
</p></div></div><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:Severity" class="def">Severity</a> <a href="src/Settings.html#Severity" class="link">Source</a></p><div class="doc"><p>How severe an error is.
</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:Ignore" class="def">Ignore</a></td><td class="doc"><p>Ignored errors are only returned when <code>--show</code> is passed.
</p></td></tr><tr><td class="src"><a name="v:Warning" class="def">Warning</a></td><td class="doc"><p>Warnings are things that some people may consider improvements, but some may not.
</p></td></tr><tr><td class="src"><a name="v:Error" class="def">Error</a></td><td class="doc"><p>Errors are suggestions that should nearly always be a good idea to apply.
</p></td></tr></table></div><div class="subs instances"><p id="control.i:Severity" class="caption collapser" onclick="toggleSection('i:Severity')">Instances</p><div id="section.i:Severity" class="show"><table><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Prelude.html#t:Bounded">Bounded</a> <a href="Language-Haskell-HLint.html#t:Severity">Severity</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Prelude.html#t:Enum">Enum</a> <a href="Language-Haskell-HLint.html#t:Severity">Severity</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Eq.html#t:Eq">Eq</a> <a href="Language-Haskell-HLint.html#t:Severity">Severity</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Ord.html#t:Ord">Ord</a> <a href="Language-Haskell-HLint.html#t:Severity">Severity</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Text-Read.html#t:Read">Read</a> <a href="Language-Haskell-HLint.html#t:Severity">Severity</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Text-Show.html#t:Show">Show</a> <a href="Language-Haskell-HLint.html#t:Severity">Severity</a></td><td class="doc empty"> </td></tr></table></div></div></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.9.2</p></div></body></html>
