Liking cljdoc? Tell your friends :D

scry.cli

Command-line entry points and option normalization for scry.

Command-line entry points and option normalization for scry.
raw docstring

-mainclj

(-main & args)

clojure -M -m scry.cli entry point.

`clojure -M -m scry.cli` entry point.
raw docstring

main-outcomeclj

(main-outcome args)
(main-outcome args io-boundary)

Parse -m scry.cli args and run the shared CLI implementation.

Returns an exit code and never calls System/exit. This exists so tests can cover main-style parsing and help behavior without terminating the process.

Parse `-m scry.cli` args and run the shared CLI implementation.

Returns an exit code and never calls System/exit. This exists so tests can
cover main-style parsing and help behavior without terminating the process.
raw docstring

normalize-exec-optsclj

(normalize-exec-opts opts)

Normalize a clojure -X option map for CLI execution.

Throws ex-info with :type :scry.cli/argument-error on invalid options.

Normalize a `clojure -X` option map for CLI execution.

Throws ex-info with :type :scry.cli/argument-error on invalid options.
raw docstring

normalize-runnerclj

(normalize-runner runner)

Normalize a CLI runner identifier to :clojure-test or :kaocha.

Normalize a CLI runner identifier to :clojure-test or :kaocha.
raw docstring

parse-main-argsclj

(parse-main-args args)

Parse -m scry.cli string args into normalized CLI options.

Returns {:help? true :usage usage} for --help. Throws ex-info for argument errors.

Parse `-m scry.cli` string args into normalized CLI options.

Returns {:help? true :usage usage} for --help. Throws ex-info for argument
errors.
raw docstring

runclj

(run opts)
(run opts io-boundary)

clojure -X entry point for the scry CLI.

Normalizes EDN options, runs the shared CLI implementation, and returns the successful outcome. Throws ex-info with structured outcome data when the CLI run is non-zero so clojure -X exits non-zero without calling System/exit.

`clojure -X` entry point for the scry CLI.

Normalizes EDN options, runs the shared CLI implementation, and returns the
successful outcome. Throws ex-info with structured outcome data when the CLI
run is non-zero so `clojure -X` exits non-zero without calling System/exit.
raw docstring

run-cliclj

(run-cli normalized-options)
(run-cli normalized-options io-boundary)

Run scry from normalized CLI options and return a structured outcome.

Performs CLI output and .scry-results filesystem effects, but never calls System/exit. The optional io-boundary map may provide :out, :err, :cwd, :run-clojure-test, and :resolve-kaocha-runner for narrow state-based tests.

Run scry from normalized CLI options and return a structured outcome.

Performs CLI output and .scry-results filesystem effects, but never calls
System/exit. The optional io-boundary map may provide :out, :err, :cwd,
:run-clojure-test, and :resolve-kaocha-runner for narrow state-based tests.
raw docstring

usageclj

cljdoc builds & hosts documentation for Clojure/Script libraries

Keyboard shortcuts
Ctrl+kJump to recent docs
Move to previous article
Move to next article
Ctrl+/Jump to the search field
× close