Safe Haskell	None
Language	GHC2021

Ormolu.Config

Contents

Fourmolu configuration
- Loading Fourmolu configuration
Orphan instances

Description

Configuration options used by the tool.

Synopsis

data Config region = Config {
- cfgDynOptions :: ![DynOption]
- cfgFixityOverrides :: !FixityOverrides
- cfgModuleReexports :: !ModuleReexports
- cfgDependencies :: !(Set PackageName)
- cfgUnsafe :: !Bool
- cfgDebug :: !Bool
- cfgCheckIdempotence :: !Bool
- cfgSourceType :: !SourceType
- cfgColorMode :: !ColorMode
- cfgRegion :: !region
- cfgPrinterOpts :: !PrinterOptsTotal
- cfgLocalModules :: !(Set ModuleName)
}
data ColorMode
- = Never
- | Always
- | Auto
data RegionIndices = RegionIndices {
- regionStartLine :: !(Maybe Int)
- regionEndLine :: !(Maybe Int)
}
data RegionDeltas = RegionDeltas {
- regionPrefixLength :: !Int
- regionSuffixLength :: !Int
}
data SourceType
- = ModuleSource
- | SignatureSource
defaultConfig :: Config RegionIndices
overapproximatedDependencies :: Config region -> Set PackageName
regionIndicesToDeltas :: Int -> RegionIndices -> RegionDeltas
newtype DynOption = DynOption {
- unDynOption :: String
}
dynOptionToLocatedStr :: DynOption -> Located String
data PrinterOpts (f :: Type -> Type) = PrinterOpts {
- poIndentation :: f Int
- poColumnLimit :: f ColumnLimit
- poFunctionArrows :: f FunctionArrowsStyle
- poCommaStyle :: f CommaStyle
- poImportExportStyle :: f ImportExportStyle
- poImportGrouping :: f ImportGrouping
- poIndentWheres :: f Bool
- poRecordBraceSpace :: f Bool
- poNewlinesBetweenDecls :: f Int
- poHaddockStyle :: f HaddockPrintStyle
- poHaddockStyleModule :: f HaddockPrintStyleModule
- poHaddockLocSignature :: f HaddockLocSignature
- poLetStyle :: f LetStyle
- poInStyle :: f InStyle
- poIfStyle :: f IfStyle
- poSingleConstraintParens :: f SingleConstraintParens
- poSingleDerivingParens :: f SingleDerivingParens
- poSortConstraints :: f Bool
- poSortDerivedClasses :: f Bool
- poSortDerivingClauses :: f Bool
- poTrailingSectionOperators :: f Bool
- poUnicode :: f Unicode
- poRespectful :: f Bool
}
type PrinterOptsPartial = PrinterOpts Maybe
type PrinterOptsTotal = PrinterOpts Identity
defaultPrinterOpts :: PrinterOpts Identity
defaultPrinterOptsYaml :: String
fillMissingPrinterOpts :: forall (f :: Type -> Type). Applicative f => PrinterOpts Maybe -> PrinterOpts f -> PrinterOpts f
resolvePrinterOpts :: [PrinterOptsPartial] -> PrinterOptsTotal
data CommaStyle
- = Leading
- | Trailing
data FunctionArrowsStyle
- = TrailingArrows
- | LeadingArrows
- | LeadingArgsArrows
data HaddockPrintStyle
- = HaddockSingleLine
- | HaddockMultiLine
- | HaddockMultiLineCompact
data HaddockPrintStyleModule
- = PrintStyleInherit
- | PrintStyleOverride HaddockPrintStyle
data HaddockLocSignature
- = HaddockLocSigAuto
- | HaddockLocSigLeading
- | HaddockLocSigTrailing
data ImportExportStyle
- = ImportExportLeading
- | ImportExportTrailing
- | ImportExportDiffFriendly
data ImportGrouping
- = ImportGroupLegacy
- | ImportGroupPreserve
- | ImportGroupSingle
- | ImportGroupByScope
- | ImportGroupByQualified
- | ImportGroupByScopeThenQualified
- | ImportGroupCustom (NonEmpty ImportGroup)
data ImportGroup = ImportGroup {
- igName :: !(Maybe String)
- igRules :: !(NonEmpty ImportGroupRule)
}
data ImportGroupRule = ImportGroupRule {
- igrModuleMatcher :: !ImportModuleMatcher
- igrQualifiedMatcher :: !QualifiedImportMatcher
- igrPriority :: !ImportRulePriority
}
data ImportModuleMatcher
- = MatchAllModules
- | MatchLocalModules
- | MatchGlob !Glob
newtype ImportRulePriority = ImportRulePriority Word8
matchAllRulePriority :: ImportRulePriority
matchLocalRulePriority :: ImportRulePriority
defaultImportRulePriority :: ImportRulePriority
data QualifiedImportMatcher
- = MatchQualifiedOnly
- | MatchUnqualifiedOnly
- | MatchBothQualifiedAndUnqualified
data LetStyle
- = LetAuto
- | LetInline
- | LetNewline
- | LetMixed
data InStyle
- = InLeftAlign
- | InRightAlign
- | InNoSpace
data IfStyle
- = IfIndented
- | IfHanging
data Unicode
- = UnicodeDetect
- | UnicodeAlways
- | UnicodeNever
data ColumnLimit
- = NoLimit
- | ColumnLimit Int
data SingleDerivingParens
- = DerivingAuto
- | DerivingAlways
- | DerivingNever
parsePrinterOptsCLI :: Applicative f => (forall a. PrinterOptsFieldType a => String -> String -> String -> f (Maybe a)) -> f (PrinterOpts Maybe)
parsePrinterOptType :: PrinterOptsFieldType a => String -> Either String a
renderPrinterOpt :: RenderPrinterOpt a => a -> String
data ConfigNotFound = ConfigNotFound {
- searchDirs :: [FilePath]
}
findConfigFile :: FilePath -> IO (Either ConfigNotFound FilePath)
configFileName :: FilePath
data FourmoluConfig = FourmoluConfig {
- cfgFilePrinterOpts :: PrinterOptsPartial
- cfgFileFixities :: FixityOverrides
- cfgFileReexports :: ModuleReexports
}
emptyConfig :: FourmoluConfig

Documentation

data Config region Source #

Ormolu configuration.

Constructors

Config

Fields

cfgDynOptions :: ![DynOption]
Dynamic options to pass to GHC parser
cfgFixityOverrides :: !FixityOverrides
Fixity overrides
cfgModuleReexports :: !ModuleReexports
Module reexports to take into account when doing fixity resolution
cfgDependencies :: !(Set PackageName)
Known dependencies, if any
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
cfgLocalModules :: !(Set ModuleName)

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 #

Generic (Config region) Source #

Instance details

Defined in Ormolu.Config

Associated Types

type Rep (Config region)

Instance details

Defined in Ormolu.Config

Methods

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

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

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 #

Eq region => Eq (Config region) Source #

Instance details

Defined in Ormolu.Config

Methods

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

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

type Rep (Config region) Source #

Instance details

Defined in Ormolu.Config

data ColorMode Source #

Whether to use colors and other features of ANSI terminals.

Constructors

Never
Always
Auto

Instances

Instances details

Bounded ColorMode Source #
Instance details Defined in Ormolu.Terminal Methods minBound :: ColorMode # maxBound :: ColorMode #
Enum ColorMode Source #
Instance details 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] #
Show ColorMode Source #
Instance details Defined in Ormolu.Terminal Methods showsPrec :: Int -> ColorMode -> ShowS # show :: ColorMode -> String # showList :: [ColorMode] -> ShowS #
Eq ColorMode Source #
Instance details Defined in Ormolu.Terminal Methods (==) :: ColorMode -> ColorMode -> Bool # (/=) :: ColorMode -> ColorMode -> Bool #

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

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

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

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

data SourceType Source #

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

Instances details

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

defaultConfig :: Config RegionIndices Source #

Default Config RegionIndices.

overapproximatedDependencies :: Config region -> Set PackageName Source #

Return all dependencies of the module. This includes both the declared dependencies of the component we are working with and all potential module re-export targets.

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

Show DynOption Source #
Instance details Defined in Ormolu.Config Methods showsPrec :: Int -> DynOption -> ShowS # show :: DynOption -> String # showList :: [DynOption] -> ShowS #
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 #

dynOptionToLocatedStr :: DynOption -> Located String Source #

Convert DynOption to Located String.

Fourmolu configuration

data PrinterOpts (f :: Type -> Type) Source #

Options controlling formatting output.

Constructors

PrinterOpts

Fields

poIndentation :: f Int
Number of spaces per indentation step
poColumnLimit :: f ColumnLimit
Max line length for automatic line breaking
poFunctionArrows :: f FunctionArrowsStyle
Styling of arrows in type signatures
poCommaStyle :: f CommaStyle
How to place commas in multi-line lists, records, etc.
poImportExportStyle :: f ImportExportStyle
Styling of import/export lists
poImportGrouping :: f ImportGrouping
Rules for grouping import declarations
poIndentWheres :: f Bool
Whether to full-indent or half-indent 'where' bindings past the preceding body
poRecordBraceSpace :: f Bool
Whether to leave a space before an opening record brace
poNewlinesBetweenDecls :: f Int
Number of spaces between top-level declarations
poHaddockStyle :: f HaddockPrintStyle
How to print Haddock comments
poHaddockStyleModule :: f HaddockPrintStyleModule
How to print module docstring
poHaddockLocSignature :: f HaddockLocSignature
Where to put docstring comments in function signatures
poLetStyle :: f LetStyle
Styling of let blocks
poInStyle :: f InStyle
How to align the 'in' keyword with respect to the 'let' keyword
poIfStyle :: f IfStyle
Styling of if-statements
poSingleConstraintParens :: f SingleConstraintParens
Whether to put parentheses around a single constraint
poSingleDerivingParens :: f SingleDerivingParens
Whether to put parentheses around a single deriving class
poSortConstraints :: f Bool
Whether to sort constraints
poSortDerivedClasses :: f Bool
Whether to sort derived classes
poSortDerivingClauses :: f Bool
Whether to sort deriving clauses
poTrailingSectionOperators :: f Bool
Whether to place section operators (those that are infixr 0, such as $) in trailing position, continuing the expression indented below
poUnicode :: f Unicode
Output Unicode syntax
poRespectful :: f Bool
Give the programmer more choice on where to insert blank lines

Instances

Instances details

FromJSON PrinterOptsPartial Source #

Instance details

Defined in Ormolu.Config

Methods

parseJSON :: Value -> Parser PrinterOptsPartial #

parseJSONList :: Value -> Parser [PrinterOptsPartial] #

omittedField :: Maybe PrinterOptsPartial #

Monoid PrinterOptsPartial Source #

Instance details

Defined in Ormolu.Config

Methods

mempty :: PrinterOptsPartial #

mappend :: PrinterOptsPartial -> PrinterOptsPartial -> PrinterOptsPartial #

mconcat :: [PrinterOptsPartial] -> PrinterOptsPartial #

Semigroup PrinterOptsPartial Source #

Instance details

Defined in Ormolu.Config

Methods

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

sconcat :: NonEmpty PrinterOptsPartial -> PrinterOptsPartial #

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

Show PrinterOptsPartial Source #

Instance details

Defined in Ormolu.Config

Methods

showsPrec :: Int -> PrinterOptsPartial -> ShowS #

show :: PrinterOptsPartial -> String #

showList :: [PrinterOptsPartial] -> ShowS #

Show PrinterOptsTotal Source #

Instance details

Defined in Ormolu.Config

Methods

showsPrec :: Int -> PrinterOptsTotal -> ShowS #

show :: PrinterOptsTotal -> String #

showList :: [PrinterOptsTotal] -> ShowS #

Eq PrinterOptsPartial Source #

Instance details

Defined in Ormolu.Config

Methods

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

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

Eq PrinterOptsTotal Source #

Instance details

Defined in Ormolu.Config

Methods

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

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

Generic (PrinterOpts f) Source #

Instance details

Defined in Ormolu.Config.Gen

Associated Types

type Rep (PrinterOpts f)
Instance details Defined in Ormolu.Config.Gen type Rep (PrinterOpts f)

Methods

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

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

type Rep (PrinterOpts f) Source #

Instance details

Defined in Ormolu.Config.Gen

type Rep (PrinterOpts f)

type PrinterOptsPartial = PrinterOpts Maybe Source #

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 Source #

A version of PrinterOpts without empty fields.

defaultPrinterOpts :: PrinterOpts Identity Source #

defaultPrinterOptsYaml :: String Source #

fillMissingPrinterOpts :: forall (f :: Type -> Type). Applicative f => PrinterOpts Maybe -> PrinterOpts f -> PrinterOpts f Source #

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

resolvePrinterOpts :: [PrinterOptsPartial] -> PrinterOptsTotal Source #

Apply the given configuration in order (later options override earlier).

data CommaStyle Source #

Constructors

Leading
Trailing

Instances

Instances details

FromJSON CommaStyle Source #
Instance details Defined in Ormolu.Config.Gen Methods parseJSON :: Value -> Parser CommaStyle # parseJSONList :: Value -> Parser [CommaStyle] # omittedField :: Maybe CommaStyle #
Bounded CommaStyle Source #
Instance details Defined in Ormolu.Config.Gen Methods minBound :: CommaStyle # maxBound :: CommaStyle #
Enum CommaStyle Source #
Instance details Defined in Ormolu.Config.Gen 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] #
Show CommaStyle Source #
Instance details Defined in Ormolu.Config.Gen Methods showsPrec :: Int -> CommaStyle -> ShowS # show :: CommaStyle -> String # showList :: [CommaStyle] -> ShowS #
Eq CommaStyle Source #
Instance details Defined in Ormolu.Config.Gen Methods (==) :: CommaStyle -> CommaStyle -> Bool # (/=) :: CommaStyle -> CommaStyle -> Bool #

data FunctionArrowsStyle Source #

Constructors

TrailingArrows
LeadingArrows
LeadingArgsArrows

Instances

Instances details

FromJSON FunctionArrowsStyle Source #
Instance details Defined in Ormolu.Config.Gen Methods parseJSON :: Value -> Parser FunctionArrowsStyle # parseJSONList :: Value -> Parser [FunctionArrowsStyle] # omittedField :: Maybe FunctionArrowsStyle #
Bounded FunctionArrowsStyle Source #
Instance details Defined in Ormolu.Config.Gen Methods minBound :: FunctionArrowsStyle # maxBound :: FunctionArrowsStyle #
Enum FunctionArrowsStyle Source #
Instance details Defined in Ormolu.Config.Gen Methods succ :: FunctionArrowsStyle -> FunctionArrowsStyle # pred :: FunctionArrowsStyle -> FunctionArrowsStyle # toEnum :: Int -> FunctionArrowsStyle # fromEnum :: FunctionArrowsStyle -> Int # enumFrom :: FunctionArrowsStyle -> [FunctionArrowsStyle] # enumFromThen :: FunctionArrowsStyle -> FunctionArrowsStyle -> [FunctionArrowsStyle] # enumFromTo :: FunctionArrowsStyle -> FunctionArrowsStyle -> [FunctionArrowsStyle] # enumFromThenTo :: FunctionArrowsStyle -> FunctionArrowsStyle -> FunctionArrowsStyle -> [FunctionArrowsStyle] #
Show FunctionArrowsStyle Source #
Instance details Defined in Ormolu.Config.Gen Methods showsPrec :: Int -> FunctionArrowsStyle -> ShowS # show :: FunctionArrowsStyle -> String # showList :: [FunctionArrowsStyle] -> ShowS #
Eq FunctionArrowsStyle Source #
Instance details Defined in Ormolu.Config.Gen Methods (==) :: FunctionArrowsStyle -> FunctionArrowsStyle -> Bool # (/=) :: FunctionArrowsStyle -> FunctionArrowsStyle -> Bool #

data HaddockPrintStyle Source #

Constructors

HaddockSingleLine
HaddockMultiLine
HaddockMultiLineCompact

Instances

Instances details

FromJSON HaddockPrintStyle Source #
Instance details Defined in Ormolu.Config.Gen Methods parseJSON :: Value -> Parser HaddockPrintStyle # parseJSONList :: Value -> Parser [HaddockPrintStyle] # omittedField :: Maybe HaddockPrintStyle #
Bounded HaddockPrintStyle Source #
Instance details Defined in Ormolu.Config.Gen Methods minBound :: HaddockPrintStyle # maxBound :: HaddockPrintStyle #
Enum HaddockPrintStyle Source #
Instance details Defined in Ormolu.Config.Gen 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] #
Show HaddockPrintStyle Source #
Instance details Defined in Ormolu.Config.Gen Methods showsPrec :: Int -> HaddockPrintStyle -> ShowS # show :: HaddockPrintStyle -> String # showList :: [HaddockPrintStyle] -> ShowS #
Eq HaddockPrintStyle Source #
Instance details Defined in Ormolu.Config.Gen Methods (==) :: HaddockPrintStyle -> HaddockPrintStyle -> Bool # (/=) :: HaddockPrintStyle -> HaddockPrintStyle -> Bool #

data HaddockPrintStyleModule Source #

Constructors

PrintStyleInherit
PrintStyleOverride HaddockPrintStyle

Instances

Instances details

FromJSON HaddockPrintStyleModule Source #
Instance details Defined in Ormolu.Config.Gen Methods parseJSON :: Value -> Parser HaddockPrintStyleModule # parseJSONList :: Value -> Parser [HaddockPrintStyleModule] # omittedField :: Maybe HaddockPrintStyleModule #
Show HaddockPrintStyleModule Source #
Instance details Defined in Ormolu.Config.Gen Methods showsPrec :: Int -> HaddockPrintStyleModule -> ShowS # show :: HaddockPrintStyleModule -> String # showList :: [HaddockPrintStyleModule] -> ShowS #
Eq HaddockPrintStyleModule Source #
Instance details Defined in Ormolu.Config.Gen Methods (==) :: HaddockPrintStyleModule -> HaddockPrintStyleModule -> Bool # (/=) :: HaddockPrintStyleModule -> HaddockPrintStyleModule -> Bool #

data HaddockLocSignature Source #

Constructors

HaddockLocSigAuto
HaddockLocSigLeading
HaddockLocSigTrailing

Instances

Instances details

FromJSON HaddockLocSignature Source #
Instance details Defined in Ormolu.Config.Gen Methods parseJSON :: Value -> Parser HaddockLocSignature # parseJSONList :: Value -> Parser [HaddockLocSignature] # omittedField :: Maybe HaddockLocSignature #
Bounded HaddockLocSignature Source #
Instance details Defined in Ormolu.Config.Gen Methods minBound :: HaddockLocSignature # maxBound :: HaddockLocSignature #
Enum HaddockLocSignature Source #
Instance details Defined in Ormolu.Config.Gen Methods succ :: HaddockLocSignature -> HaddockLocSignature # pred :: HaddockLocSignature -> HaddockLocSignature # toEnum :: Int -> HaddockLocSignature # fromEnum :: HaddockLocSignature -> Int # enumFrom :: HaddockLocSignature -> [HaddockLocSignature] # enumFromThen :: HaddockLocSignature -> HaddockLocSignature -> [HaddockLocSignature] # enumFromTo :: HaddockLocSignature -> HaddockLocSignature -> [HaddockLocSignature] # enumFromThenTo :: HaddockLocSignature -> HaddockLocSignature -> HaddockLocSignature -> [HaddockLocSignature] #
Show HaddockLocSignature Source #
Instance details Defined in Ormolu.Config.Gen Methods showsPrec :: Int -> HaddockLocSignature -> ShowS # show :: HaddockLocSignature -> String # showList :: [HaddockLocSignature] -> ShowS #
Eq HaddockLocSignature Source #
Instance details Defined in Ormolu.Config.Gen Methods (==) :: HaddockLocSignature -> HaddockLocSignature -> Bool # (/=) :: HaddockLocSignature -> HaddockLocSignature -> Bool #

data ImportExportStyle Source #

Constructors

ImportExportLeading
ImportExportTrailing
ImportExportDiffFriendly

Instances

Instances details

FromJSON ImportExportStyle Source #
Instance details Defined in Ormolu.Config.Gen Methods parseJSON :: Value -> Parser ImportExportStyle # parseJSONList :: Value -> Parser [ImportExportStyle] # omittedField :: Maybe ImportExportStyle #
Bounded ImportExportStyle Source #
Instance details Defined in Ormolu.Config.Gen Methods minBound :: ImportExportStyle # maxBound :: ImportExportStyle #
Enum ImportExportStyle Source #
Instance details Defined in Ormolu.Config.Gen Methods succ :: ImportExportStyle -> ImportExportStyle # pred :: ImportExportStyle -> ImportExportStyle # toEnum :: Int -> ImportExportStyle # fromEnum :: ImportExportStyle -> Int # enumFrom :: ImportExportStyle -> [ImportExportStyle] # enumFromThen :: ImportExportStyle -> ImportExportStyle -> [ImportExportStyle] # enumFromTo :: ImportExportStyle -> ImportExportStyle -> [ImportExportStyle] # enumFromThenTo :: ImportExportStyle -> ImportExportStyle -> ImportExportStyle -> [ImportExportStyle] #
Show ImportExportStyle Source #
Instance details Defined in Ormolu.Config.Gen Methods showsPrec :: Int -> ImportExportStyle -> ShowS # show :: ImportExportStyle -> String # showList :: [ImportExportStyle] -> ShowS #
Eq ImportExportStyle Source #
Instance details Defined in Ormolu.Config.Gen Methods (==) :: ImportExportStyle -> ImportExportStyle -> Bool # (/=) :: ImportExportStyle -> ImportExportStyle -> Bool #

data ImportGrouping Source #

Constructors

ImportGroupLegacy
ImportGroupPreserve
ImportGroupSingle
ImportGroupByScope
ImportGroupByQualified
ImportGroupByScopeThenQualified
ImportGroupCustom (NonEmpty ImportGroup)

Instances

Instances details

FromJSON ImportGrouping Source #
Instance details Defined in Ormolu.Config.Gen Methods parseJSON :: Value -> Parser ImportGrouping # parseJSONList :: Value -> Parser [ImportGrouping] # omittedField :: Maybe ImportGrouping #
Show ImportGrouping Source #
Instance details Defined in Ormolu.Config.Gen Methods showsPrec :: Int -> ImportGrouping -> ShowS # show :: ImportGrouping -> String # showList :: [ImportGrouping] -> ShowS #
Eq ImportGrouping Source #
Instance details Defined in Ormolu.Config.Gen Methods (==) :: ImportGrouping -> ImportGrouping -> Bool # (/=) :: ImportGrouping -> ImportGrouping -> Bool #

data ImportGroup Source #

Constructors

ImportGroup
Fields igName :: !(Maybe String) igRules :: !(NonEmpty ImportGroupRule)

Instances

Instances details

FromJSON ImportGroup Source #
Instance details Defined in Ormolu.Config.Types Methods parseJSON :: Value -> Parser ImportGroup # parseJSONList :: Value -> Parser [ImportGroup] # omittedField :: Maybe ImportGroup #
Show ImportGroup Source #
Instance details Defined in Ormolu.Config.Types Methods showsPrec :: Int -> ImportGroup -> ShowS # show :: ImportGroup -> String # showList :: [ImportGroup] -> ShowS #
Eq ImportGroup Source #
Instance details Defined in Ormolu.Config.Types Methods (==) :: ImportGroup -> ImportGroup -> Bool # (/=) :: ImportGroup -> ImportGroup -> Bool #

data ImportGroupRule Source #

Constructors

ImportGroupRule
Fields igrModuleMatcher :: !ImportModuleMatcher igrQualifiedMatcher :: !QualifiedImportMatcher igrPriority :: !ImportRulePriority

Instances

Instances details

FromJSON ImportGroupRule Source #
Instance details Defined in Ormolu.Config.Types Methods parseJSON :: Value -> Parser ImportGroupRule # parseJSONList :: Value -> Parser [ImportGroupRule] # omittedField :: Maybe ImportGroupRule #
Show ImportGroupRule Source #
Instance details Defined in Ormolu.Config.Types Methods showsPrec :: Int -> ImportGroupRule -> ShowS # show :: ImportGroupRule -> String # showList :: [ImportGroupRule] -> ShowS #
Eq ImportGroupRule Source #
Instance details Defined in Ormolu.Config.Types Methods (==) :: ImportGroupRule -> ImportGroupRule -> Bool # (/=) :: ImportGroupRule -> ImportGroupRule -> Bool #

data ImportModuleMatcher Source #

Constructors

MatchAllModules
MatchLocalModules
MatchGlob !Glob

Instances

Instances details

FromJSON ImportModuleMatcher Source #
Instance details Defined in Ormolu.Config.Types Methods parseJSON :: Value -> Parser ImportModuleMatcher # parseJSONList :: Value -> Parser [ImportModuleMatcher] # omittedField :: Maybe ImportModuleMatcher #
Show ImportModuleMatcher Source #
Instance details Defined in Ormolu.Config.Types Methods showsPrec :: Int -> ImportModuleMatcher -> ShowS # show :: ImportModuleMatcher -> String # showList :: [ImportModuleMatcher] -> ShowS #
Eq ImportModuleMatcher Source #
Instance details Defined in Ormolu.Config.Types Methods (==) :: ImportModuleMatcher -> ImportModuleMatcher -> Bool # (/=) :: ImportModuleMatcher -> ImportModuleMatcher -> Bool #

newtype ImportRulePriority Source #

Constructors

ImportRulePriority Word8

Instances

Instances details

FromJSON ImportRulePriority Source #
Instance details Defined in Ormolu.Config.Types Methods parseJSON :: Value -> Parser ImportRulePriority # parseJSONList :: Value -> Parser [ImportRulePriority] # omittedField :: Maybe ImportRulePriority #
Bounded ImportRulePriority Source #
Instance details Defined in Ormolu.Config.Types Methods minBound :: ImportRulePriority # maxBound :: ImportRulePriority #
Show ImportRulePriority Source #
Instance details Defined in Ormolu.Config.Types Methods showsPrec :: Int -> ImportRulePriority -> ShowS # show :: ImportRulePriority -> String # showList :: [ImportRulePriority] -> ShowS #
Eq ImportRulePriority Source #
Instance details Defined in Ormolu.Config.Types Methods (==) :: ImportRulePriority -> ImportRulePriority -> Bool # (/=) :: ImportRulePriority -> ImportRulePriority -> Bool #
Ord ImportRulePriority Source #
Instance details Defined in Ormolu.Config.Types Methods compare :: ImportRulePriority -> ImportRulePriority -> Ordering # (<) :: ImportRulePriority -> ImportRulePriority -> Bool # (<=) :: ImportRulePriority -> ImportRulePriority -> Bool # (>) :: ImportRulePriority -> ImportRulePriority -> Bool # (>=) :: ImportRulePriority -> ImportRulePriority -> Bool # max :: ImportRulePriority -> ImportRulePriority -> ImportRulePriority # min :: ImportRulePriority -> ImportRulePriority -> ImportRulePriority #

matchAllRulePriority :: ImportRulePriority Source #

matchLocalRulePriority :: ImportRulePriority Source #

defaultImportRulePriority :: ImportRulePriority Source #

data QualifiedImportMatcher Source #

Constructors

MatchQualifiedOnly
MatchUnqualifiedOnly
MatchBothQualifiedAndUnqualified

Instances

Instances details

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

data LetStyle Source #

Constructors

LetAuto
LetInline
LetNewline
LetMixed

Instances

Instances details

FromJSON LetStyle Source #
Instance details Defined in Ormolu.Config.Gen Methods parseJSON :: Value -> Parser LetStyle # parseJSONList :: Value -> Parser [LetStyle] # omittedField :: Maybe LetStyle #
Bounded LetStyle Source #
Instance details Defined in Ormolu.Config.Gen Methods minBound :: LetStyle # maxBound :: LetStyle #
Enum LetStyle Source #
Instance details Defined in Ormolu.Config.Gen Methods succ :: LetStyle -> LetStyle # pred :: LetStyle -> LetStyle # toEnum :: Int -> LetStyle # fromEnum :: LetStyle -> Int # enumFrom :: LetStyle -> [LetStyle] # enumFromThen :: LetStyle -> LetStyle -> [LetStyle] # enumFromTo :: LetStyle -> LetStyle -> [LetStyle] # enumFromThenTo :: LetStyle -> LetStyle -> LetStyle -> [LetStyle] #
Show LetStyle Source #
Instance details Defined in Ormolu.Config.Gen Methods showsPrec :: Int -> LetStyle -> ShowS # show :: LetStyle -> String # showList :: [LetStyle] -> ShowS #
Eq LetStyle Source #
Instance details Defined in Ormolu.Config.Gen Methods (==) :: LetStyle -> LetStyle -> Bool # (/=) :: LetStyle -> LetStyle -> Bool #

data InStyle Source #

Constructors

InLeftAlign
InRightAlign
InNoSpace

Instances

Instances details

FromJSON InStyle Source #
Instance details Defined in Ormolu.Config.Gen Methods parseJSON :: Value -> Parser InStyle # parseJSONList :: Value -> Parser [InStyle] # omittedField :: Maybe InStyle #
Bounded InStyle Source #
Instance details Defined in Ormolu.Config.Gen Methods minBound :: InStyle # maxBound :: InStyle #
Enum InStyle Source #
Instance details Defined in Ormolu.Config.Gen Methods succ :: InStyle -> InStyle # pred :: InStyle -> InStyle # toEnum :: Int -> InStyle # fromEnum :: InStyle -> Int # enumFrom :: InStyle -> [InStyle] # enumFromThen :: InStyle -> InStyle -> [InStyle] # enumFromTo :: InStyle -> InStyle -> [InStyle] # enumFromThenTo :: InStyle -> InStyle -> InStyle -> [InStyle] #
Show InStyle Source #
Instance details Defined in Ormolu.Config.Gen Methods showsPrec :: Int -> InStyle -> ShowS # show :: InStyle -> String # showList :: [InStyle] -> ShowS #
Eq InStyle Source #
Instance details Defined in Ormolu.Config.Gen Methods (==) :: InStyle -> InStyle -> Bool # (/=) :: InStyle -> InStyle -> Bool #

data IfStyle Source #

Constructors

IfIndented
IfHanging

Instances

Instances details

FromJSON IfStyle Source #
Instance details Defined in Ormolu.Config.Gen Methods parseJSON :: Value -> Parser IfStyle # parseJSONList :: Value -> Parser [IfStyle] # omittedField :: Maybe IfStyle #
Bounded IfStyle Source #
Instance details Defined in Ormolu.Config.Gen Methods minBound :: IfStyle # maxBound :: IfStyle #
Enum IfStyle Source #
Instance details Defined in Ormolu.Config.Gen Methods succ :: IfStyle -> IfStyle # pred :: IfStyle -> IfStyle # toEnum :: Int -> IfStyle # fromEnum :: IfStyle -> Int # enumFrom :: IfStyle -> [IfStyle] # enumFromThen :: IfStyle -> IfStyle -> [IfStyle] # enumFromTo :: IfStyle -> IfStyle -> [IfStyle] # enumFromThenTo :: IfStyle -> IfStyle -> IfStyle -> [IfStyle] #
Show IfStyle Source #
Instance details Defined in Ormolu.Config.Gen Methods showsPrec :: Int -> IfStyle -> ShowS # show :: IfStyle -> String # showList :: [IfStyle] -> ShowS #
Eq IfStyle Source #
Instance details Defined in Ormolu.Config.Gen Methods (==) :: IfStyle -> IfStyle -> Bool # (/=) :: IfStyle -> IfStyle -> Bool #

data Unicode Source #

Constructors

UnicodeDetect
UnicodeAlways
UnicodeNever

Instances

Instances details

FromJSON Unicode Source #
Instance details Defined in Ormolu.Config.Gen Methods parseJSON :: Value -> Parser Unicode # parseJSONList :: Value -> Parser [Unicode] # omittedField :: Maybe Unicode #
Bounded Unicode Source #
Instance details Defined in Ormolu.Config.Gen Methods minBound :: Unicode # maxBound :: Unicode #
Enum Unicode Source #
Instance details Defined in Ormolu.Config.Gen Methods succ :: Unicode -> Unicode # pred :: Unicode -> Unicode # toEnum :: Int -> Unicode # fromEnum :: Unicode -> Int # enumFrom :: Unicode -> [Unicode] # enumFromThen :: Unicode -> Unicode -> [Unicode] # enumFromTo :: Unicode -> Unicode -> [Unicode] # enumFromThenTo :: Unicode -> Unicode -> Unicode -> [Unicode] #
Show Unicode Source #
Instance details Defined in Ormolu.Config.Gen Methods showsPrec :: Int -> Unicode -> ShowS # show :: Unicode -> String # showList :: [Unicode] -> ShowS #
Eq Unicode Source #
Instance details Defined in Ormolu.Config.Gen Methods (==) :: Unicode -> Unicode -> Bool # (/=) :: Unicode -> Unicode -> Bool #

data ColumnLimit Source #

Constructors

NoLimit
ColumnLimit Int

Instances

Instances details

FromJSON ColumnLimit Source #
Instance details Defined in Ormolu.Config.Gen Methods parseJSON :: Value -> Parser ColumnLimit # parseJSONList :: Value -> Parser [ColumnLimit] # omittedField :: Maybe ColumnLimit #
Show ColumnLimit Source #
Instance details Defined in Ormolu.Config.Gen Methods showsPrec :: Int -> ColumnLimit -> ShowS # show :: ColumnLimit -> String # showList :: [ColumnLimit] -> ShowS #
Eq ColumnLimit Source #
Instance details Defined in Ormolu.Config.Gen Methods (==) :: ColumnLimit -> ColumnLimit -> Bool # (/=) :: ColumnLimit -> ColumnLimit -> Bool #

data SingleDerivingParens Source #

Constructors

DerivingAuto
DerivingAlways
DerivingNever

Instances

Instances details

FromJSON SingleDerivingParens Source #
Instance details Defined in Ormolu.Config.Gen Methods parseJSON :: Value -> Parser SingleDerivingParens # parseJSONList :: Value -> Parser [SingleDerivingParens] # omittedField :: Maybe SingleDerivingParens #
Bounded SingleDerivingParens Source #
Instance details Defined in Ormolu.Config.Gen Methods minBound :: SingleDerivingParens # maxBound :: SingleDerivingParens #
Enum SingleDerivingParens Source #
Instance details Defined in Ormolu.Config.Gen Methods succ :: SingleDerivingParens -> SingleDerivingParens # pred :: SingleDerivingParens -> SingleDerivingParens # toEnum :: Int -> SingleDerivingParens # fromEnum :: SingleDerivingParens -> Int # enumFrom :: SingleDerivingParens -> [SingleDerivingParens] # enumFromThen :: SingleDerivingParens -> SingleDerivingParens -> [SingleDerivingParens] # enumFromTo :: SingleDerivingParens -> SingleDerivingParens -> [SingleDerivingParens] # enumFromThenTo :: SingleDerivingParens -> SingleDerivingParens -> SingleDerivingParens -> [SingleDerivingParens] #
Show SingleDerivingParens Source #
Instance details Defined in Ormolu.Config.Gen Methods showsPrec :: Int -> SingleDerivingParens -> ShowS # show :: SingleDerivingParens -> String # showList :: [SingleDerivingParens] -> ShowS #
Eq SingleDerivingParens Source #
Instance details Defined in Ormolu.Config.Gen Methods (==) :: SingleDerivingParens -> SingleDerivingParens -> Bool # (/=) :: SingleDerivingParens -> SingleDerivingParens -> Bool #

parsePrinterOptsCLI :: Applicative f => (forall a. PrinterOptsFieldType a => String -> String -> String -> f (Maybe a)) -> f (PrinterOpts Maybe) Source #

parsePrinterOptType :: PrinterOptsFieldType a => String -> Either String a Source #

renderPrinterOpt :: RenderPrinterOpt a => a -> String Source #

Loading Fourmolu configuration

data ConfigNotFound Source #

Constructors

ConfigNotFound
Fields searchDirs :: [FilePath]

Instances

Instances details

Show ConfigNotFound Source #
Instance details Defined in Ormolu.Config Methods showsPrec :: Int -> ConfigNotFound -> ShowS # show :: ConfigNotFound -> String # showList :: [ConfigNotFound] -> ShowS #

findConfigFile :: FilePath -> IO (Either ConfigNotFound FilePath) Source #

Find a fourmolu configuration file.

Looks for a file named fourmolu.yaml, first in the given path and its parents, and then in the XDG config directory.

configFileName :: FilePath Source #

Expected file name for YAML config.

data FourmoluConfig Source #

Constructors

FourmoluConfig
Fields cfgFilePrinterOpts :: PrinterOptsPartial cfgFileFixities :: FixityOverrides cfgFileReexports :: ModuleReexports

Instances

Instances details

FromJSON FourmoluConfig Source #
Instance details Defined in Ormolu.Config Methods parseJSON :: Value -> Parser FourmoluConfig # parseJSONList :: Value -> Parser [FourmoluConfig] # omittedField :: Maybe FourmoluConfig #
Show FourmoluConfig Source #
Instance details Defined in Ormolu.Config Methods showsPrec :: Int -> FourmoluConfig -> ShowS # show :: FourmoluConfig -> String # showList :: [FourmoluConfig] -> ShowS #
Eq FourmoluConfig Source #
Instance details Defined in Ormolu.Config Methods (==) :: FourmoluConfig -> FourmoluConfig -> Bool # (/=) :: FourmoluConfig -> FourmoluConfig -> Bool #

emptyConfig :: FourmoluConfig Source #

Orphan instances

FromJSON PrinterOptsPartial Source #
Instance details Methods parseJSON :: Value -> Parser PrinterOptsPartial # parseJSONList :: Value -> Parser [PrinterOptsPartial] # omittedField :: Maybe PrinterOptsPartial #
Monoid PrinterOptsPartial Source #
Instance details Methods mempty :: PrinterOptsPartial # mappend :: PrinterOptsPartial -> PrinterOptsPartial -> PrinterOptsPartial # mconcat :: [PrinterOptsPartial] -> PrinterOptsPartial #
Semigroup PrinterOptsPartial Source #
Instance details Methods (<>) :: PrinterOptsPartial -> PrinterOptsPartial -> PrinterOptsPartial # sconcat :: NonEmpty PrinterOptsPartial -> PrinterOptsPartial # stimes :: Integral b => b -> PrinterOptsPartial -> PrinterOptsPartial #
Show PrinterOptsPartial Source #
Instance details Methods showsPrec :: Int -> PrinterOptsPartial -> ShowS # show :: PrinterOptsPartial -> String # showList :: [PrinterOptsPartial] -> ShowS #
Show PrinterOptsTotal Source #
Instance details Methods showsPrec :: Int -> PrinterOptsTotal -> ShowS # show :: PrinterOptsTotal -> String # showList :: [PrinterOptsTotal] -> ShowS #
Eq PrinterOptsPartial Source #
Instance details Methods (==) :: PrinterOptsPartial -> PrinterOptsPartial -> Bool # (/=) :: PrinterOptsPartial -> PrinterOptsPartial -> Bool #
Eq PrinterOptsTotal Source #
Instance details Methods (==) :: PrinterOptsTotal -> PrinterOptsTotal -> Bool # (/=) :: PrinterOptsTotal -> PrinterOptsTotal -> Bool #