| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
Language.Haskell.HLint3
Description
WARNING: This module represents a previous version of the HLint API. Please use Language.Haskell.HLint4 instead.
Synopsis
- hlint :: [String] -> IO [Idea]
- applyHints :: [Classify] -> Hint -> [(Module SrcSpanInfo, [Comment])] -> [Idea]
- data Idea = Idea {
- ideaModule :: [String]
- ideaDecl :: [String]
- ideaSeverity :: Severity
- ideaHint :: String
- ideaSpan :: SrcSpan
- ideaFrom :: String
- ideaTo :: Maybe String
- ideaNote :: [Note]
- ideaRefactoring :: [Refactoring SrcSpan]
- data Severity
- = Ignore
- | Suggestion
- | Warning
- | Error
- data Note
- data Classify = Classify {}
- getHLintDataDir :: IO FilePath
- autoSettings :: IO (ParseFlags, [Classify], Hint)
- argsSettings :: [String] -> IO (ParseFlags, [Classify], Hint)
- findSettings :: (String -> IO (FilePath, Maybe String)) -> Maybe String -> IO ([Fixity], [Classify], [Either HintBuiltin HintRule])
- readSettingsFile :: Maybe FilePath -> String -> IO (FilePath, Maybe String)
- data HintBuiltin
- data HintRule = HintRule {}
- data Hint = Hint {
- hintModules :: [Setting] -> [(Scope, Module SrcSpanInfo)] -> [Idea]
- hintModule :: [Setting] -> Scope -> Module SrcSpanInfo -> [Idea]
- hintDecl :: [Setting] -> Scope -> Module SrcSpanInfo -> Decl SrcSpanInfo -> [Idea]
- hintComment :: [Setting] -> Comment -> [Idea]
- resolveHints :: [Either HintBuiltin HintRule] -> Hint
- data Scope
- scopeCreate :: Module SrcSpanInfo -> Scope
- scopeMatch :: (Scope, QName S) -> (Scope, QName S) -> Bool
- scopeMove :: (Scope, QName S) -> Scope -> QName S
- parseModuleEx :: ParseFlags -> FilePath -> Maybe String -> IO (Either ParseError (Module SrcSpanInfo, [Comment]))
- defaultParseFlags :: ParseFlags
- parseFlagsAddFixities :: [Fixity] -> ParseFlags -> ParseFlags
- data ParseError = ParseError {}
- data ParseFlags = ParseFlags {}
- data CppFlags
Documentation
hlint :: [String] -> IO [Idea] Source #
This function takes a list of command line arguments, and returns the given hints.
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!"
Warning: The flags provided by HLint are relatively stable, but do not have the same API stability guarantees as the rest of the strongly-typed API. Do not run this function on your server with untrusted input.
applyHints :: [Classify] -> Hint -> [(Module SrcSpanInfo, [Comment])] -> [Idea] Source #
Given a way of classifying results, and a Hint, apply to a set of modules generating a list of Ideas.
The Idea values will be ordered within a file.
Given a set of modules, it may be faster to pass each to applyHints in a singleton list.
When given multiple modules at once this function attempts to find hints between modules,
which is slower and often pointless (by default HLint passes modules singularly, using
--cross to pass all modules together).
Idea data type
An idea suggest by a Hint.
Constructors
| Idea | |
Fields
| |
How severe an issue is.
Constructors
| Ignore | The issue has been explicitly ignored and will usually be hidden (pass |
| Suggestion | Suggestions are things that some people may consider improvements, but some may not. |
| Warning | Warnings are suggestions that are nearly always a good idea to apply. |
| Error | Available as a setting for the user. |
Instances
| Bounded Severity Source # | |
| Enum Severity Source # | |
| Eq Severity Source # | |
| Ord Severity Source # | |
Defined in Config.Type | |
| Read Severity Source # | |
| Show Severity Source # | |
A note describing the impact of the replacement.
Constructors
| IncreasesLaziness | The replacement is increases laziness, for example replacing |
| DecreasesLaziness | The replacement is decreases laziness, for example replacing |
| RemovesError String | The replacement removes errors, for example replacing |
| ValidInstance String String | The replacement assumes standard type class lemmas, a hint with the note |
| RequiresExtension String | The replacement requires this extension to be available. |
| Note String | An arbitrary note. |
Settings
How to classify an Idea. If any matching field is "" then it matches everything.
Constructors
| Classify | |
Fields
| |
getHLintDataDir :: IO FilePath Source #
Get the Cabal configured data directory of HLint.
autoSettings :: IO (ParseFlags, [Classify], Hint) Source #
The function produces a tuple containg ParseFlags (for parseModuleEx),
and Classify and Hint for applyHints.
It approximates the normal HLint configuration steps, roughly:
- Use
findSettingswithreadSettingsFileto find and load the HLint settings files. - Use
parseFlagsAddFixitiesandresolveHintsto transform the outputs offindSettings.
If you want to do anything custom (e.g. using a different data directory, storing intermediate outputs, loading hints from a database) you are expected to copy and paste this function, then change it to your needs.
argsSettings :: [String] -> IO (ParseFlags, [Classify], Hint) Source #
A version of autoSettings which respects some of the arguments supported by HLint.
If arguments unrecognised by HLint are used it will result in an error.
Arguments which have no representation in the return type are silently ignored.
findSettings :: (String -> IO (FilePath, Maybe String)) -> Maybe String -> IO ([Fixity], [Classify], [Either HintBuiltin HintRule]) Source #
Given a function to load a module (typically readSettingsFile), and a module to start from
(defaults to hlint.yaml) find the information from all settings files.
readSettingsFile :: Maybe FilePath -> String -> IO (FilePath, Maybe String) Source #
Given a directory (or Nothing to imply getHLintDataDir), and a module name
(e.g. HLint.Default), find the settings file associated with it, returning the
name of the file, and (optionally) the contents.
This function looks for all settings files starting with HLint. in the directory
argument, and all other files relative to the current directory.
Hints
data HintBuiltin Source #
A list of the builtin hints wired into HLint. This list is likely to grow over time.
Constructors
| HintList | |
| HintListRec | |
| HintMonad | |
| HintLambda | |
| HintBracket | |
| HintNaming | |
| HintPattern | |
| HintImport | |
| HintExport | |
| HintPragma | |
| HintExtensions | |
| HintUnsafe | |
| HintDuplicate | |
| HintRestrict | |
| HintComment | |
| HintNewType | |
| HintSmell |
Instances
A LHS ==> RHS style hint rule.
Constructors
| HintRule | |
Fields
| |
Functions to generate hints, combined using the Monoid instance.
Constructors
| Hint | |
Fields
| |
resolveHints :: [Either HintBuiltin HintRule] -> Hint Source #
Transform a list of HintBuiltin or HintRule into a Hint.
Scopes
Data type representing the modules in scope within a module.
Created with scopeCreate and queried with scopeMatch and scopeMove.
Note that the mempty Scope is not equivalent to scopeCreate on an empty module,
due to the implicit import of Prelude.
scopeCreate :: Module SrcSpanInfo -> Scope Source #
Create a Scope value from a module, based on the modules imports.
scopeMatch :: (Scope, QName S) -> (Scope, QName S) -> Bool Source #
Given a two names in scopes, could they possibly refer to the same thing. This property is reflexive.
scopeMove :: (Scope, QName S) -> Scope -> QName S Source #
Given a name in a scope, and a new scope, create a name for the new scope that will refer to the same thing. If the resulting name is ambiguous, it picks a plausible candidate.
Haskell-src-exts
parseModuleEx :: ParseFlags -> FilePath -> Maybe String -> IO (Either ParseError (Module SrcSpanInfo, [Comment])) Source #
Parse a Haskell module. Applies the C pre processor, and uses
best-guess fixity resolution if there are ambiguities. The
filename - is treated as stdin. Requires some flags (often
defaultParseFlags), the filename, and optionally the contents of
that file. This version uses both hs-src-exts AND ghc-lib.
defaultParseFlags :: ParseFlags Source #
Default value for ParseFlags.
parseFlagsAddFixities :: [Fixity] -> ParseFlags -> ParseFlags Source #
Given some fixities, add them to the existing fixities in ParseFlags.
data ParseError Source #
A parse error.
Constructors
| ParseError | |
Fields
| |
data ParseFlags Source #
Created with defaultParseFlags, used by parseModuleEx.