System.Hapistrano.Commands

Collection of type safe shell commands that can be fed into runCommand.

Documentation

class Command a where

Class for data types that represent shell commands in typed way.

Minimal complete definition

renderCommand, parseResult

Associated Types

type Result a :: *

Type of result.

Methods

renderCommand :: a -> String

How to render the command before feeding it into shell (possibly via SSH).

parseResult :: Proxy a -> String -> Result a

How to parse the result from stdout.

Instances

Command GenericCommand

Associated Types

type Result GenericCommand :: *

Methods

renderCommand :: GenericCommand -> String

parseResult :: Proxy * GenericCommand -> String -> Result GenericCommand

Command GitReset

Associated Types

type Result GitReset :: *

Methods

renderCommand :: GitReset -> String

parseResult :: Proxy * GitReset -> String -> Result GitReset

Command GitFetch

Associated Types

type Result GitFetch :: *

Methods

renderCommand :: GitFetch -> String

parseResult :: Proxy * GitFetch -> String -> Result GitFetch

Command GitClone

Associated Types

type Result GitClone :: *

Methods

renderCommand :: GitClone -> String

parseResult :: Proxy * GitClone -> String -> Result GitClone

Command Touch

Associated Types

type Result Touch :: *

Methods

renderCommand :: Touch -> String

parseResult :: Proxy * Touch -> String -> Result Touch

Command Ls

Associated Types

type Result Ls :: *

Methods

renderCommand :: Ls -> String

parseResult :: Proxy * Ls -> String -> Result Ls

Command Ln

Associated Types

type Result Ln :: *

Methods

renderCommand :: Ln -> String

parseResult :: Proxy * Ln -> String -> Result Ln

Command Rm

Associated Types

type Result Rm :: *

Methods

renderCommand :: Rm -> String

parseResult :: Proxy * Rm -> String -> Result Rm

Command MkDir

Associated Types

type Result MkDir :: *

Methods

renderCommand :: MkDir -> String

parseResult :: Proxy * MkDir -> String -> Result MkDir

Command Whoami

Associated Types

type Result Whoami :: *

Methods

renderCommand :: Whoami -> String

parseResult :: Proxy * Whoami -> String -> Result Whoami

Command (Find File)

Associated Types

type Result (Find File) :: *

Methods

renderCommand :: Find File -> String

parseResult :: Proxy * (Find File) -> String -> Result (Find File)

Command (Find Dir)

Associated Types

type Result (Find Dir) :: *

Methods

renderCommand :: Find Dir -> String

parseResult :: Proxy * (Find Dir) -> String -> Result (Find Dir)

Command (Readlink File)

Associated Types

type Result (Readlink File) :: *

Methods

renderCommand :: Readlink File -> String

parseResult :: Proxy * (Readlink File) -> String -> Result (Readlink File)

Command (Readlink Dir)

Associated Types

type Result (Readlink Dir) :: *

Methods

renderCommand :: Readlink Dir -> String

parseResult :: Proxy * (Readlink Dir) -> String -> Result (Readlink Dir)

Command (Mv File)

Associated Types

type Result (Mv File) :: *

Methods

renderCommand :: Mv File -> String

parseResult :: Proxy * (Mv File) -> String -> Result (Mv File)

Command (Mv Dir)

Associated Types

type Result (Mv Dir) :: *

Methods

renderCommand :: Mv Dir -> String

parseResult :: Proxy * (Mv Dir) -> String -> Result (Mv Dir)

Command cmd => Command (Cd cmd)

Associated Types

type Result (Cd cmd) :: *

Methods

renderCommand :: Cd cmd -> String

parseResult :: Proxy * (Cd cmd) -> String -> Result (Cd cmd)

data Whoami

Unix whoami.

Constructors

Whoami

Instances

Eq Whoami

Methods

(==) :: Whoami -> Whoami -> Bool

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

Ord Whoami

Methods

compare :: Whoami -> Whoami -> Ordering

(<) :: Whoami -> Whoami -> Bool

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

(>) :: Whoami -> Whoami -> Bool

(>=) :: Whoami -> Whoami -> Bool

max :: Whoami -> Whoami -> Whoami

min :: Whoami -> Whoami -> Whoami

Show Whoami

Methods

showsPrec :: Int -> Whoami -> ShowS

show :: Whoami -> String

showList :: [Whoami] -> ShowS

Command Whoami

Associated Types

type Result Whoami :: *

Methods

renderCommand :: Whoami -> String

parseResult :: Proxy * Whoami -> String -> Result Whoami

type Result Whoami

type Result Whoami = String

data Cd cmd

Specify directory in which to perform another command.

Constructors

Cd (Path Abs Dir) cmd

Instances

Command cmd => Command (Cd cmd)

Associated Types

type Result (Cd cmd) :: *

Methods

renderCommand :: Cd cmd -> String

parseResult :: Proxy * (Cd cmd) -> String -> Result (Cd cmd)

type Result (Cd cmd)

type Result (Cd cmd) = Result cmd

data MkDir

Create a directory. Does not fail if the directory already exists.

Constructors

MkDir (Path Abs Dir)

Instances

Command MkDir

Associated Types

type Result MkDir :: *

Methods

renderCommand :: MkDir -> String

parseResult :: Proxy * MkDir -> String -> Result MkDir

type Result MkDir

type Result MkDir = ()

data Rm where

Delete file or directory.

Constructors

Rm :: Path Abs t -> Rm

Instances

Command Rm

Associated Types

type Result Rm :: *

Methods

renderCommand :: Rm -> String

parseResult :: Proxy * Rm -> String -> Result Rm

type Result Rm

type Result Rm = ()

data Mv t

Move or rename files or directories.

Constructors

Mv (Path Abs t) (Path Abs t)

Instances

Command (Mv File)

Associated Types

type Result (Mv File) :: *

Methods

renderCommand :: Mv File -> String

parseResult :: Proxy * (Mv File) -> String -> Result (Mv File)

Command (Mv Dir)

Associated Types

type Result (Mv Dir) :: *

Methods

renderCommand :: Mv Dir -> String

parseResult :: Proxy * (Mv Dir) -> String -> Result (Mv Dir)

type Result (Mv File)

type Result (Mv File) = ()

type Result (Mv Dir)

type Result (Mv Dir) = ()

data Ln where

Create symlinks.

Constructors

Ln :: Path Abs t -> Path Abs File -> Ln

Instances

Command Ln

Associated Types

type Result Ln :: *

Methods

renderCommand :: Ln -> String

parseResult :: Proxy * Ln -> String -> Result Ln

type Result Ln

type Result Ln = ()

data Ls

ls, so far used only to check existence of directories, so it's not very functional right now.

Constructors

Ls (Path Abs Dir)

Instances

Command Ls

Associated Types

type Result Ls :: *

Methods

renderCommand :: Ls -> String

parseResult :: Proxy * Ls -> String -> Result Ls

type Result Ls

type Result Ls = ()

data Readlink t

Read link.

Constructors

Readlink (Path Abs File)

Instances

Command (Readlink File)

Associated Types

type Result (Readlink File) :: *

Methods

renderCommand :: Readlink File -> String

parseResult :: Proxy * (Readlink File) -> String -> Result (Readlink File)

Command (Readlink Dir)

Associated Types

type Result (Readlink Dir) :: *

Methods

renderCommand :: Readlink Dir -> String

parseResult :: Proxy * (Readlink Dir) -> String -> Result (Readlink Dir)

type Result (Readlink File)

type Result (Readlink File) = Path Abs File

type Result (Readlink Dir)

type Result (Readlink Dir) = Path Abs Dir

data Find t

Find (a very limited version).

Constructors

Find Natural (Path Abs Dir)

Instances

Command (Find File)

Associated Types

type Result (Find File) :: *

Methods

renderCommand :: Find File -> String

parseResult :: Proxy * (Find File) -> String -> Result (Find File)

Command (Find Dir)

Associated Types

type Result (Find Dir) :: *

Methods

renderCommand :: Find Dir -> String

parseResult :: Proxy * (Find Dir) -> String -> Result (Find Dir)

type Result (Find File)

type Result (Find File) = [Path Abs File]

type Result (Find Dir)

type Result (Find Dir) = [Path Abs Dir]

data Touch

touch.

Constructors

Touch (Path Abs File)

Instances

Command Touch

Associated Types

type Result Touch :: *

Methods

renderCommand :: Touch -> String

parseResult :: Proxy * Touch -> String -> Result Touch

type Result Touch

type Result Touch = ()

data GitClone

Git clone.

Constructors

GitClone Bool (Either String (Path Abs Dir)) (Path Abs Dir)

Instances

Command GitClone

Associated Types

type Result GitClone :: *

Methods

renderCommand :: GitClone -> String

parseResult :: Proxy * GitClone -> String -> Result GitClone

type Result GitClone

type Result GitClone = ()

data GitFetch

Git fetch (simplified).

Constructors

GitFetch String

Instances

Command GitFetch

Associated Types

type Result GitFetch :: *

Methods

renderCommand :: GitFetch -> String

parseResult :: Proxy * GitFetch -> String -> Result GitFetch

type Result GitFetch

type Result GitFetch = ()

data GitReset

Git reset.

Constructors

GitReset String

Instances

Command GitReset

Associated Types

type Result GitReset :: *

Methods

renderCommand :: GitReset -> String

parseResult :: Proxy * GitReset -> String -> Result GitReset

type Result GitReset

type Result GitReset = ()

data GenericCommand

Weakly-typed generic command, avoid using it directly.

Instances

Eq GenericCommand

Methods

(==) :: GenericCommand -> GenericCommand -> Bool

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

Ord GenericCommand

Methods

compare :: GenericCommand -> GenericCommand -> Ordering

(<) :: GenericCommand -> GenericCommand -> Bool

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

(>) :: GenericCommand -> GenericCommand -> Bool

(>=) :: GenericCommand -> GenericCommand -> Bool

max :: GenericCommand -> GenericCommand -> GenericCommand

min :: GenericCommand -> GenericCommand -> GenericCommand

Show GenericCommand

Methods

showsPrec :: Int -> GenericCommand -> ShowS

show :: GenericCommand -> String

showList :: [GenericCommand] -> ShowS

Command GenericCommand

Associated Types

type Result GenericCommand :: *

Methods

renderCommand :: GenericCommand -> String

parseResult :: Proxy * GenericCommand -> String -> Result GenericCommand

type Result GenericCommand

type Result GenericCommand = ()

mkGenericCommand :: String -> Maybe GenericCommand

Smart constructor that allows to create GenericCommands. Just a little bit more safety.

unGenericCommand :: GenericCommand -> String

Get the raw command back from GenericCommand.

readScript :: MonadIO m => Path Abs File -> m [GenericCommand]

Read commands from a file.