Safe Haskell	Safe-Inferred
Language	Haskell2010

HIndent

Contents

The entry point.
Formatting functions.
Config
Extension
Error
Testing

Description

Haskell indenter.

Synopsis

hindent :: [String] -> IO ()
reformat :: Config -> [Extension] -> Maybe FilePath -> ByteString -> Either ParseError ByteString
data Config = Config {
- configMaxColumns :: !Int64
- configIndentSpaces :: !Int64
- configTrailingNewline :: !Bool
- configSortImports :: !Bool
- configLineBreaks :: [String]
- configExtensions :: [Extension]
}
defaultConfig :: Config
getConfig :: IO Config
data Extension
- = EnableExtension Extension
- | DisableExtension Extension
data ParseError = ParseError {
- errorLine :: Int
- errorCol :: Int
- errorFile :: FilePath
}
prettyParseError :: ParseError -> String
testAst :: ByteString -> Either ParseError HsModule'
type HsModule' = HsModule GhcPs

The entry point.

hindent :: [String] -> IO () Source #

Runs HIndent with the given commandline options.

Formatting functions.

reformat :: Config -> [Extension] -> Maybe FilePath -> ByteString -> Either ParseError ByteString Source #

Format the given source.

Config

data Config Source #

Configurations shared among the different styles. Styles may pay attention to or completely disregard this configuration.

Constructors

Config
Fields configMaxColumns :: !Int64 Maximum columns to fit code into ideally. configIndentSpaces :: !Int64 How many spaces to indent? configTrailingNewline :: !Bool End with a newline. configSortImports :: !Bool Sort imports in groups. configLineBreaks :: [String] Break line when meets these operators. configExtensions :: [Extension] Extra language extensions enabled by default.

Instances

Instances details

FromJSON Config Source #
Instance details Defined in HIndent.Config Methods parseJSON :: Value -> Parser Config # parseJSONList :: Value -> Parser [Config] # omittedField :: Maybe Config #

defaultConfig :: Config Source #

Default style configuration.

getConfig :: IO Config Source #

Read config from a config file, or return defaultConfig.

Extension

data Extension Source #

Language Extension. Either enabled or disabled.

The Cabal package also has an Extension type that can be used to indicate whether an extension is enabled or disabled, but Cabal's one should be avoided as much as possible. The KnownExtension of Cabal may not have the latest extensions, and if such extensions are used, there will be cases where GHC can build, but HIndent cannot format.

Constructors

EnableExtension Extension
DisableExtension Extension

Instances

Instances details

Eq Extension Source #
Instance details Defined in HIndent.LanguageExtension.Types Methods (==) :: Extension -> Extension -> Bool # (/=) :: Extension -> Extension -> Bool #

Error

data ParseError Source #

Parse error type with the location.

Constructors

ParseError
Fields errorLine :: Int The row of the parse error's location. errorCol :: Int The column of the parse error's location. errorFile :: FilePath The filename HIndent failed to parse.

Instances

Instances details

Read ParseError Source #
Instance details Defined in HIndent.Error Methods readsPrec :: Int -> ReadS ParseError # readList :: ReadS [ParseError] # readPrec :: ReadPrec ParseError # readListPrec :: ReadPrec [ParseError] #
Show ParseError Source #
Instance details Defined in HIndent.Error Methods showsPrec :: Int -> ParseError -> ShowS # show :: ParseError -> String # showList :: [ParseError] -> ShowS #
Eq ParseError Source #
Instance details Defined in HIndent.Error Methods (==) :: ParseError -> ParseError -> Bool # (/=) :: ParseError -> ParseError -> Bool #
Ord ParseError Source #
Instance details Defined in HIndent.Error Methods compare :: ParseError -> ParseError -> Ordering # (<) :: ParseError -> ParseError -> Bool # (<=) :: ParseError -> ParseError -> Bool # (>) :: ParseError -> ParseError -> Bool # (>=) :: ParseError -> ParseError -> Bool # max :: ParseError -> ParseError -> ParseError # min :: ParseError -> ParseError -> ParseError #

prettyParseError :: ParseError -> String Source #

Pretty-print ParseError.

Testing

testAst :: ByteString -> Either ParseError HsModule' Source #

Generate an AST from the given module for debugging.

type HsModule' = HsModule GhcPs Source #

The wrapper for HsModule