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

• cfgPrinterOpts :: !PrinterOptsTotal

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" "fourmolu-0.6.0.0-LhRbNevHLirDIg2fiACsm0" '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) :*: S1 ('MetaSel ('Just "cfgPrinterOpts") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 PrinterOptsTotal)))))

data ColorMode

Whether to use colors and other features of ANSI terminals.

Constructors

Never

Always

Auto

Instances

Bounded ColorMode

Defined in Ormolu.Terminal

Methods

minBound :: ColorMode

maxBound :: ColorMode

Enum ColorMode

Defined in Ormolu.Terminal

Methods

succ :: ColorMode -> ColorMode

pred :: ColorMode -> ColorMode

toEnum :: Int -> ColorMode

fromEnum :: ColorMode -> Int

enumFrom :: ColorMode -> [ColorMode]

enumFromThen :: ColorMode -> ColorMode -> [ColorMode]

enumFromTo :: ColorMode -> ColorMode -> [ColorMode]

enumFromThenTo :: ColorMode -> ColorMode -> ColorMode -> [ColorMode]

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.

data PrinterOpts f

Options controlling formatting output.

Constructors

PrinterOpts

Fields

• poIndentation :: f Int

  Number of spaces to use for indentation

• poCommaStyle :: f CommaStyle

  Whether to place commas at start or end of lines

• poImportExportCommaStyle :: f CommaStyle

  Whether to place commas at start or end of import-export lines

• poIndentWheres :: f Bool

  Whether to indent `where` blocks

• poRecordBraceSpace :: f Bool

  Leave space before opening record brace

• poDiffFriendlyImportExport :: f Bool

  Trailing commas with parentheses on separate lines

• poRespectful :: f Bool

  Be less opinionated about spaces/newlines etc.

• poHaddockStyle :: f HaddockPrintStyle

  How to print doc comments

• poNewlinesBetweenDecls :: f Int

  Number of newlines between top-level decls

Instances

Eq PrinterOptsTotal

Defined in Ormolu.Config

Methods

(==) :: PrinterOptsTotal -> PrinterOptsTotal -> Bool

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

Eq PrinterOptsPartial

Defined in Ormolu.Config

Methods

(==) :: PrinterOptsPartial -> PrinterOptsPartial -> Bool

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

Show PrinterOptsTotal

Defined in Ormolu.Config

Methods

showsPrec :: Int -> PrinterOptsTotal -> ShowS

show :: PrinterOptsTotal -> String

showList :: [PrinterOptsTotal] -> ShowS

Show PrinterOptsPartial

Defined in Ormolu.Config

Methods

showsPrec :: Int -> PrinterOptsPartial -> ShowS

show :: PrinterOptsPartial -> String

showList :: [PrinterOptsPartial] -> ShowS

Semigroup PrinterOptsPartial

Defined in Ormolu.Config

Methods

(<>) :: PrinterOptsPartial -> PrinterOptsPartial -> PrinterOptsPartial

sconcat :: NonEmpty PrinterOptsPartial -> PrinterOptsPartial

stimes :: Integral b => b -> PrinterOptsPartial -> PrinterOptsPartial

Monoid PrinterOptsPartial

Defined in Ormolu.Config

Methods

mempty :: PrinterOptsPartial

mappend :: PrinterOptsPartial -> PrinterOptsPartial -> PrinterOptsPartial

mconcat :: [PrinterOptsPartial] -> PrinterOptsPartial

FromJSON PrinterOptsPartial

Defined in Ormolu.Config

Methods

parseJSON :: Value -> Parser PrinterOptsPartial

parseJSONList :: Value -> Parser [PrinterOptsPartial]

Generic (PrinterOpts f)

Defined in Ormolu.Config

Associated Types

type Rep (PrinterOpts f) :: Type -> Type

Methods

from :: PrinterOpts f -> Rep (PrinterOpts f) x

to :: Rep (PrinterOpts f) x -> PrinterOpts f

type Rep (PrinterOpts f)

Defined in Ormolu.Config

type Rep (PrinterOpts f) = D1 ('MetaData "PrinterOpts" "Ormolu.Config" "fourmolu-0.6.0.0-LhRbNevHLirDIg2fiACsm0" 'False) (C1 ('MetaCons "PrinterOpts" 'PrefixI 'True) (((S1 ('MetaSel ('Just "poIndentation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (f Int)) :*: S1 ('MetaSel ('Just "poCommaStyle") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (f CommaStyle))) :*: (S1 ('MetaSel ('Just "poImportExportCommaStyle") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (f CommaStyle)) :*: S1 ('MetaSel ('Just "poIndentWheres") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (f Bool)))) :*: ((S1 ('MetaSel ('Just "poRecordBraceSpace") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (f Bool)) :*: S1 ('MetaSel ('Just "poDiffFriendlyImportExport") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (f Bool))) :*: (S1 ('MetaSel ('Just "poRespectful") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (f Bool)) :*: (S1 ('MetaSel ('Just "poHaddockStyle") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (f HaddockPrintStyle)) :*: S1 ('MetaSel ('Just "poNewlinesBetweenDecls") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (f Int)))))))

type PrinterOptsPartial = PrinterOpts Maybe

A version of PrinterOpts where any field can be empty. This corresponds to the information in a config file or in CLI options.

type PrinterOptsTotal = PrinterOpts Identity

A version of PrinterOpts without empty fields.

defaultPrinterOpts :: PrinterOptsTotal

loadConfigFile :: FilePath -> IO ConfigFileLoadResult

Read options from a config file, if found. Looks recursively in parent folders, then in XdgConfig, for a file named fourmolu.yaml.

configFileName :: FilePath

Expected file name for YAML config.

data ConfigFileLoadResult

The result of calling loadConfigFile.

Constructors

ConfigLoaded FilePath PrinterOptsPartial

ConfigParseError FilePath (Pos, String)

ConfigNotFound [FilePath]

Instances

Eq ConfigFileLoadResult

Defined in Ormolu.Config

Methods

(==) :: ConfigFileLoadResult -> ConfigFileLoadResult -> Bool

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

Show ConfigFileLoadResult

Defined in Ormolu.Config

Methods

showsPrec :: Int -> ConfigFileLoadResult -> ShowS

show :: ConfigFileLoadResult -> String

showList :: [ConfigFileLoadResult] -> ShowS

fillMissingPrinterOpts :: forall f. Applicative f => PrinterOptsPartial -> PrinterOpts f -> PrinterOpts f

Fill the field values that are Nothing in the first argument with the values of the corresponding fields of the second argument.

data CommaStyle

Constructors

Leading

Trailing

Instances

Bounded CommaStyle

Defined in Ormolu.Config

Methods

minBound :: CommaStyle

maxBound :: CommaStyle

Enum CommaStyle

Defined in Ormolu.Config

Methods

succ :: CommaStyle -> CommaStyle

pred :: CommaStyle -> CommaStyle

toEnum :: Int -> CommaStyle

fromEnum :: CommaStyle -> Int

enumFrom :: CommaStyle -> [CommaStyle]

enumFromThen :: CommaStyle -> CommaStyle -> [CommaStyle]

enumFromTo :: CommaStyle -> CommaStyle -> [CommaStyle]

enumFromThenTo :: CommaStyle -> CommaStyle -> CommaStyle -> [CommaStyle]

Eq CommaStyle

Defined in Ormolu.Config

Methods

(==) :: CommaStyle -> CommaStyle -> Bool

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

Ord CommaStyle

Defined in Ormolu.Config

Methods

compare :: CommaStyle -> CommaStyle -> Ordering

(<) :: CommaStyle -> CommaStyle -> Bool

(<=) :: CommaStyle -> CommaStyle -> Bool

(>) :: CommaStyle -> CommaStyle -> Bool

(>=) :: CommaStyle -> CommaStyle -> Bool

max :: CommaStyle -> CommaStyle -> CommaStyle

min :: CommaStyle -> CommaStyle -> CommaStyle

Show CommaStyle

Defined in Ormolu.Config

Methods

showsPrec :: Int -> CommaStyle -> ShowS

show :: CommaStyle -> String

showList :: [CommaStyle] -> ShowS

Generic CommaStyle

Defined in Ormolu.Config

Associated Types

type Rep CommaStyle :: Type -> Type

Methods

from :: CommaStyle -> Rep CommaStyle x

to :: Rep CommaStyle x -> CommaStyle

FromJSON CommaStyle

Defined in Ormolu.Config

Methods

parseJSON :: Value -> Parser CommaStyle

parseJSONList :: Value -> Parser [CommaStyle]

type Rep CommaStyle

Defined in Ormolu.Config

type Rep CommaStyle = D1 ('MetaData "CommaStyle" "Ormolu.Config" "fourmolu-0.6.0.0-LhRbNevHLirDIg2fiACsm0" 'False) (C1 ('MetaCons "Leading" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Trailing" 'PrefixI 'False) (U1 :: Type -> Type))

data HaddockPrintStyle

Constructors

HaddockSingleLine

HaddockMultiLine

Instances

Bounded HaddockPrintStyle

Defined in Ormolu.Config

Methods

minBound :: HaddockPrintStyle

maxBound :: HaddockPrintStyle

Enum HaddockPrintStyle

Defined in Ormolu.Config

Methods

succ :: HaddockPrintStyle -> HaddockPrintStyle

pred :: HaddockPrintStyle -> HaddockPrintStyle

toEnum :: Int -> HaddockPrintStyle

fromEnum :: HaddockPrintStyle -> Int

enumFrom :: HaddockPrintStyle -> [HaddockPrintStyle]

enumFromThen :: HaddockPrintStyle -> HaddockPrintStyle -> [HaddockPrintStyle]

enumFromTo :: HaddockPrintStyle -> HaddockPrintStyle -> [HaddockPrintStyle]

enumFromThenTo :: HaddockPrintStyle -> HaddockPrintStyle -> HaddockPrintStyle -> [HaddockPrintStyle]

Eq HaddockPrintStyle

Defined in Ormolu.Config

Methods

(==) :: HaddockPrintStyle -> HaddockPrintStyle -> Bool

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

Ord HaddockPrintStyle

Defined in Ormolu.Config

Methods

compare :: HaddockPrintStyle -> HaddockPrintStyle -> Ordering

(<) :: HaddockPrintStyle -> HaddockPrintStyle -> Bool

(<=) :: HaddockPrintStyle -> HaddockPrintStyle -> Bool

(>) :: HaddockPrintStyle -> HaddockPrintStyle -> Bool

(>=) :: HaddockPrintStyle -> HaddockPrintStyle -> Bool

max :: HaddockPrintStyle -> HaddockPrintStyle -> HaddockPrintStyle

min :: HaddockPrintStyle -> HaddockPrintStyle -> HaddockPrintStyle

Show HaddockPrintStyle

Defined in Ormolu.Config

Methods

showsPrec :: Int -> HaddockPrintStyle -> ShowS

show :: HaddockPrintStyle -> String

showList :: [HaddockPrintStyle] -> ShowS

Generic HaddockPrintStyle

Defined in Ormolu.Config

Associated Types

type Rep HaddockPrintStyle :: Type -> Type

Methods

from :: HaddockPrintStyle -> Rep HaddockPrintStyle x

to :: Rep HaddockPrintStyle x -> HaddockPrintStyle

FromJSON HaddockPrintStyle

Defined in Ormolu.Config

Methods

parseJSON :: Value -> Parser HaddockPrintStyle

parseJSONList :: Value -> Parser [HaddockPrintStyle]

type Rep HaddockPrintStyle

Defined in Ormolu.Config

type Rep HaddockPrintStyle = D1 ('MetaData "HaddockPrintStyle" "Ormolu.Config" "fourmolu-0.6.0.0-LhRbNevHLirDIg2fiACsm0" 'False) (C1 ('MetaCons "HaddockSingleLine" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "HaddockMultiLine" 'PrefixI 'False) (U1 :: Type -> Type))

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.