Language.PureScript.Publish

Documentation

preparePackage :: FilePath -> FilePath -> PublishOptions -> IO (Either PackageError UploadedPackage)

Attempt to retrieve package metadata from the current directory. Returns a PackageError on failure

preparePackage' :: FilePath -> FilePath -> PublishOptions -> PrepareM UploadedPackage

unsafePreparePackage :: FilePath -> FilePath -> PublishOptions -> IO UploadedPackage

Attempt to retrieve package metadata from the current directory. Calls exitFailure if no package metadata could be retrieved.

data PrepareM a

Instances

Monad PrepareM

Methods

(>>=) :: PrepareM a -> (a -> PrepareM b) -> PrepareM b

(>>) :: PrepareM a -> PrepareM b -> PrepareM b

return :: a -> PrepareM a

fail :: String -> PrepareM a

Functor PrepareM

Methods

fmap :: (a -> b) -> PrepareM a -> PrepareM b

(<$) :: a -> PrepareM b -> PrepareM a

Applicative PrepareM

Methods

pure :: a -> PrepareM a

(<*>) :: PrepareM (a -> b) -> PrepareM a -> PrepareM b

(*>) :: PrepareM a -> PrepareM b -> PrepareM b

(<*) :: PrepareM a -> PrepareM b -> PrepareM a

MonadIO PrepareM

Methods

liftIO :: IO a -> PrepareM a

MonadError PackageError PrepareM

Methods

throwError :: PackageError -> PrepareM a

catchError :: PrepareM a -> (PackageError -> PrepareM a) -> PrepareM a

MonadWriter [PackageWarning] PrepareM

Methods

writer :: (a, [PackageWarning]) -> PrepareM a

tell :: [PackageWarning] -> PrepareM ()

listen :: PrepareM a -> PrepareM (a, [PackageWarning])

pass :: PrepareM (a, [PackageWarning] -> [PackageWarning]) -> PrepareM a

runPrepareM :: PrepareM a -> IO (Either PackageError (a, [PackageWarning]))

warn :: PackageWarning -> PrepareM ()

userError :: UserError -> PrepareM a

internalError :: InternalError -> PrepareM a

otherError :: OtherError -> PrepareM a

data PublishOptions

Constructors

PublishOptions

Fields

• publishGetVersion :: PrepareM (Text, Version)

  How to obtain the version tag and version that the data being generated will refer to.

• publishGetTagTime :: Text -> PrepareM UTCTime
• publishWorkingTreeDirty :: PrepareM ()

  What to do when the working tree is dirty

defaultPublishOptions :: PublishOptions

getGitWorkingTreeStatus :: PrepareM TreeStatus

checkCleanWorkingTree :: PublishOptions -> PrepareM ()

getVersionFromGitTag :: PrepareM (Text, Version)

getManifestRepositoryInfo :: PackageMeta -> PrepareM (GithubUser, GithubRepo)

getModules :: [(PackageName, FilePath)] -> PrepareM ([Module], Map ModuleName PackageName)

getResolvedDependencies :: FilePath -> [PackageName] -> PrepareM [(PackageName, (FilePath, Version))]