Safe Haskell	None
Language	Haskell2010

Parochial.Options

Synopsis

data Config w
- = Haddock {
  - target :: w ::: (Maybe FilePath <?> "Target directory")
  - project :: w ::: (Maybe Text <?> "The name of the project. Default to project name derived from $CWD")
  - state :: w ::: (Maybe FilePath <?> "The state file")
  }
- | Hoogle {
  - target :: w ::: (Maybe FilePath <?> "Target directory")
  - project :: w ::: (Maybe Text <?> "The name of the project. Default to project name derived from $CWD")
  - state :: w ::: (Maybe FilePath <?> "The state file")
  }
getCurrentProject :: Maybe Text -> IO Text
defaultTarget :: Maybe FilePath -> Target
getAndMkTargetPath :: Maybe Text -> Maybe FilePath -> IO Target
getState :: Maybe FilePath -> IO FilePath
parseCmdOptions :: MonadIO m => m (Config Unwrapped)

Documentation

data Config w Source #

Constructors

Haddock
Fields target :: w ::: (Maybe FilePath <?> "Target directory") project :: w ::: (Maybe Text <?> "The name of the project. Default to project name derived from $CWD") state :: w ::: (Maybe FilePath <?> "The state file")
Hoogle
Fields target :: w ::: (Maybe FilePath <?> "Target directory") project :: w ::: (Maybe Text <?> "The name of the project. Default to project name derived from $CWD") state :: w ::: (Maybe FilePath <?> "The state file")

Instances

Instances details

Show (Config Unwrapped) Source #
Instance details Defined in Parochial.Options Methods showsPrec :: Int -> Config Unwrapped -> ShowS # show :: Config Unwrapped -> String # showList :: [Config Unwrapped] -> ShowS #
Generic (Config w) Source #
Instance details Defined in Parochial.Options Associated Types type Rep (Config w) :: Type -> Type # Methods from :: Config w -> Rep (Config w) x # to :: Rep (Config w) x -> Config w #
ParseRecord (Config Wrapped) Source #
Instance details Defined in Parochial.Options Methods parseRecord :: Parser (Config Wrapped) #
type Rep (Config w) Source #
Instance details Defined in Parochial.Options type Rep (Config w) = D1 ('MetaData "Config" "Parochial.Options" "parochial-0.1.0.0-JMm8wvlYvn48ng9JX0SLmo" 'False) (C1 ('MetaCons "Haddock" 'PrefixI 'True) (S1 ('MetaSel ('Just "target") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (w ::: (Maybe FilePath <?> "Target directory"))) :: (S1 ('MetaSel ('Just "project") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (w ::: (Maybe Text <?> "The name of the project. Default to project name derived from $CWD"))) :: S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (w ::: (Maybe FilePath <?> "The state file"))))) :+: C1 ('MetaCons "Hoogle" 'PrefixI 'True) (S1 ('MetaSel ('Just "target") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (w ::: (Maybe FilePath <?> "Target directory"))) :: (S1 ('MetaSel ('Just "project") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (w ::: (Maybe Text <?> "The name of the project. Default to project name derived from $CWD"))) :: S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (w ::: (Maybe FilePath <?> "The state file"))))))

getCurrentProject :: Maybe Text -> IO Text Source #

defaultTarget :: Maybe FilePath -> Target Source #

getAndMkTargetPath :: Maybe Text -> Maybe FilePath -> IO Target Source #

getState :: Maybe FilePath -> IO FilePath Source #

Takes the value from either the --state option or tries to find the setup-config itself.

parseCmdOptions :: MonadIO m => m (Config Unwrapped) Source #