polylith.clj.core.poly-cli.api — polylith/clj-poly 0.2.14-alpha

A poly tool API for the Clojure CLI's -X and -T options.

argument-mapping clj

(argument-mapping exec-args)

Map exec args to a vector of strings that represent the poly tool's command-line arguments. We accept symbols for the keys (or keywords, we don't care). We document it all as symbols.

In general, a boolean-valued key becomes a :flag argument, string-valued keys become key:value arguments, and vector- valued keys become key:val:val:val arguments.

Special cases: entity -- used to provide a :-separated list of leading arguments; could also be a vector of strings entities -- alternative to entity for vector values profile -- identify +-prefixed profile names profiles -- alternative to :profile for vector values ws -- alternative to ::

For create -- to make life easier: c s -- component name:s b s -- base name:s p s -- project name:s w s -- workspace name:s

check clj

(check exec-args)

Validates the workspace.

clojure -Tpoly check

Prints 'OK' and returns 0 if no errors were found. If errors or warnings were found, show messages and return the error code, or 0 if only warnings. If internal errors, 1 is returned.

For more detail: clojure -Tpoly help entity check

create clj

(create exec-args)

Creates a component, base, project or workspace.

clojure -Tpoly create entity TYPE name NAME [ARGS] TYPE = c[omponent] -> Creates a component. b[ase] -> Creates a base. p[roject] -> Creates a project. w[orkspace] -> Creates a workspace.

ARGS = Varies depending on TYPE.

Shorthand: clojure -Tpoly create c NAME -> Creates a component. b NAME -> Creates a base. p NAME -> Creates a project. w NAME -> Creates a workspace.

For more detail: clojure -Tpoly help entity create clojure -Tpoly help entity create:base clojure -Tpoly help entity create:component clojure -Tpoly help entity create:project clojure -Tpoly help entity create:workspace

deps clj

(deps exec-args)

Shows dependencies.

clojure -Tpoly deps [project PROJECT] [brick BRICK] (omitted) = Show workspace dependencies. PROJECT = Show dependencies for specified project. BRICK = Show dependencies for specified brick.

For more detail: clojure -Tpoly help entity deps clojure -Tpoly help entity deps brick true clojure -Tpoly help entity deps project true clojure -Tpoly help entity deps project true brick true

diff clj

(diff exec-args)

Shows changed files since the most recent stable point in time.

clojure -Tpoly diff

Internally, it executes 'git diff SHA --name-only' where SHA is the SHA-1 of the first commit in the repository, or the SHA-1 of the most recent tag that matches the default pattern 'stable-*'.

For more detail: clojure -Tpoly help entity diff

help clj

(help exec-args)

Display help.

For more detail: clojure -Tpoly help

info clj

(info exec-args)

Shows workspace information.

clojure -Tpoly info [ARGS] ARGS = loc true -> Shows the number of lines of code for each brick and project.

In addition to :loc, all the arguments used by the 'test' command can also be used as a way to see what tests will be executed.

For more detail: clojure -Tpoly help entity info

libs clj

(libs exec-args)

Shows all libraries that are used in the workspace.

clojure -Tpoly libs [all true] all true = View all bricks, including those without library dependencies.

For more detail: clojure -Tpoly help entity libs

migrate clj

(migrate exec-args)

Migrates a workspace to the latest version.

clojure -Tpoly migrate

If the workspace hasn't been migrated already, then this command will create a new ./workspace.edn file + a deps.edn file per brick.

For more detail: clojure -Tpoly help entity migrate

shell clj

(shell exec-args)

clojure -Tpoly shell

Starts an interactive shell with a prompt that is the name of the current workspace, e.g.: myworkspace$

For more detail: clojure -Tpoly help entity shell

test clj

(test exec-args)

Executes brick and/or project tests.

clojure -Tpoly test [ARGS]

The brick tests are executed from all projects they belong to except for the development project (if :dev true is not passed in).

For more detail: clojure -Tpoly help entity test

version clj

(version exec-args)

Display the version.

For more detail: clojure -Tpoly help entity version

ws clj

(ws exec-args)

Prints or writes the workspace as data.

clojure -Tpoly ws [get ARG] [out FILE] [latest-sha true] [branch BRANCH] ARG = keys -> Lists the keys for the data structure: - If it's a hash map, it returns all its keys. - If it's a list and its elements are hash maps, it returns a list with all the :name keys.

For more detail: clojure -Tpoly help entity ws