Distribution.Pretty

Documentation

class Pretty a where

Minimal complete definition

pretty

Methods

pretty :: a -> Doc

prettyVersioned :: CabalSpecVersion -> a -> Doc

Instances

Pretty Bool

Defined in Distribution.Pretty

Methods

pretty :: Bool -> Doc

prettyVersioned :: CabalSpecVersion -> Bool -> Doc

Pretty Int

Defined in Distribution.Pretty

Methods

pretty :: Int -> Doc

prettyVersioned :: CabalSpecVersion -> Int -> Doc

Pretty Doc

Since: 3.4.0.0

Defined in Distribution.Pretty

Methods

pretty :: Doc -> Doc

prettyVersioned :: CabalSpecVersion -> Doc -> Doc

Pretty Version

Defined in Distribution.Types.Version

Methods

pretty :: Version -> Doc

prettyVersioned :: CabalSpecVersion -> Version -> Doc

Pretty VersionRange

>>> fmap pretty (simpleParsec' CabalSpecV1_6 "== 3.2.*" :: Maybe VersionRange)
Just >=3.2 && <3.3

>>> fmap (prettyVersioned CabalSpecV1_6) (simpleParsec' CabalSpecV1_6 "== 3.2.*" :: Maybe VersionRange)
Just ==3.2.*

>>> fmap pretty (simpleParsec' CabalSpecV1_6 "-any" :: Maybe VersionRange)
Just >=0

>>> fmap (prettyVersioned CabalSpecV1_6) (simpleParsec' CabalSpecV1_6 "-any" :: Maybe VersionRange)
Just >=0

Defined in Distribution.Types.VersionRange.Internal

Methods

pretty :: VersionRange -> Doc

prettyVersioned :: CabalSpecVersion -> VersionRange -> Doc

Pretty RepoType

Defined in Distribution.Types.SourceRepo

Methods

pretty :: RepoType -> Doc

prettyVersioned :: CabalSpecVersion -> RepoType -> Doc

Pretty KnownRepoType

Defined in Distribution.Types.SourceRepo

Methods

pretty :: KnownRepoType -> Doc

prettyVersioned :: CabalSpecVersion -> KnownRepoType -> Doc

Pretty RepoKind

Defined in Distribution.Types.SourceRepo

Methods

pretty :: RepoKind -> Doc

prettyVersioned :: CabalSpecVersion -> RepoKind -> Doc

Pretty PkgconfigName

Defined in Distribution.Types.PkgconfigName

Methods

pretty :: PkgconfigName -> Doc

prettyVersioned :: CabalSpecVersion -> PkgconfigName -> Doc

Pretty PkgconfigDependency

Defined in Distribution.Types.PkgconfigDependency

Methods

pretty :: PkgconfigDependency -> Doc

prettyVersioned :: CabalSpecVersion -> PkgconfigDependency -> Doc

Pretty PackageName

Defined in Distribution.Types.PackageName

Methods

pretty :: PackageName -> Doc

prettyVersioned :: CabalSpecVersion -> PackageName -> Doc

Pretty UnqualComponentName

Defined in Distribution.Types.UnqualComponentName

Methods

pretty :: UnqualComponentName -> Doc

prettyVersioned :: CabalSpecVersion -> UnqualComponentName -> Doc

Pretty LibraryVisibility

Defined in Distribution.Types.LibraryVisibility

Methods

pretty :: LibraryVisibility -> Doc

prettyVersioned :: CabalSpecVersion -> LibraryVisibility -> Doc

Pretty ForeignLibType

Defined in Distribution.Types.ForeignLibType

Methods

pretty :: ForeignLibType -> Doc

prettyVersioned :: CabalSpecVersion -> ForeignLibType -> Doc

Pretty ForeignLibOption

Defined in Distribution.Types.ForeignLibOption

Methods

pretty :: ForeignLibOption -> Doc

prettyVersioned :: CabalSpecVersion -> ForeignLibOption -> Doc

Pretty FlagAssignment

Since: 3.4.0.0

Defined in Distribution.Types.Flag

Methods

pretty :: FlagAssignment -> Doc

prettyVersioned :: CabalSpecVersion -> FlagAssignment -> Doc

Pretty FlagName

Defined in Distribution.Types.Flag

Methods

pretty :: FlagName -> Doc

prettyVersioned :: CabalSpecVersion -> FlagName -> Doc

Pretty ExecutableScope

Defined in Distribution.Types.ExecutableScope

Methods

pretty :: ExecutableScope -> Doc

prettyVersioned :: CabalSpecVersion -> ExecutableScope -> Doc

Pretty ComponentName

Defined in Distribution.Types.ComponentName

Methods

pretty :: ComponentName -> Doc

prettyVersioned :: CabalSpecVersion -> ComponentName -> Doc

Pretty ComponentId

Defined in Distribution.Types.ComponentId

Methods

pretty :: ComponentId -> Doc

prettyVersioned :: CabalSpecVersion -> ComponentId -> Doc

Pretty BuildType

Defined in Distribution.Types.BuildType

Methods

pretty :: BuildType -> Doc

prettyVersioned :: CabalSpecVersion -> BuildType -> Doc

Pretty AbiHash

Defined in Distribution.Types.AbiHash

Methods

pretty :: AbiHash -> Doc

prettyVersioned :: CabalSpecVersion -> AbiHash -> Doc

Pretty Platform

Defined in Distribution.System

Methods

pretty :: Platform -> Doc

prettyVersioned :: CabalSpecVersion -> Platform -> Doc

Pretty Arch

Defined in Distribution.System

Methods

pretty :: Arch -> Doc

prettyVersioned :: CabalSpecVersion -> Arch -> Doc

Pretty OS

Defined in Distribution.System

Methods

pretty :: OS -> Doc

prettyVersioned :: CabalSpecVersion -> OS -> Doc

Pretty LicenseRef

Defined in Distribution.SPDX.LicenseReference

Methods

pretty :: LicenseRef -> Doc

prettyVersioned :: CabalSpecVersion -> LicenseRef -> Doc

Pretty LicenseId

Defined in Distribution.SPDX.LicenseId

Methods

pretty :: LicenseId -> Doc

prettyVersioned :: CabalSpecVersion -> LicenseId -> Doc

Pretty LicenseExceptionId

Defined in Distribution.SPDX.LicenseExceptionId

Methods

pretty :: LicenseExceptionId -> Doc

prettyVersioned :: CabalSpecVersion -> LicenseExceptionId -> Doc

Pretty SimpleLicenseExpression

Defined in Distribution.SPDX.LicenseExpression

Methods

pretty :: SimpleLicenseExpression -> Doc

prettyVersioned :: CabalSpecVersion -> SimpleLicenseExpression -> Doc

Pretty LicenseExpression

Defined in Distribution.SPDX.LicenseExpression

Methods

pretty :: LicenseExpression -> Doc

prettyVersioned :: CabalSpecVersion -> LicenseExpression -> Doc

Pretty License

Defined in Distribution.SPDX.License

Methods

pretty :: License -> Doc

prettyVersioned :: CabalSpecVersion -> License -> Doc

Pretty ModuleName

Defined in Distribution.ModuleName

Methods

pretty :: ModuleName -> Doc

prettyVersioned :: CabalSpecVersion -> ModuleName -> Doc

Pretty Verbosity

Defined in Distribution.Verbosity

Methods

pretty :: Verbosity -> Doc

prettyVersioned :: CabalSpecVersion -> Verbosity -> Doc

Pretty TestType

Defined in Distribution.Types.TestType

Methods

pretty :: TestType -> Doc

prettyVersioned :: CabalSpecVersion -> TestType -> Doc

Pretty PackageIdentifier

Defined in Distribution.Types.PackageId

Methods

pretty :: PackageIdentifier -> Doc

prettyVersioned :: CabalSpecVersion -> PackageIdentifier -> Doc

Pretty DefUnitId

Defined in Distribution.Types.UnitId

Methods

pretty :: DefUnitId -> Doc

prettyVersioned :: CabalSpecVersion -> DefUnitId -> Doc

Pretty UnitId

The textual format for UnitId coincides with the format GHC accepts for -package-id.

Defined in Distribution.Types.UnitId

Methods

pretty :: UnitId -> Doc

prettyVersioned :: CabalSpecVersion -> UnitId -> Doc

Pretty Module

Defined in Distribution.Types.Module

Methods

pretty :: Module -> Doc

prettyVersioned :: CabalSpecVersion -> Module -> Doc

Pretty ExposedModule

Defined in Distribution.Types.ExposedModule

Methods

pretty :: ExposedModule -> Doc

prettyVersioned :: CabalSpecVersion -> ExposedModule -> Doc

Pretty PackageVersionConstraint

Defined in Distribution.Types.PackageVersionConstraint

Methods

pretty :: PackageVersionConstraint -> Doc

prettyVersioned :: CabalSpecVersion -> PackageVersionConstraint -> Doc

Pretty MungedPackageId

>>> prettyShow $ MungedPackageId (MungedPackageName "servant" LMainLibName) (mkVersion [1,2,3])
"servant-1.2.3"

>>> prettyShow $ MungedPackageId (MungedPackageName "servant" (LSubLibName "lackey")) (mkVersion [0,1,2])
"z-servant-z-lackey-0.1.2"

Defined in Distribution.Types.MungedPackageId

Methods

pretty :: MungedPackageId -> Doc

prettyVersioned :: CabalSpecVersion -> MungedPackageId -> Doc

Pretty LegacyExeDependency

Defined in Distribution.Types.LegacyExeDependency

Methods

pretty :: LegacyExeDependency -> Doc

prettyVersioned :: CabalSpecVersion -> LegacyExeDependency -> Doc

Pretty ExeDependency

Defined in Distribution.Types.ExeDependency

Methods

pretty :: ExeDependency -> Doc

prettyVersioned :: CabalSpecVersion -> ExeDependency -> Doc

Pretty Dependency

>>> prettyShow $ Dependency "pkg" anyVersion mainLibSet
"pkg"

>>> prettyShow $ Dependency "pkg" anyVersion $ NES.insert (LSubLibName "sublib") mainLibSet
"pkg:{pkg, sublib}"

>>> prettyShow $ Dependency "pkg" anyVersion $ NES.singleton (LSubLibName "sublib")
"pkg:sublib"

>>> prettyShow $ Dependency "pkg" anyVersion $ NES.insert (LSubLibName "sublib-b") $ NES.singleton (LSubLibName "sublib-a")
"pkg:{sublib-a, sublib-b}"

Defined in Distribution.Types.Dependency

Methods

pretty :: Dependency -> Doc

prettyVersioned :: CabalSpecVersion -> Dependency -> Doc

Pretty BenchmarkType

Defined in Distribution.Types.BenchmarkType

Methods

pretty :: BenchmarkType -> Doc

prettyVersioned :: CabalSpecVersion -> BenchmarkType -> Doc

Pretty AbiDependency

Defined in Distribution.Types.AbiDependency

Methods

pretty :: AbiDependency -> Doc

prettyVersioned :: CabalSpecVersion -> AbiDependency -> Doc

Pretty License

Defined in Distribution.License

Methods

pretty :: License -> Doc

prettyVersioned :: CabalSpecVersion -> License -> Doc

Pretty KnownExtension

Defined in Language.Haskell.Extension

Methods

pretty :: KnownExtension -> Doc

prettyVersioned :: CabalSpecVersion -> KnownExtension -> Doc

Pretty Extension

Defined in Language.Haskell.Extension

Methods

pretty :: Extension -> Doc

prettyVersioned :: CabalSpecVersion -> Extension -> Doc

Pretty Language

Defined in Language.Haskell.Extension

Methods

pretty :: Language -> Doc

prettyVersioned :: CabalSpecVersion -> Language -> Doc

Pretty AbiTag

Defined in Distribution.Compiler

Methods

pretty :: AbiTag -> Doc

prettyVersioned :: CabalSpecVersion -> AbiTag -> Doc

Pretty CompilerId

Defined in Distribution.Compiler

Methods

pretty :: CompilerId -> Doc

prettyVersioned :: CabalSpecVersion -> CompilerId -> Doc

Pretty CompilerFlavor

Defined in Distribution.Compiler

Methods

pretty :: CompilerFlavor -> Doc

prettyVersioned :: CabalSpecVersion -> CompilerFlavor -> Doc

Pretty LibVersionInfo

Defined in Distribution.Types.ForeignLib

Methods

pretty :: LibVersionInfo -> Doc

prettyVersioned :: CabalSpecVersion -> LibVersionInfo -> Doc

Pretty TestedWith

Defined in Distribution.FieldGrammar.Newtypes

Methods

pretty :: TestedWith -> Doc

prettyVersioned :: CabalSpecVersion -> TestedWith -> Doc

Pretty SpecLicense

Defined in Distribution.FieldGrammar.Newtypes

Methods

pretty :: SpecLicense -> Doc

prettyVersioned :: CabalSpecVersion -> SpecLicense -> Doc

Pretty SpecVersion

Defined in Distribution.FieldGrammar.Newtypes

Methods

pretty :: SpecVersion -> Doc

prettyVersioned :: CabalSpecVersion -> SpecVersion -> Doc

Pretty FilePathNT

Defined in Distribution.FieldGrammar.Newtypes

Methods

pretty :: FilePathNT -> Doc

prettyVersioned :: CabalSpecVersion -> FilePathNT -> Doc

Pretty Token'

Defined in Distribution.FieldGrammar.Newtypes

Methods

pretty :: Token' -> Doc

prettyVersioned :: CabalSpecVersion -> Token' -> Doc

Pretty Token

Defined in Distribution.FieldGrammar.Newtypes

Methods

pretty :: Token -> Doc

prettyVersioned :: CabalSpecVersion -> Token -> Doc

Pretty TestShowDetails

Defined in Distribution.Simple.Setup

Methods

pretty :: TestShowDetails -> Doc

prettyVersioned :: CabalSpecVersion -> TestShowDetails -> Doc

Pretty HaddockTarget

Defined in Distribution.Simple.Setup

Methods

pretty :: HaddockTarget -> Doc

prettyVersioned :: CabalSpecVersion -> HaddockTarget -> Doc

FieldGrammar Pretty PrettyFieldGrammar

Defined in Distribution.FieldGrammar.Pretty

Methods

blurFieldGrammar :: ALens' a b -> PrettyFieldGrammar b d -> PrettyFieldGrammar a d

uniqueFieldAla :: (Pretty b, Newtype a b) => FieldName -> (a -> b) -> ALens' s a -> PrettyFieldGrammar s a

booleanFieldDef :: FieldName -> ALens' s Bool -> Bool -> PrettyFieldGrammar s Bool

optionalFieldAla :: (Pretty b, Newtype a b) => FieldName -> (a -> b) -> ALens' s (Maybe a) -> PrettyFieldGrammar s (Maybe a)

optionalFieldDefAla :: (Pretty b, Newtype a b, Eq a) => FieldName -> (a -> b) -> ALens' s a -> a -> PrettyFieldGrammar s a

freeTextField :: FieldName -> ALens' s (Maybe String) -> PrettyFieldGrammar s (Maybe String)

freeTextFieldDef :: FieldName -> ALens' s String -> PrettyFieldGrammar s String

freeTextFieldDefST :: FieldName -> ALens' s ShortText -> PrettyFieldGrammar s ShortText

monoidalFieldAla :: (Pretty b, Monoid a, Newtype a b) => FieldName -> (a -> b) -> ALens' s a -> PrettyFieldGrammar s a

prefixedFields :: FieldName -> ALens' s [(String, String)] -> PrettyFieldGrammar s [(String, String)]

knownField :: FieldName -> PrettyFieldGrammar s ()

hiddenField :: PrettyFieldGrammar s a -> PrettyFieldGrammar s a

deprecatedSince :: CabalSpecVersion -> String -> PrettyFieldGrammar s a -> PrettyFieldGrammar s a

removedIn :: CabalSpecVersion -> String -> PrettyFieldGrammar s a -> PrettyFieldGrammar s a

availableSince :: CabalSpecVersion -> a -> PrettyFieldGrammar s a -> PrettyFieldGrammar s a

Pretty a => Pretty (Identity a)

Defined in Distribution.Pretty

Methods

pretty :: Identity a -> Doc

prettyVersioned :: CabalSpecVersion -> Identity a -> Doc

Pretty a => Pretty (MQuoted a)

Defined in Distribution.FieldGrammar.Newtypes

Methods

pretty :: MQuoted a -> Doc

prettyVersioned :: CabalSpecVersion -> MQuoted a -> Doc

(Newtype a b, Sep sep, Pretty b) => Pretty (Set' sep b a)

Defined in Distribution.FieldGrammar.Newtypes

Methods

pretty :: Set' sep b a -> Doc

prettyVersioned :: CabalSpecVersion -> Set' sep b a -> Doc

(Newtype a b, Sep sep, Pretty b) => Pretty (List sep b a)

Defined in Distribution.FieldGrammar.Newtypes

Methods

pretty :: List sep b a -> Doc

prettyVersioned :: CabalSpecVersion -> List sep b a -> Doc

prettyShow :: Pretty a => a -> String

defaultStyle :: Style

The default rendering style used in Cabal for console output. It has a fixed page width and adds line breaks automatically.

flatStyle :: Style

A style for rendering all on one line.

Utilities

showFilePath :: FilePath -> Doc

showToken :: String -> Doc

showFreeText :: String -> Doc

Pretty-print free-format text, ensuring that it is vertically aligned, and with blank lines replaced by dots for correct re-parsing.

showFreeTextV3 :: String -> Doc

Pretty-print free-format text. Since cabal-version: 3.0 we don't replace blank lines with dots.

Since: 3.0.0.0

Deprecated

type Separator = [Doc] -> Doc