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

• cfgSourceType :: !SourceType

  How to parse the input (regular haskell module or Backpack file)

• cfgColorMode :: !ColorMode

  Whether to use colors and other features of ANSI terminals

• 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

Generic (Config region)

Defined in Ormolu.Config

Associated Types

type Rep (Config region) :: Type -> Type

Methods

from :: Config region -> Rep (Config region) x

to :: Rep (Config region) x -> Config region

type Rep (Config region)

Defined in Ormolu.Config

type Rep (Config region) = D1 ('MetaData "Config" "Ormolu.Config" "ormolu-0.4.0.0-ERxks88mRJJ7kMl9nhcGE9" 'False) (C1 ('MetaCons "Config" 'PrefixI 'True) ((S1 ('MetaSel ('Just "cfgDynOptions") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 [DynOption]) :*: (S1 ('MetaSel ('Just "cfgUnsafe") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Bool) :*: S1 ('MetaSel ('Just "cfgDebug") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Bool))) :*: ((S1 ('MetaSel ('Just "cfgCheckIdempotence") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Bool) :*: S1 ('MetaSel ('Just "cfgSourceType") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 SourceType)) :*: (S1 ('MetaSel ('Just "cfgColorMode") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ColorMode) :*: S1 ('MetaSel ('Just "cfgRegion") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 region)))))

data ColorMode

Whether to use colors and other features of ANSI terminals.

Constructors

Never

Always

Auto

Instances

Eq ColorMode

Defined in Ormolu.Terminal

Methods

(==) :: ColorMode -> ColorMode -> Bool

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

Show ColorMode

Defined in Ormolu.Terminal

Methods

showsPrec :: Int -> ColorMode -> ShowS

show :: ColorMode -> String

showList :: [ColorMode] -> 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

data SourceType

Type of sources that can be formatted by Ormolu.

Constructors

ModuleSource

Consider the input as a regular Haskell module

SignatureSource

Consider the input as a Backpack module signature

Instances

Eq SourceType

Defined in Ormolu.Config

Methods

(==) :: SourceType -> SourceType -> Bool

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

Show SourceType

Defined in Ormolu.Config

Methods

showsPrec :: Int -> SourceType -> ShowS

show :: SourceType -> String

showList :: [SourceType] -> 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.