Liking cljdoc? Tell your friends :D

stevedore.script

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.

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.
raw docstring

*apply-form-meta*clj

source

*script-language*clj

Current stevedore implementation

Current stevedore implementation
sourceraw docstring

*src-line-comments*clj

source

arg-stringclj

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

chain-commandscljmultimethod

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 together. Commands are executed left-to-right and a command is
only executed if the last command in the chain did not fail.
sourceraw docstring

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.

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.
sourceraw docstring

chained-scriptcljmacro

(chained-script & forms)

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

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

checked-commandscljmultimethod

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

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

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.

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

checked-scriptcljmacro

(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.

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.
sourceraw docstring

do-scriptcljmultimethod

Concatenate multiple scripts.

Concatenate multiple scripts.
sourceraw docstring

do-script*clj

(do-script* scripts)

Concatenate multiple scripts

Concatenate multiple scripts
sourceraw docstring

emitcljmultimethod

source

emit-doclj

(emit-do exprs)
source

emit-scriptclj

(emit-script forms)
source

fragmentcljmacro

(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.

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`.
sourceraw docstring

map-to-arg-stringclj

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

Output a set of command line switches from a map

Output a set of command line switches from a map
sourceraw docstring

operatorsclj

Operators that should not be resolved.

Operators that should not be resolved.
sourceraw docstring

option-argsclj

(option-args {:as m})

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

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

quasiquotecljmacro

(quasiquote form)
source

quasiquote*clj

(quasiquote* form)
source

resolve-script-fnsclj

source

scriptcljmacro

(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.

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.
sourceraw docstring

script-location-commentclj

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

special-formsclj

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

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

splice-argsclj

(splice-args args)
source

splice-listclj

(splice-list coll)

Mark a collection for splicing

Mark a collection for splicing
sourceraw docstring

splice-seqclj

A sequence to splice

A sequence to splice
sourceraw docstring

statementclj

(statement form script)

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

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

statement-separatorclj

source

underscoreclj

(underscore s)

Replace all occurances of - with _

Replace all occurances of - with _
sourceraw docstring

unresolvedclj

Set of symbols that should not be resolved.

Set of symbols that should not be resolved.
sourceraw docstring

with-line-numbercljmacro

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

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

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

with-script-languagecljmacro

(with-script-language impl & body)

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

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

with-source-line-commentscljmacro

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

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close