Ormolu.Config

Configuration options used by the tool.

Documentation

data Config region

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

Instances

Functor Config

Defined in Ormolu.Config

Methods

fmap :: (a -> b) -> Config a -> Config b

(<$) :: a -> Config b -> Config a

Eq region => Eq (Config region)

Defined in Ormolu.Config

Methods

(==) :: Config region -> Config region -> Bool

(/=) :: Config region -> Config region -> Bool

Show region => Show (Config region)

Defined in Ormolu.Config

Methods

showsPrec :: Int -> Config region -> ShowS

show :: Config region -> String

showList :: [Config region] -> ShowS

data RegionIndices

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

Eq RegionIndices

Defined in Ormolu.Config

Methods

(==) :: RegionIndices -> RegionIndices -> Bool

(/=) :: RegionIndices -> RegionIndices -> Bool

Show RegionIndices

Defined in Ormolu.Config

Methods

showsPrec :: Int -> RegionIndices -> ShowS

show :: RegionIndices -> String

showList :: [RegionIndices] -> ShowS

data RegionDeltas

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

Eq RegionDeltas

Defined in Ormolu.Config

Methods

(==) :: RegionDeltas -> RegionDeltas -> Bool

(/=) :: RegionDeltas -> RegionDeltas -> Bool

Show RegionDeltas

Defined in Ormolu.Config

Methods

showsPrec :: Int -> RegionDeltas -> ShowS

show :: RegionDeltas -> String

showList :: [RegionDeltas] -> ShowS

defaultConfig :: Config RegionIndices

Default Config RegionIndices.

regionIndicesToDeltas

Arguments

:: Int

Total number of lines in the input

-> RegionIndices

Region indices

-> RegionDeltas

Region deltas

Convert RegionIndices into RegionDeltas.

newtype DynOption

A wrapper for dynamic options.

Constructors

DynOption

Fields

• unDynOption :: String

Instances

Eq DynOption

Defined in Ormolu.Config

Methods

(==) :: DynOption -> DynOption -> Bool

(/=) :: DynOption -> DynOption -> Bool

Ord DynOption

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

Defined in Ormolu.Config

Methods

showsPrec :: Int -> DynOption -> ShowS

show :: DynOption -> String

showList :: [DynOption] -> ShowS

dynOptionToLocatedStr :: DynOption -> Located String

Convert DynOption to Located String.