Safe Haskell	Safe-Inferred
Language	Haskell2010

Ormolu

Description

A formatter for Haskell source code.

Synopsis

ormolu :: MonadIO m => Config RegionIndices -> FilePath -> String -> m Text
ormoluFile :: MonadIO m => Config RegionIndices -> FilePath -> m Text
ormoluStdin :: MonadIO m => Config RegionIndices -> m Text
data Config region = Config {
- cfgDynOptions :: ![DynOption]
- cfgFixityOverrides :: FixityMap
- cfgDependencies :: !(Set String)
- cfgUnsafe :: !Bool
- cfgDebug :: !Bool
- cfgCheckIdempotence :: !Bool
- cfgSourceType :: !SourceType
- cfgColorMode :: !ColorMode
- cfgRegion :: !region
- cfgPrinterOpts :: !PrinterOptsTotal
}
data ColorMode
- = Never
- | Always
- | Auto
data RegionIndices = RegionIndices {
- regionStartLine :: !(Maybe Int)
- regionEndLine :: !(Maybe Int)
}
data SourceType
- = ModuleSource
- | SignatureSource
defaultConfig :: Config RegionIndices
detectSourceType :: FilePath -> SourceType
newtype DynOption = DynOption {
- unDynOption :: String
}
data PrinterOpts f = PrinterOpts {
- poIndentation :: f Int
- poFunctionArrows :: f FunctionArrowsStyle
- poCommaStyle :: f CommaStyle
- poImportExportStyle :: f ImportExportStyle
- poIndentWheres :: f Bool
- poRecordBraceSpace :: f Bool
- poNewlinesBetweenDecls :: f Int
- poHaddockStyle :: f HaddockPrintStyle
- poRespectful :: f Bool
}
type PrinterOptsPartial = PrinterOpts Maybe
type PrinterOptsTotal = PrinterOpts Identity
defaultPrinterOpts :: PrinterOptsTotal
loadConfigFile :: FilePath -> IO ConfigFileLoadResult
data ConfigFileLoadResult
- = ConfigLoaded FilePath FourmoluConfig
- | ConfigParseError FilePath ParseException
- | ConfigNotFound [FilePath]
configFileName :: FilePath
fillMissingPrinterOpts :: forall f. Applicative f => PrinterOptsPartial -> PrinterOpts f -> PrinterOpts f
data OrmoluException
- = OrmoluParsingFailed SrcSpan String
- | OrmoluOutputParsingFailed SrcSpan String
- | OrmoluASTDiffers TextDiff [RealSrcSpan]
- | OrmoluNonIdempotentOutput TextDiff
- | OrmoluUnrecognizedOpts (NonEmpty String)
- | OrmoluCabalFileParsingFailed FilePath
- | OrmoluMissingStdinInputFile
- | OrmoluFixityOverridesParseError (ParseErrorBundle Text Void)
withPrettyOrmoluExceptions :: ColorMode -> IO ExitCode -> IO ExitCode

Documentation

ormolu Source #

Arguments

:: MonadIO m
=> Config RegionIndices	Ormolu configuration
-> FilePath	Location of source file
-> String	Input to format
-> m Text

Format a String, return formatted version as Text.

The function

Takes String because that's what GHC parser accepts.
Needs IO because some functions from GHC that are necessary to setup parsing context require IO. There should be no visible side-effects though.
Takes file name just to use it in parse error messages.
Throws OrmoluException.

NOTE: The caller is responsible for setting the appropriate value in the cfgSourceType field. Autodetection of source type won't happen here, see detectSourceType.

ormoluFile Source #

Arguments

:: MonadIO m
=> Config RegionIndices	Ormolu configuration
-> FilePath	Location of source file
-> m Text	Resulting rendition

Load a file and format it. The file stays intact and the rendered version is returned as Text.

NOTE: The caller is responsible for setting the appropriate value in the cfgSourceType field. Autodetection of source type won't happen here, see detectSourceType.

ormoluStdin Source #

Arguments

:: MonadIO m
=> Config RegionIndices	Ormolu configuration
-> m Text	Resulting rendition

Read input from stdin and format it.

NOTE: The caller is responsible for setting the appropriate value in the cfgSourceType field. Autodetection of source type won't happen here, see detectSourceType.

data Config region Source #

Ormolu configuration.

Constructors

Config

Fields

cfgDynOptions :: ![DynOption]
Dynamic options to pass to GHC parser
cfgFixityOverrides :: FixityMap
Fixity overrides
cfgDependencies :: !(Set String)
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

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) :: Type -> Type # 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 type Rep (Config region) = D1 ('MetaData "Config" "Ormolu.Config" "fourmolu-0.8.2.0-GosLlu5LFzMIPkpkOEf81J" 'False) (C1 ('MetaCons "Config" 'PrefixI 'True) (((S1 ('MetaSel ('Just "cfgDynOptions") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 [DynOption]) :: S1 ('MetaSel ('Just "cfgFixityOverrides") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 FixityMap)) :: (S1 ('MetaSel ('Just "cfgDependencies") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Set String)) :: (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 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 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.

detectSourceType :: FilePath -> SourceType Source #

Detect SourceType based on the file extension.

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 #

data PrinterOpts f Source #

Options controlling formatting output.

Constructors

PrinterOpts

Fields

poIndentation :: f Int
Number of spaces to use for indentation
poFunctionArrows :: f FunctionArrowsStyle
How to style arrows in type signatures
poCommaStyle :: f CommaStyle
Whether to place commas at start or end of lines
poImportExportStyle :: f ImportExportStyle
Styling of import/export lists
poIndentWheres :: f Bool
Whether to indent `where` blocks
poRecordBraceSpace :: f Bool
Leave space before opening record brace
poNewlinesBetweenDecls :: f Int
Number of newlines between top-level decls
poHaddockStyle :: f HaddockPrintStyle
How to print doc comments
poRespectful :: f Bool
Be less opinionated about spaces/newlines etc.

Instances

Instances details

FromJSON PrinterOptsPartial Source #
Instance details Defined in Ormolu.Config Methods parseJSON :: Value -> Parser PrinterOptsPartial # parseJSONList :: Value -> Parser [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.Types 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) Source #
Instance details Defined in Ormolu.Config.Types 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 :: PrinterOptsTotal Source #

loadConfigFile :: FilePath -> IO ConfigFileLoadResult Source #

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

data ConfigFileLoadResult Source #

The result of calling loadConfigFile.

Constructors

ConfigLoaded FilePath FourmoluConfig
ConfigParseError FilePath ParseException
ConfigNotFound [FilePath]

Instances

Instances details

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

configFileName :: FilePath Source #

Expected file name for YAML config.

fillMissingPrinterOpts :: forall f. Applicative f => PrinterOptsPartial -> 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.

data OrmoluException Source #

Ormolu exception representing all cases when Ormolu can fail.

Constructors

OrmoluParsingFailed SrcSpan String	Parsing of original source code failed
OrmoluOutputParsingFailed SrcSpan String	Parsing of formatted source code failed
OrmoluASTDiffers TextDiff [RealSrcSpan]	Original and resulting ASTs differ
OrmoluNonIdempotentOutput TextDiff	Formatted source code is not idempotent
OrmoluUnrecognizedOpts (NonEmpty String)	Some GHC options were not recognized
OrmoluCabalFileParsingFailed FilePath	Cabal file parsing failed
OrmoluMissingStdinInputFile	Missing input file path when using stdin input and accounting for .cabal files
OrmoluFixityOverridesParseError (ParseErrorBundle Text Void)	A parse error in a fixity overrides file

Instances

Instances details

Exception OrmoluException Source #
Instance details Defined in Ormolu.Exception Methods toException :: OrmoluException -> SomeException # fromException :: SomeException -> Maybe OrmoluException # displayException :: OrmoluException -> String #
Show OrmoluException Source #
Instance details Defined in Ormolu.Exception Methods showsPrec :: Int -> OrmoluException -> ShowS # show :: OrmoluException -> String # showList :: [OrmoluException] -> ShowS #
Eq OrmoluException Source #
Instance details Defined in Ormolu.Exception Methods (==) :: OrmoluException -> OrmoluException -> Bool # (/=) :: OrmoluException -> OrmoluException -> Bool #

withPrettyOrmoluExceptions Source #

Arguments

:: ColorMode	Color mode
-> IO ExitCode	Action that may throw an exception
-> IO ExitCode

Inside this wrapper OrmoluException will be caught and displayed nicely.