hf.depstar — com.github.seancorfield/depstar 2.1.303

Entry point for clojure -X and -T options, as well as usage in a tools.build script.

  (ns build
    (:require [hf.depstar :as d]))

  (-> options-map
      (d/pom)
      (d/aot)
      (d/build))

where options-map must contain, at a minimum, :jar (output file) and :jar-type (:thin or :uber).

There are also two high-level tasks that combine the three steps above (and do not require :jar-type):

  (d/jar options-map)

  (d/uberjar options-map)

If you are using tools.build for creating/syncing pom.xml and/or for compiling Clojure source code, you can use the functions in hf.depstar.api instead, as drop-in replacements for tools.build's API functions for building JAR files.

aot clj

(aot options)

-X entry point for AOT compilation.

Inputs:

• :aot true -- perform AOT for :main-class
• :classpath str -- override the default computed classpath
• :compile-aliases [kws] -- override :aliases just for compilation
• :compile-batch int -- size of compilation batch (defaults to the size of compile-ns)
• :compile-fn sym -- fully-qualified fn to use instead of compile
• :compile-ns [syms] -- namespaces to compile (may be :all) (defaults to :main-class if :aot true)
• :delete-on-exit true -- delete temp files/folder on JVM exit (otherwise it's up to the O/S)
• :jar-type :jar or :uber -- specify whether to build lib or app JAR (defaults to :uber)
• :main-class sym -- name of main class/namespace
• :paths-only true -- if :jar-type is :jar use just :paths (so this skips :local/root and :git/url)
• :target-dir str -- where to put the classes folder (by default a temp folder is used)

Outputs:

• :classpath-roots [strs] -- the classpath with the classes folder added, for possible use downstream.

build clj

(build options)

-X entry point for building a thin/uber JAR file.

Inputs (all optional, except where noted):

• basis
• classpath
• classpath-roots
• debug-clash
• delete-on-exit
• exclude
• jar (required)
• jar-type (required)
• no-pom
• paths-only
• pom-file
• target-dir
• verbose

Outputs (none).

jar clj

(jar options)

Generic entry point for jar invocations. This is a complete build process. It will perform AOT (if requested), create/sync pom.xml (if requested), and then build a (thin) JAR.

Can be used with clojure -X or clojure -T or in a build script:

In :aliases:

      :jar {:replace-deps {com.github.seancorfield/depstar {:mvn/version ...}}
            :exec-fn hf.depstar/jar
            :exec-args {}}

Then run:

      clojure -X:jar :jar MyProject.jar

If the destination JAR file is fixed, it could be added to :exec-args in deps.edn:

      :jar {:replace-deps {com.github.seancorfield/depstar {:mvn/version ...}}
            :exec-fn hf.depstar/jar
            :exec-args {:jar MyProject.jar}}

:jar can be specified as a symbol or a string.

pom clj

(pom options)

-X entry point for pom.xml creation/sync'ing.

Inputs (all optional):

• :artifact-id str -- <artifactId> to write to pom.xml
• :group-id str -- <groupId> to write to pom.xml
• :no-pom true -- do not read/update group/artifact/version
• :pom-file str -- override default pom.xml path
• :sync-pom true -- sync deps to pom.xml, create if missing
• :target-dir str -- override default pom.xml generation path (implies :sync-pom true)
• :version str -- <version> to write to pom.xml

For ease of use, :artifact-id, :group-id, and :target-id can be symbols instead of strings, if that would be a legal symbol.

Outputs:

• :artifact-id str -- if not no-pom, <artifactId> from pom.xml
• :group-id str -- if not no-pom, <groupId> from pom.xml
• :version str -- if not no-pom, <version> from pom.xml

uberjar clj

(uberjar options)

Generic entry point for uberjar invocations. This is a complete build process. It will perform AOT (if requested), create/sync pom.xml (if requested), and then build an uber JAR.

Can be used with clojure -X or clojure -T or in a build script:

In :aliases:

      :uberjar {:replace-deps {com.github.seancorfield/depstar {:mvn/version ...}}
                :exec-fn hf.depstar/uberjar
                :exec-args {}}

Then run:

      clojure -X:uberjar :aot true :jar MyProject.jar :main-class project.core

If any of the destination JAR file, main class, and/or AOT setting are fixed, they could be added to :exec-args in deps.edn:

      :uberjar {:replace-deps {com.github.seancorfield/depstar {:mvn/version ...}}
                :exec-fn hf.depstar/uberjar
                :exec-args {:aot true
                            :jar MyProject.jar
                            :main-class project.core}}

:jar can be specified as a symbol or a string.