Safe Haskell	Safe-Inferred
Language	GHC2021

HaskellWorks.Polysemy.Hedgehog.Workspace

Synopsis

newtype PackagePath = PackagePath {
- filePath :: FilePath
}
newtype ProjectRoot = ProjectRoot {
- filePath :: FilePath
}
newtype Workspace = Workspace {
- filePath :: FilePath
}
workspace :: Member Hedgehog r => Member Log r => Member (Embed IO) r => HasCallStack => FilePath -> Sem (Reader Workspace : r) () -> Sem r ()
moduleWorkspace :: Member Hedgehog r => Member Log r => Member (Embed IO) r => String -> Sem (Reader Workspace : r) () -> Sem r ()
findCabalProjectDir :: Member Hedgehog r => Member (Embed IO) r => Member Log r => FilePath -> Sem r FilePath

Documentation

newtype PackagePath Source #

Constructors

PackagePath
Fields filePath :: FilePath

Instances

Instances details

Show PackagePath Source #
Instance details Defined in HaskellWorks.Polysemy.Hedgehog.Workspace.Types Methods showsPrec :: Int -> PackagePath -> ShowS # show :: PackagePath -> String # showList :: [PackagePath] -> ShowS #
Eq PackagePath Source #
Instance details Defined in HaskellWorks.Polysemy.Hedgehog.Workspace.Types Methods (==) :: PackagePath -> PackagePath -> Bool # (/=) :: PackagePath -> PackagePath -> Bool #

newtype ProjectRoot Source #

Constructors

ProjectRoot
Fields filePath :: FilePath

Instances

Instances details

Show ProjectRoot Source #
Instance details Defined in HaskellWorks.Polysemy.Hedgehog.Workspace.Types Methods showsPrec :: Int -> ProjectRoot -> ShowS # show :: ProjectRoot -> String # showList :: [ProjectRoot] -> ShowS #
Eq ProjectRoot Source #
Instance details Defined in HaskellWorks.Polysemy.Hedgehog.Workspace.Types Methods (==) :: ProjectRoot -> ProjectRoot -> Bool # (/=) :: ProjectRoot -> ProjectRoot -> Bool #

newtype Workspace Source #

Constructors

Workspace
Fields filePath :: FilePath

Instances

Instances details

Generic Workspace Source #
Instance details Defined in HaskellWorks.Polysemy.Hedgehog.Workspace.Types Associated Types type Rep Workspace :: Type -> Type # Methods from :: Workspace -> Rep Workspace x # to :: Rep Workspace x -> Workspace #
Show Workspace Source #
Instance details Defined in HaskellWorks.Polysemy.Hedgehog.Workspace.Types Methods showsPrec :: Int -> Workspace -> ShowS # show :: Workspace -> String # showList :: [Workspace] -> ShowS #
Eq Workspace Source #
Instance details Defined in HaskellWorks.Polysemy.Hedgehog.Workspace.Types Methods (==) :: Workspace -> Workspace -> Bool # (/=) :: Workspace -> Workspace -> Bool #
type Rep Workspace Source #
Instance details Defined in HaskellWorks.Polysemy.Hedgehog.Workspace.Types type Rep Workspace = D1 ('MetaData "Workspace" "HaskellWorks.Polysemy.Hedgehog.Workspace.Types" "hw-polysemy-0.2.5.0-J9kaaFav8QWG5oNAyOWYmb-hedgehog" 'True) (C1 ('MetaCons "Workspace" 'PrefixI 'True) (S1 ('MetaSel ('Just "filePath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 FilePath)))

workspace :: Member Hedgehog r => Member Log r => Member (Embed IO) r => HasCallStack => FilePath -> Sem (Reader Workspace : r) () -> Sem r () Source #

Create a workspace directory which will exist for at least the duration of the supplied block.

The directory will have the supplied prefix but contain a generated random suffix to prevent interference between tests

The directory will be deleted if the block succeeds, but left behind if the block fails.

moduleWorkspace :: Member Hedgehog r => Member Log r => Member (Embed IO) r => String -> Sem (Reader Workspace : r) () -> Sem r () Source #

Create a workspace directory which will exist for at least the duration of the supplied block.

The directory will have the prefix as "$prefixPath/$moduleName" but contain a generated random suffix to prevent interference between tests

The directory will be deleted if the block succeeds, but left behind if the block fails.

The prefix argument should not contain directory delimeters.

findCabalProjectDir :: Member Hedgehog r => Member (Embed IO) r => Member Log r => FilePath -> Sem r FilePath Source #

Compute the project base. This will be the first parent directory that contains the `cabal.project` file. This should should point to the root directory of the Github project checkout.