Safe Haskell | Safe-Inferred |
---|---|
Language | GHC2021 |
Ormolu.Config
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
- data ColorMode
- data RegionIndices = RegionIndices {
- regionStartLine :: !(Maybe Int)
- regionEndLine :: !(Maybe Int)
- data RegionDeltas = RegionDeltas {
- regionPrefixLength :: !Int
- regionSuffixLength :: !Int
- data SourceType
- defaultConfig :: Config RegionIndices
- overapproximatedDependencies :: Config region -> Set PackageName
- regionIndicesToDeltas :: Int -> RegionIndices -> RegionDeltas
- newtype DynOption = DynOption {
- unDynOption :: String
- dynOptionToLocatedStr :: DynOption -> Located String
Documentation
Ormolu configuration.
Constructors
Config | |
Fields
|
Instances
Functor Config Source # | |
Generic (Config region) Source # | |
Show region => Show (Config region) Source # | |
Eq region => Eq (Config region) Source # | |
type Rep (Config region) Source # | |
Defined in Ormolu.Config type Rep (Config region) = D1 ('MetaData "Config" "Ormolu.Config" "ormolu-0.7.2.0-JpsEOpENt94Cny8MV6lXhA" 'False) (C1 ('MetaCons "Config" 'PrefixI 'True) (((S1 ('MetaSel ('Just "cfgDynOptions") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 [DynOption]) :*: S1 ('MetaSel ('Just "cfgFixityOverrides") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 FixityOverrides)) :*: (S1 ('MetaSel ('Just "cfgModuleReexports") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ModuleReexports) :*: (S1 ('MetaSel ('Just "cfgDependencies") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Set PackageName)) :*: 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)))))) |
Whether to use colors and other features of ANSI terminals.
data RegionIndices Source #
Region selection as the combination of start and end line numbers.
Constructors
RegionIndices | |
Fields
|
Instances
Show RegionIndices Source # | |
Defined in Ormolu.Config Methods showsPrec :: Int -> RegionIndices -> ShowS show :: RegionIndices -> String showList :: [RegionIndices] -> ShowS | |
Eq RegionIndices Source # | |
Defined in Ormolu.Config |
data RegionDeltas Source #
Region selection as the length of the literal prefix and the literal suffix.
Constructors
RegionDeltas | |
Fields
|
Instances
Show RegionDeltas Source # | |
Defined in Ormolu.Config Methods showsPrec :: Int -> RegionDeltas -> ShowS show :: RegionDeltas -> String showList :: [RegionDeltas] -> ShowS | |
Eq RegionDeltas Source # | |
Defined in Ormolu.Config |
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
Show SourceType Source # | |
Defined in Ormolu.Config Methods showsPrec :: Int -> SourceType -> ShowS show :: SourceType -> String showList :: [SourceType] -> ShowS | |
Eq SourceType Source # | |
Defined in Ormolu.Config |
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
.
A wrapper for dynamic options.
Constructors
DynOption | |
Fields
|
dynOptionToLocatedStr :: DynOption -> Located String Source #
Convert DynOption
to
.Located
String