Aura.Core

Core types and functions which belong nowhere else.

Types

newtype Repository

A Repository is a place where packages may be fetched from. Multiple repositories can be combined with the Semigroup instance. Checks packages in batches for efficiency.

Constructors

Repository

Fields

• repoLookup :: Settings -> NonEmptySet PkgName -> IO (Maybe (Set PkgName, Set Package))

Instances

Semigroup Repository

Defined in Aura.Core

Methods

(<>) :: Repository -> Repository -> Repository

sconcat :: NonEmpty Repository -> Repository

stimes :: Integral b => b -> Repository -> Repository

liftEither :: Member (Error a) r => Either a b -> Eff r b

Lift a common return type into the Eff world. Usually used after a pacman call.

liftEitherM :: (Member (Error a) r, Member m r) => m (Either a b) -> Eff r b

Like liftEither, but the Either can be embedded in something else, usually a Monad.

liftMaybe :: Member (Error a) r => a -> Maybe b -> Eff r b

Like liftEither, but for Maybe.

liftMaybeM :: (Member (Error a) r, Member m r) => a -> m (Maybe b) -> Eff r b

Like liftEitherM, but for Maybe.

User Privileges

sudo :: (Member (Reader Settings) r, Member (Error Failure) r) => Eff r a -> Eff r a

Action won't be allowed unless user is root, or using sudo.

trueRoot :: (Member (Reader Settings) r, Member (Error Failure) r) => Eff r a -> Eff r a

Stop the user if they are the true root. Building as root isn't allowed since makepkg v4.2.

Querying the Package Database

foreignPackages :: IO (Set SimplePkg)

A list of non-prebuilt packages installed on the system. `-Qm` yields a list of sorted values.

orphans :: IO (Set PkgName)

Packages marked as a dependency, yet are required by no other package.

develPkgs :: IO (Set PkgName)

Any package whose name is suffixed by git, hg, svn, darcs, cvs, or bzr.

isSatisfied :: Dep -> IO Bool

True if a dependency is satisfied by an installed package. asT renders the VersionDemand into the specific form that `pacman -T` understands. See `man pacman` for more info.

isInstalled :: PkgName -> IO (Maybe PkgName)

Returns what it was given if the package is already installed. Reasoning: Using raw bools can be less expressive.

checkDBLock :: Settings -> IO ()

Block further action until the database is free.

Misc. Package Handling

removePkgs :: (Member (Reader Settings) r, Member (Error Failure) r, Member IO r) => NonEmptySet PkgName -> Eff r ()

An -Rsu call.

partitionPkgs :: NonEmpty (NonEmptySet Package) -> ([Prebuilt], [NonEmptySet Buildable])

Partition a list of packages into pacman and buildable groups. Yes, this is the correct signature. As far as this function (in isolation) is concerned, there is no way to guarantee that the list of NonEmptySets will itself be non-empty.

packageBuildable :: Settings -> Buildable -> IO Package

Package a Buildable, running the customization handler first.

IO

notify :: Settings -> Doc AnsiStyle -> IO ()

Print some message in green with Aura flair.

warn :: Settings -> Doc AnsiStyle -> IO ()

Print some message in yellow with Aura flair.

scold :: Settings -> Doc AnsiStyle -> IO ()

Print some message in red with Aura flair.

report :: (Member (Reader Settings) r, Member IO r) => (Doc AnsiStyle -> Doc AnsiStyle) -> (Language -> Doc AnsiStyle) -> NonEmpty PkgName -> Eff r ()

Report a message with multiple associated items. Usually a list of naughty packages.