stevedore.script — spootnik/stevedore 0.9.1

Embed shell script in clojure.

Shell script is embedded by wrapping in the script macro. (script (ls)) => "ls"

The result of a script form is a string.

*apply-form-meta* clj

*script-language* clj

Current stevedore implementation

*src-line-comments* clj

arg-string clj

(arg-string option argument do-underscore do-assign dash)

chain-commands clj multimethod

Chain commands together. Commands are executed left-to-right and a command is only executed if the last command in the chain did not fail.

chain-commands* clj

(chain-commands* scripts)

Chain commands together. Commands are executed left-to-right and a command is only executed if the last command in the chain did not fail.

chained-script clj macro

(chained-script & forms)

Takes one or more forms. Returns a string of the forms translated into a chained shell script command.

checked-commands clj multimethod

Wrap a command in a code that checks the return value. Code to output the messages is added before the command.

checked-commands* clj

(checked-commands* message scripts)

Wrap a command in a code that checks the return value. Code to output the messages is added before the command.

checked-script clj macro

(checked-script message & forms)

Takes one or more forms. Returns a string of the forms translated into shell scrip. Wraps the expression in a test for the result status.

do-script clj multimethod

Concatenate multiple scripts.

do-script* clj

(do-script* scripts)

Concatenate multiple scripts

emit clj multimethod

emit-do clj

(emit-do exprs)

emit-script clj

(emit-script forms)

fragment clj macro

(fragment & forms)

Takes one or more forms. Returns a string of the forms translated into shell script. The returned fragment will have no source line annotations.

 (fragment
   (println "hello")
   (ls -l "*.sh"))

Must be wrapped in with-script-language.

map-to-arg-string clj

(map-to-arg-string m & {:keys [underscore assign dash] :or {dash "--"}})

Output a set of command line switches from a map

operators clj

Operators that should not be resolved.

option-args clj

(option-args {:as m})

Output a set of command line switches from a sequence of options

quasiquote clj macro

(quasiquote form)

quasiquote* clj

(quasiquote* form)

resolve-script-fns clj

script clj macro

(script & forms)

Takes one or more forms. Returns a string of the forms translated into shell script.

 (script
   (println "hello")
   (ls -l "*.sh"))

Must be wrapped in with-script-language. Can be wrapped in with-source-line-comments to control the generation of source line comments in the script.

script-location-comment clj

(script-location-comment {:keys [file line]})

special-forms clj

Special forms are handled explcitly by an implementation of emit-special.

splice-args clj

(splice-args args)

splice-list clj

(splice-list coll)

Mark a collection for splicing

splice-seq clj

A sequence to splice

statement clj

(statement form script)

Emit an expression as a valid shell statement, with separator.

statement-separator clj

underscore clj

(underscore s)

Replace all occurances of - with _

unresolved clj

Set of symbols that should not be resolved.

with-line-number clj macro

(with-line-number [file line] & body)

Provide the source file and line number for use in reporting.

with-script-language clj macro

(with-script-language impl & body)

Set which stevedore implementation to use. Currently supports: :stevedore.bash/bash

with-source-line-comments clj macro

(with-source-line-comments flag & body)