Safe Haskell	None
Language	Haskell2010

Ormolu.Config

Description

Configuration options used by the tool.

Synopsis

data Config region = Config {
- cfgDynOptions :: ![DynOption]
- cfgUnsafe :: !Bool
- cfgDebug :: !Bool
- cfgCheckIdempotence :: !Bool
- cfgRegion :: !region
- cfgPrinterOpts :: PrinterOpts
}
data RegionIndices = RegionIndices {
- regionStartLine :: !(Maybe Int)
- regionEndLine :: !(Maybe Int)
}
data RegionDeltas = RegionDeltas {
- regionPrefixLength :: !Int
- regionSuffixLength :: !Int
}
defaultConfig :: Config RegionIndices
data PrinterOpts = PrinterOpts {
- poIndentStep :: Int
}
defaultPrinterOpts :: PrinterOpts
loadConfigFile :: Bool -> Maybe FilePath -> PrinterOpts -> IO PrinterOpts
regionIndicesToDeltas :: Int -> RegionIndices -> RegionDeltas
newtype DynOption = DynOption {
- unDynOption :: String
}
dynOptionToLocatedStr :: DynOption -> Located String

Documentation

data Config region Source #

Ormolu configuration.

Constructors

Config
Fields cfgDynOptions :: ![DynOption] Dynamic options to pass to GHC parser cfgUnsafe :: !Bool Do formatting faster but without automatic detection of defects cfgDebug :: !Bool Output information useful for debugging cfgCheckIdempotence :: !Bool Checks if re-formatting the result is idempotent cfgRegion :: !region Region selection cfgPrinterOpts :: PrinterOpts

Instances

Instances details

Functor Config Source #
Instance details Defined in Ormolu.Config Methods fmap :: (a -> b) -> Config a -> Config b # (<$) :: a -> Config b -> Config a #
Eq region => Eq (Config region) Source #
Instance details Defined in Ormolu.Config Methods (==) :: Config region -> Config region -> Bool # (/=) :: Config region -> Config region -> Bool #
Show region => Show (Config region) Source #
Instance details Defined in Ormolu.Config Methods showsPrec :: Int -> Config region -> ShowS # show :: Config region -> String # showList :: [Config region] -> ShowS #

data RegionIndices Source #

Region selection as the combination of start and end line numbers.

Constructors

RegionIndices
Fields regionStartLine :: !(Maybe Int) Start line of the region to format regionEndLine :: !(Maybe Int) End line of the region to format

Instances

Instances details

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

data RegionDeltas Source #

Region selection as the length of the literal prefix and the literal suffix.

Constructors

RegionDeltas
Fields regionPrefixLength :: !Int Prefix length in number of lines regionSuffixLength :: !Int Suffix length in number of lines

Instances

Instances details

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

defaultConfig :: Config RegionIndices Source #

Default Config RegionIndices.

data PrinterOpts Source #

Options controlling formatting output

Constructors

PrinterOpts
Fields poIndentStep :: Int Number of spaces to use for indentation

Instances

Instances details

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

defaultPrinterOpts :: PrinterOpts Source #

loadConfigFile :: Bool -> Maybe FilePath -> PrinterOpts -> IO PrinterOpts Source #

Replace fields with those from a config file, if found. Looks recursively in parent folders, then in XdgConfig, for a file matching fourmolu.yaml'.

regionIndicesToDeltas Source #

Arguments

:: Int	Total number of lines in the input
-> RegionIndices	Region indices
-> RegionDeltas	Region deltas

Convert RegionIndices into RegionDeltas.

newtype DynOption Source #

A wrapper for dynamic options.

Constructors

DynOption
Fields unDynOption :: String

Instances

Instances details

Eq DynOption Source #
Instance details Defined in Ormolu.Config Methods (==) :: DynOption -> DynOption -> Bool # (/=) :: DynOption -> DynOption -> Bool #
Ord DynOption Source #
Instance details Defined in Ormolu.Config Methods compare :: DynOption -> DynOption -> Ordering # (<) :: DynOption -> DynOption -> Bool # (<=) :: DynOption -> DynOption -> Bool # (>) :: DynOption -> DynOption -> Bool # (>=) :: DynOption -> DynOption -> Bool # max :: DynOption -> DynOption -> DynOption # min :: DynOption -> DynOption -> DynOption #
Show DynOption Source #
Instance details Defined in Ormolu.Config Methods showsPrec :: Int -> DynOption -> ShowS # show :: DynOption -> String # showList :: [DynOption] -> ShowS #

dynOptionToLocatedStr :: DynOption -> Located String Source #

Convert DynOption to Located String.