Safe Haskell	Safe-Inferred
Language	Haskell2010

PbtCli.Doctor

Description

pbt-cli doctor: check that everything the tool needs is present and that the repository in front of it is actually discoverable.

Modelled on the --check-health mode of the shell tools it replaces, with the same rule about what counts as a failure: only a missing *required* dependency or an undiscoverable root is an error. Version strings are informational and no minimum is ever enforced, because pbt-cli only shells out to cabal and does not care which version answers.

Synopsis

doctor :: FilePath -> IO ExitCode
data Check = Check {
- chkName :: String
- chkStatus :: Status
- chkDetail :: String
}
data Status
- = Ok
- | Warn
- | Missing

Documentation

doctor :: FilePath -> IO ExitCode Source #

Run every check against root, print an aligned report, and return the exit code: ExitFailure 1 if anything is Missing.

data Check Source #

Constructors

Check
Fields chkName :: String chkStatus :: Status chkDetail :: String

Instances

Instances details

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

data Status Source #

How a single check turned out.

Constructors

Ok
Warn	present-but-notable, or an absent optional dependency.
Missing	a required dependency is missing, or the repo cannot be scanned.

Instances

Instances details

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