Safe Haskell	None
Language	Haskell2010

Language.Haskell.Stylish

Contents

Run
Steps
- Helpers
Config
Misc

Synopsis

runSteps :: Extensions -> Maybe FilePath -> [Step] -> Lines -> Either String Lines
simpleAlign :: Maybe Int -> Config -> Step
imports :: Maybe Int -> Options -> Step
languagePragmas :: Maybe Int -> Style -> Bool -> Bool -> String -> Step
tabs :: Int -> Step
trailingWhitespace :: Step
unicodeSyntax :: Bool -> String -> Step
findHaskellFiles :: Bool -> [FilePath] -> IO [FilePath]
stepName :: Step -> String
type Extensions = [String]
data Config = Config {
- configSteps :: [Step]
- configColumns :: Maybe Int
- configLanguageExtensions :: [String]
- configNewline :: Newline
- configCabal :: Bool
- configExitCode :: ExitCodeBehavior
}
data ExitCodeBehavior
- = NormalExitBehavior
- | ErrorOnFormatExitBehavior
defaultConfigBytes :: ByteString
configFilePath :: Verbose -> Maybe FilePath -> IO (Maybe FilePath)
loadConfig :: Verbose -> Maybe FilePath -> IO Config
parseConfig :: Value -> Parser Config
type Verbose = String -> IO ()
makeVerbose :: Bool -> Verbose
version :: Version
format :: Maybe ConfigPath -> Maybe FilePath -> String -> IO (Either String Lines)
newtype ConfigPath = ConfigPath {
- unConfigPath :: FilePath
}
type Lines = [String]
data Step

Run

runSteps :: Extensions -> Maybe FilePath -> [Step] -> Lines -> Either String Lines Source #

Steps

simpleAlign Source #

Arguments

:: Maybe Int	Columns
-> Config
-> Step

imports Source #

Arguments

:: Maybe Int	columns
-> Options
-> Step

languagePragmas Source #

Arguments

:: Maybe Int	columns
-> Style
-> Bool	Pad to same length in vertical mode?
-> Bool	remove redundant?
-> String	language prefix
-> Step

tabs Source #

Arguments

:: Int	number of spaces
-> Step

trailingWhitespace :: Step Source #

unicodeSyntax Source #

Arguments

:: Bool	add language pragma?
-> String	language prefix
-> Step

Helpers

findHaskellFiles :: Bool -> [FilePath] -> IO [FilePath] Source #

Searches Haskell source files in any given folder recursively.

stepName :: Step -> String Source #

Config

type Extensions = [String] Source #

data Config Source #

Constructors

Config
Fields configSteps :: [Step] configColumns :: Maybe Int configLanguageExtensions :: [String] configNewline :: Newline configCabal :: Bool configExitCode :: ExitCodeBehavior

Instances

FromJSON Config Source #
Instance details Defined in Language.Haskell.Stylish.Config Methods parseJSON :: Value -> Parser Config # parseJSONList :: Value -> Parser [Config] #

data ExitCodeBehavior Source #

Constructors

NormalExitBehavior
ErrorOnFormatExitBehavior

Instances

Eq ExitCodeBehavior Source #
Instance details Defined in Language.Haskell.Stylish.Config Methods (==) :: ExitCodeBehavior -> ExitCodeBehavior -> Bool # (/=) :: ExitCodeBehavior -> ExitCodeBehavior -> Bool #
Show ExitCodeBehavior Source #
Instance details Defined in Language.Haskell.Stylish.Config Methods showsPrec :: Int -> ExitCodeBehavior -> ShowS # show :: ExitCodeBehavior -> String # showList :: [ExitCodeBehavior] -> ShowS #

defaultConfigBytes :: ByteString Source #

configFilePath :: Verbose -> Maybe FilePath -> IO (Maybe FilePath) Source #

loadConfig :: Verbose -> Maybe FilePath -> IO Config Source #

parseConfig :: Value -> Parser Config Source #

Misc

type Verbose = String -> IO () Source #

makeVerbose :: Bool -> Verbose Source #

version :: Version Source #

format :: Maybe ConfigPath -> Maybe FilePath -> String -> IO (Either String Lines) Source #

Formats given contents optionally using the config provided as first param. The second file path is the location from which the contents were read. If provided, it's going to be printed out in the error message.

newtype ConfigPath Source #

Constructors

ConfigPath
Fields unConfigPath :: FilePath

type Lines = [String] Source #

data Step Source #