Rib.Cli

Documentation

data CliConfig

Constructors

CliConfig

Fields

• rebuildAll :: Bool

  Whether to rebuild all sources in Shake.

• watch :: Bool

  Whether to monitor inputDir for changes and re-generate

• serve :: Maybe (Text, Int)

  Whether to run a HTTP server on outputDir

• verbosity :: Verbosity

  Shake's verbosity level.

  Setting this to Silent will affect Rib's own logging as well.

• inputDir :: FilePath

  Directory from which source content will be read.

• outputDir :: FilePath

  The path where static files will be generated. Rib's server uses this directory when serving files.

• shakeDbDir :: FilePath

  Path to shake's database directory.

• watchIgnore :: [FilePath]

  List of relative paths to ignore when watching the source directory

Instances

Eq CliConfig

Defined in Rib.Cli

Methods

(==) :: CliConfig -> CliConfig -> Bool

(/=) :: CliConfig -> CliConfig -> Bool

Show CliConfig

Defined in Rib.Cli

Methods

showsPrec :: Int -> CliConfig -> ShowS

show :: CliConfig -> String

showList :: [CliConfig] -> ShowS

Generic CliConfig

Defined in Rib.Cli

Associated Types

type Rep CliConfig :: Type -> Type

Methods

from :: CliConfig -> Rep CliConfig x

to :: Rep CliConfig x -> CliConfig

type Rep CliConfig

Defined in Rib.Cli

type Rep CliConfig = D1 (MetaData "CliConfig" "Rib.Cli" "rib-0.12.0.0-Ih4s1KTin294dAvqHH08YB" False) (C1 (MetaCons "CliConfig" PrefixI True) (((S1 (MetaSel (Just "rebuildAll") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool) :*: S1 (MetaSel (Just "watch") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool)) :*: (S1 (MetaSel (Just "serve") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe (Text, Int))) :*: S1 (MetaSel (Just "verbosity") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Verbosity))) :*: ((S1 (MetaSel (Just "inputDir") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 FilePath) :*: S1 (MetaSel (Just "outputDir") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 FilePath)) :*: (S1 (MetaSel (Just "shakeDbDir") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 FilePath) :*: S1 (MetaSel (Just "watchIgnore") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [FilePath])))))

cliParser :: FilePath -> FilePath -> Parser CliConfig

data Verbosity

The verbosity data type, used by shakeVerbosity.

Constructors

Silent

Don't print any messages.

Error

Only print error messages.

Warn

Print errors and warnings.

Info

Print errors, warnings and # command-name (for file-name) when running a traced command.

Verbose

Print errors, warnings, full command lines when running a command or cmd command and status messages when starting a rule.

Diagnostic

Print messages for virtually everything (mostly for debugging).

Instances

Bounded Verbosity

Defined in Development.Shake.Internal.Options

Methods

minBound :: Verbosity

maxBound :: Verbosity

Enum Verbosity

Defined in Development.Shake.Internal.Options

Methods

succ :: Verbosity -> Verbosity

pred :: Verbosity -> Verbosity

toEnum :: Int -> Verbosity

fromEnum :: Verbosity -> Int

enumFrom :: Verbosity -> [Verbosity]

enumFromThen :: Verbosity -> Verbosity -> [Verbosity]

enumFromTo :: Verbosity -> Verbosity -> [Verbosity]

enumFromThenTo :: Verbosity -> Verbosity -> Verbosity -> [Verbosity]

Eq Verbosity

Defined in Development.Shake.Internal.Options

Methods

(==) :: Verbosity -> Verbosity -> Bool

(/=) :: Verbosity -> Verbosity -> Bool

Data Verbosity

Defined in Development.Shake.Internal.Options

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Verbosity -> c Verbosity

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Verbosity

toConstr :: Verbosity -> Constr

dataTypeOf :: Verbosity -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Verbosity)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Verbosity)

gmapT :: (forall b. Data b => b -> b) -> Verbosity -> Verbosity

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Verbosity -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Verbosity -> r

gmapQ :: (forall d. Data d => d -> u) -> Verbosity -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> Verbosity -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Verbosity -> m Verbosity

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Verbosity -> m Verbosity

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Verbosity -> m Verbosity

Ord Verbosity

Defined in Development.Shake.Internal.Options

Methods

compare :: Verbosity -> Verbosity -> Ordering

(<) :: Verbosity -> Verbosity -> Bool

(<=) :: Verbosity -> Verbosity -> Bool

(>) :: Verbosity -> Verbosity -> Bool

(>=) :: Verbosity -> Verbosity -> Bool

max :: Verbosity -> Verbosity -> Verbosity

min :: Verbosity -> Verbosity -> Verbosity

Read Verbosity

Defined in Development.Shake.Internal.Options

Methods

readsPrec :: Int -> ReadS Verbosity

readList :: ReadS [Verbosity]

readPrec :: ReadPrec Verbosity

readListPrec :: ReadPrec [Verbosity]

Show Verbosity

Defined in Development.Shake.Internal.Options

Methods

showsPrec :: Int -> Verbosity -> ShowS

show :: Verbosity -> String

showList :: [Verbosity] -> ShowS

Parser helpers

directoryReader :: ReadM FilePath

Like str but adds a trailing slash if there isn't one.

watchOption :: Parser Bool

serveOption :: Parser (Maybe (Text, Int))

Internal

hostPortParser :: Parsec Void Text (Text, Int)