:fr.jeremyschoffen.mbt.alpha.build/jar-output-dir
path?
The dir into which build jars.
:fr.jeremyschoffen.mbt.alpha.build.jar/allow-non-maven-deps
boolean?
Config option for the default api when it comes to producing skinny jars. Defaulting to false, [[fr.jeremyschoffen.mbt.alpha.default/build-jar!]] will throw an exception if there are non maven compatible deps used in the project.
The idea is to guard from shipping a jar in which the pom.xml can't provide all deps.
:fr.jeremyschoffen.mbt.alpha.build.jar/name
(every-pred string? jar-ext?)
The file name of the skinny jar to build.
:fr.jeremyschoffen.mbt.alpha.build.jar/path
jar-path?
The definitive location of the jar to build : jar.output/dir + jar/name
:fr.jeremyschoffen.mbt.alpha.build.uberjar/name
(every-pred string? jar-ext?)
The file name of the uberjar to build.
:fr.jeremyschoffen.mbt.alpha.build.uberjar/path
jar-path?
The definitive location of the jar to build : jar.output/dir + uberjar/name
:fr.jeremyschoffen.mbt.alpha.classpath/index
(map-of classpath-index-categories (coll-of string?))
An indexed classpath used to derive jar sources.
:fr.jeremyschoffen.mbt.alpha.classpath/raw
string?
A classpath string.
:fr.jeremyschoffen.mbt.alpha.cleaning/target
path?
Path to a file / directory to delete.
:fr.jeremyschoffen.mbt.alpha.compilation.clojure/namespaces
(coll-of symbol?)
List of namespaces of clojure namespaces to compile.
:fr.jeremyschoffen.mbt.alpha.compilation.clojure/output-dir
path?
Directory where clojure copilation will output.
:fr.jeremyschoffen.mbt.alpha.compilation.java/compilation-unit
(instance? java.lang.Iterable %)
A java compilation unit required by the java api. Contains the paths to the .java files to compile.
:fr.jeremyschoffen.mbt.alpha.compilation.java/compiler
(instance? javax.tools.JavaCompiler %)
:fr.jeremyschoffen.mbt.alpha.compilation.java/compiler-classes
(coll-of string? :kind vector?)
:fr.jeremyschoffen.mbt.alpha.compilation.java/compiler-out
(instance? java.io.Writer %)
:fr.jeremyschoffen.mbt.alpha.compilation.java/diagnostic-listener
(instance? javax.tools.DiagnosticListener %)
:fr.jeremyschoffen.mbt.alpha.compilation.java/file-manager
(instance? javax.tools.StandardJavaFileManager %)
:fr.jeremyschoffen.mbt.alpha.compilation.java/options
(coll-of string? :kind vector?)
:fr.jeremyschoffen.mbt.alpha.compilation.java/output-dir
path?
:fr.jeremyschoffen.mbt.alpha.compilation.java/sources
(coll-of path?)
:fr.jeremyschoffen.mbt.alpha.compilation.java.file-manager/charset
(instance? java.nio.charset.Charset %)
:fr.jeremyschoffen.mbt.alpha.compilation.java.file-manager/diagnostic-listener
(instance? javax.tools.DiagnosticListener %)
:fr.jeremyschoffen.mbt.alpha.compilation.java.file-manager/locale
(instance? java.util.Locale %)
:fr.jeremyschoffen.mbt.alpha.compilation.java.file-manager/options
(keys
:opt
[:fr.jeremyschoffen.mbt.alpha.compilation.java.file-manager/diagnostic-listener
:fr.jeremyschoffen.mbt.alpha.compilation.java.file-manager/locale
:fr.jeremyschoffen.mbt.alpha.compilation.java.file-manager/charset])
:fr.jeremyschoffen.mbt.alpha.git/add!
(keys
:req
[:fr.jeremyschoffen.mbt.alpha.git.add!/file-patterns]
:opt
[:fr.jeremyschoffen.mbt.alpha.git.add!/update?
:fr.jeremyschoffen.mbt.alpha.git.add!/working-tree-iterator])
Options used when staging files in git.
:fr.jeremyschoffen.mbt.alpha.git/commit
(keys
:req
[:fr.jeremyschoffen.mbt.alpha.git.commit/name
:fr.jeremyschoffen.mbt.alpha.git.commit/message]
:opt
[:fr.jeremyschoffen.mbt.alpha.git.commit/author
:fr.jeremyschoffen.mbt.alpha.git.commit/committer
:fr.jeremyschoffen.mbt.alpha.git.commit/reflog-comment])
Data found in a git commit.
:fr.jeremyschoffen.mbt.alpha.git/commit!
(keys
:req
[:fr.jeremyschoffen.mbt.alpha.git.commit/message]
:opt
[:fr.jeremyschoffen.mbt.alpha.git.commit/all?
:fr.jeremyschoffen.mbt.alpha.git.commit/allow-empty?
:fr.jeremyschoffen.mbt.alpha.git.commit/amend?
:fr.jeremyschoffen.mbt.alpha.git.commit/author
:fr.jeremyschoffen.mbt.alpha.git.commit/committer
:fr.jeremyschoffen.mbt.alpha.git.commit/insert-change-id?
:fr.jeremyschoffen.mbt.alpha.git.commit/no-verify?
:fr.jeremyschoffen.mbt.alpha.git.commit/only
:fr.jeremyschoffen.mbt.alpha.git.commit/reflog-comment])
Options used when commiting to git.
:fr.jeremyschoffen.mbt.alpha.git/description
(keys
:req
[:fr.jeremyschoffen.mbt.alpha.git/raw-description
:fr.jeremyschoffen.mbt.alpha.git/tag
:fr.jeremyschoffen.mbt.alpha.git/sha
:fr.jeremyschoffen.mbt.alpha.git.describe/distance
:fr.jeremyschoffen.mbt.alpha.git.repo/dirty?])
Data found in a git description.
:fr.jeremyschoffen.mbt.alpha.git/identity
(keys
:req
[:fr.jeremyschoffen.mbt.alpha.git.identity/name
:fr.jeremyschoffen.mbt.alpha.git.identity/email])
Data representing an identity in git (committer...).
:fr.jeremyschoffen.mbt.alpha.git/prefix
(every-pred path? (complement absolute?))
Git prefix as in git -C wd/ rev-parse --show-prefix
:fr.jeremyschoffen.mbt.alpha.git/raw-description
string?
The string returned by git describe -opts*
given the options we pass by default.
:fr.jeremyschoffen.mbt.alpha.git/repo
(isa? (type %) org.eclipse.jgit.api.Git)
A JGit object representing a git repo.
:fr.jeremyschoffen.mbt.alpha.git/sha
string?
A git sha.
:fr.jeremyschoffen.mbt.alpha.git/tag
(keys
:req
[:fr.jeremyschoffen.mbt.alpha.git.tag/name
:fr.jeremyschoffen.mbt.alpha.git.tag/message]
:opt
[:fr.jeremyschoffen.mbt.alpha.git.tag/tagger])
Clojure data representing a git tag.
:fr.jeremyschoffen.mbt.alpha.git/tag!
(keys
:req
[:fr.jeremyschoffen.mbt.alpha.git.tag/name
:fr.jeremyschoffen.mbt.alpha.git.tag/message]
:opt
[:fr.jeremyschoffen.mbt.alpha.git.tag/annotated?
:fr.jeremyschoffen.mbt.alpha.git.tag/force?
:fr.jeremyschoffen.mbt.alpha.git.tag/signed?
:fr.jeremyschoffen.mbt.alpha.git.tag/tagger])
Option used when creating a new git tag.
:fr.jeremyschoffen.mbt.alpha.git/top-level
path?
Git top level as in git -C wd/ rev-parse --show-toplevel
.
:fr.jeremyschoffen.mbt.alpha.git-distance/number
integer?
Number representing a distance from an earlier commit. We get it from git descriptions. It's used when computing version numbers.
:fr.jeremyschoffen.mbt.alpha.git-distance/qualifier
git-distance-qualifiers
Qualifier for a version nulber in the git-distance scheme
.
:fr.jeremyschoffen.mbt.alpha.git.add!/file-patterns
(coll-of string?)
Pattern to be passed to git add.
:fr.jeremyschoffen.mbt.alpha.git.add!/update?
boolean?
Git add option.
:fr.jeremyschoffen.mbt.alpha.git.add!/working-tree-iterator
any?
Git add option.
:fr.jeremyschoffen.mbt.alpha.git.commit/all?
boolean?
Git commit option.
:fr.jeremyschoffen.mbt.alpha.git.commit/allow-empty?
boolean?
Git commit option.
:fr.jeremyschoffen.mbt.alpha.git.commit/amend?
boolean?
Git commit option.
:fr.jeremyschoffen.mbt.alpha.git.commit/author
(keys
:req
[:fr.jeremyschoffen.mbt.alpha.git.identity/name
:fr.jeremyschoffen.mbt.alpha.git.identity/email])
Git commit option.
:fr.jeremyschoffen.mbt.alpha.git.commit/committer
(keys
:req
[:fr.jeremyschoffen.mbt.alpha.git.identity/name
:fr.jeremyschoffen.mbt.alpha.git.identity/email])
Git commit option.
:fr.jeremyschoffen.mbt.alpha.git.commit/insert-change-id?
boolean?
Git commit option.
:fr.jeremyschoffen.mbt.alpha.git.commit/message
string?
Message in a commit.
:fr.jeremyschoffen.mbt.alpha.git.commit/name
string?
Name of a commit.
:fr.jeremyschoffen.mbt.alpha.git.commit/no-verify?
boolean?
Git commit option.
:fr.jeremyschoffen.mbt.alpha.git.commit/only
string?
Git commit option.
:fr.jeremyschoffen.mbt.alpha.git.commit/reflog-comment
string?
Git commit option.
:fr.jeremyschoffen.mbt.alpha.git.describe/distance
int?
Git distance in a description.
:fr.jeremyschoffen.mbt.alpha.git.describe/tag-pattern
string?
The pattern used to find a previous commit in a description.
:fr.jeremyschoffen.mbt.alpha.git.identity/email
string?
Email in a git identity.
:fr.jeremyschoffen.mbt.alpha.git.identity/name
string?
Name in a git identity.
:fr.jeremyschoffen.mbt.alpha.git.repo/dirty?
boolean?
Whether the repo is dirty in a description.
:fr.jeremyschoffen.mbt.alpha.git.tag/annotated?
boolean?
Git tag option.
:fr.jeremyschoffen.mbt.alpha.git.tag/force?
boolean?
Git tag option.
:fr.jeremyschoffen.mbt.alpha.git.tag/message
string?
Message of a tag.
:fr.jeremyschoffen.mbt.alpha.git.tag/name
string?
Name of a tag.
:fr.jeremyschoffen.mbt.alpha.git.tag/signed?
boolean?
Git tag option.
:fr.jeremyschoffen.mbt.alpha.git.tag/tagger
(keys
:req
[:fr.jeremyschoffen.mbt.alpha.git.identity/name
:fr.jeremyschoffen.mbt.alpha.git.identity/email])
Identity of the tagger.
:fr.jeremyschoffen.mbt.alpha.gpg/command
string?
The gpg command to use at the command line. Typically gpg
or gpg2
.
:fr.jeremyschoffen.mbt.alpha.gpg/home-dir
path?
The gpg home directory
to point gpg to.
:fr.jeremyschoffen.mbt.alpha.gpg/key-id
string?
Id of the key gpg should use to sign artefacts.
:fr.jeremyschoffen.mbt.alpha.gpg/pass-phrase
string?
A passphrase for the specified / default key gpg will use to sign artefacts.
:fr.jeremyschoffen.mbt.alpha.gpg/sign!
(keys
:req
[:fr.jeremyschoffen.mbt.alpha.gpg.sign!/in]
:opt
[:fr.jeremyschoffen.mbt.alpha.gpg.sign!/out])
Signing options for gpg:
:fr.jeremyschoffen.mbt.alpha.gpg/version
(and vector? (cat :major int? :minor int? :patch int?))
Internal representation of gpg's version used to dictate what options are required to use when signing.
:fr.jeremyschoffen.mbt.alpha.gpg.sign!/in
path?
File to sign with gpg.
:fr.jeremyschoffen.mbt.alpha.gpg.sign!/out
path?
Where the signature gpg generates goes.
:fr.jeremyschoffen.mbt.alpha.jar/entries
(coll-of :fr.jeremyschoffen.mbt.alpha.jar/entry)
A collection of jar entries.
:fr.jeremyschoffen.mbt.alpha.jar/entry
(keys
:req
[:fr.jeremyschoffen.mbt.alpha.jar.entry/src
:fr.jeremyschoffen.mbt.alpha.jar.entry/dest])
Representation of a jar entry.
:fr.jeremyschoffen.mbt.alpha.jar/exclude?
fn?
Function determining if a potential jar entry actually makes it into a jar.
:fr.jeremyschoffen.mbt.alpha.jar/file-system
file-system?
A java nio filesystem pointing at a jar.
:fr.jeremyschoffen.mbt.alpha.jar/main-ns
symbol?
the main namespace of a jar. (Used in jar manifests.)
:fr.jeremyschoffen.mbt.alpha.jar/manifest
string?
A jar manifest.
:fr.jeremyschoffen.mbt.alpha.jar/output
jar-path?
The path poiting at the location a jar will be created.
:fr.jeremyschoffen.mbt.alpha.jar/src
(satisfies? JarSource %)
Source for a jar: source directories, other jars...
:fr.jeremyschoffen.mbt.alpha.jar/srcs
(coll-of :fr.jeremyschoffen.mbt.alpha.jar/src)
Collection aof jar sources.
:fr.jeremyschoffen.mbt.alpha.jar/temp-output
path?
The location of the directory containing all jar entries. Basically the un-compressed content of a jar archive to be compressed.
:fr.jeremyschoffen.mbt.alpha.jar.adding/result
any?
Key found in the returned values of the jar-ing operation giving some information as to what happened to the jar entry.
:fr.jeremyschoffen.mbt.alpha.jar.clash/strategy
#{:noop :concat-lines :merge}
Key found in the returned values of the jar-ing operation indicating a clash happened and what strategy was employed to resolve it.
:fr.jeremyschoffen.mbt.alpha.jar.entry/dest
path?
The destination of a jar entry in the final jar.
:fr.jeremyschoffen.mbt.alpha.jar.entry/src
(or :text string? :file path?)
The path to the actual jar entry.
:fr.jeremyschoffen.mbt.alpha.jar.manifest/overrides
map?
Additionnal entries for the a jar manifest.
:fr.jeremyschoffen.mbt.alpha.maven/artefact-name
symbol?
The name of a maven artefact (devoid of classifier).
:fr.jeremyschoffen.mbt.alpha.maven/classifier
symbol?
A classifer to be employed for a mavan artefact.
:fr.jeremyschoffen.mbt.alpha.maven/credentials
(keys
:opt
[:fr.jeremyschoffen.mbt.alpha.maven.credentials/user-name
:fr.jeremyschoffen.mbt.alpha.maven.credentials/password
:fr.jeremyschoffen.mbt.alpha.maven.credentials/private-key
:fr.jeremyschoffen.mbt.alpha.maven.credentials/passphrase])
Credentials used in maven operations.
:fr.jeremyschoffen.mbt.alpha.maven/group-id
symbol?
The group id for a maven artefact.
:fr.jeremyschoffen.mbt.alpha.maven/local-repo
path?
Path to the local maven repo.
:fr.jeremyschoffen.mbt.alpha.maven/scm
(keys
:opt
[:fr.jeremyschoffen.mbt.alpha.maven.scm/connection
:fr.jeremyschoffen.mbt.alpha.maven.scm/developer-connection
:fr.jeremyschoffen.mbt.alpha.maven.scm/tag
:fr.jeremyschoffen.mbt.alpha.maven.scm/url])
Scm information for pom.xml files.
:fr.jeremyschoffen.mbt.alpha.maven/server
(or
:id-req
(keys
:req
[:fr.jeremyschoffen.mbt.alpha.maven.server/id]
:opt
[:fr.jeremyschoffen.mbt.alpha.maven.server/url])
:url-req
(keys
:req
[:fr.jeremyschoffen.mbt.alpha.maven.server/url]
:opt
[:fr.jeremyschoffen.mbt.alpha.maven.server/id]))
Server information when deploying maven artefacts.
:fr.jeremyschoffen.mbt.alpha.maven-like/qualifier
(keys
:req-un
[:fr.jeremyschoffen.mbt.alpha.maven-like.qualifier/label
:fr.jeremyschoffen.mbt.alpha.maven-like.qualifier/n])
qualifier in the maven versioning: alpha3
, rc2
...
:fr.jeremyschoffen.mbt.alpha.maven-like/subversions
(coll-of integer? :kind vector? :count 3)
Vector of 3 integers used to describe a maven / semver version number (major, minor, patch).
:fr.jeremyschoffen.mbt.alpha.maven-like.qualifier/label
allowed-qualifiers
Name of the qualifier in the maven versioning scheme: :alpha
, :beta
, :rc
.
:fr.jeremyschoffen.mbt.alpha.maven-like.qualifier/n
(and integer? pos?)
The number in maven version qualifier: the 2 in alpha2
.
:fr.jeremyschoffen.mbt.alpha.maven.credentials/passphrase
string?
Passphrase used in maven credentials.
:fr.jeremyschoffen.mbt.alpha.maven.credentials/password
string?
Password used in maven credentials.
:fr.jeremyschoffen.mbt.alpha.maven.credentials/private-key
path?
Private key used in maven credentials.
:fr.jeremyschoffen.mbt.alpha.maven.credentials/user-name
string?
User name used in maven credentials.
:fr.jeremyschoffen.mbt.alpha.maven.deploy/artefact
(keys
:req
[:fr.jeremyschoffen.mbt.alpha.maven.deploy.artefact/path
:fr.jeremyschoffen.mbt.alpha.maven.deploy.artefact/extension])
Maven artefact in the deploy sense. Basically a representation of a file that will be installed / deployed by maven.
:fr.jeremyschoffen.mbt.alpha.maven.deploy/artefacts
(coll-of :fr.jeremyschoffen.mbt.alpha.maven.deploy/artefact)
Collection of maven deploy artefacts to be installed / deployed.
:fr.jeremyschoffen.mbt.alpha.maven.deploy/sign-artefacts?
boolean?
Option to sign artefacts when deploying them.
:fr.jeremyschoffen.mbt.alpha.maven.deploy.artefact/extension
string?
Extension of a deployment artefact.
:fr.jeremyschoffen.mbt.alpha.maven.deploy.artefact/path
path?
Path to a deployment artefact.
:fr.jeremyschoffen.mbt.alpha.maven.install/dir
path?
Directory where we want maven installation to put artefacts.
:fr.jeremyschoffen.mbt.alpha.maven.pom/path
path?
Path to the pom.xml
file to be used / synced.
:fr.jeremyschoffen.mbt.alpha.maven.pom/properties
string?
A pom.properties
to be put in jars.
:fr.jeremyschoffen.mbt.alpha.maven.pom/xml
map?
Content of a pom.xml
file in data form (data used by clojure.tools.xml
).
:fr.jeremyschoffen.mbt.alpha.maven.scm/connection
string?
Scm data for maven poms.
:fr.jeremyschoffen.mbt.alpha.maven.scm/developer-connection
string?
Scm data for maven poms.
:fr.jeremyschoffen.mbt.alpha.maven.scm/tag
string?
Scm data for maven poms.
:fr.jeremyschoffen.mbt.alpha.maven.scm/url
string?
Scm data for maven poms.
:fr.jeremyschoffen.mbt.alpha.maven.server/id
string?
An id of a maven server. Typically the id used in maven's settings.xml
files
to identify a server.
:fr.jeremyschoffen.mbt.alpha.maven.server/url
url?
Url to a maven server.
:fr.jeremyschoffen.mbt.alpha.maven.settings/file
path?
Location of the settings.xml
file to use.
:fr.jeremyschoffen.mbt.alpha.project/author
string?
Author of the project. Used in jar manifests.
:fr.jeremyschoffen.mbt.alpha.project/deps
(keys
:opt-un
[:clojure.tools.deps.alpha.specs/paths
:clojure.tools.deps.alpha.specs/deps
:clojure.tools.deps.alpha.specs/aliases])
The deps map of the project.
:fr.jeremyschoffen.mbt.alpha.project/git-coords
(map-of :clojure.tools.deps.alpha.specs/lib :git/coord)
Coordinates of a project tools deps style for a git dependency.
:fr.jeremyschoffen.mbt.alpha.project/git-url
string?
Url pointing to the git repo of the project for instance: "https://github.com/JeremS/mbt".
:fr.jeremyschoffen.mbt.alpha.project/license
(keys
:req
[:fr.jeremyschoffen.mbt.alpha.project.license/name
:fr.jeremyschoffen.mbt.alpha.project.license/url
:fr.jeremyschoffen.mbt.alpha.project.license/distribution]
:opt
[:fr.jeremyschoffen.mbt.alpha.project.license/comment
:fr.jeremyschoffen.mbt.alpha.project.license/file])
Data for a license entry in pom files.
:fr.jeremyschoffen.mbt.alpha.project/licenses
(coll-of :fr.jeremyschoffen.mbt.alpha.project/license)
Collection of the license entries for the pom file.
:fr.jeremyschoffen.mbt.alpha.project/maven-coords
(map-of :clojure.tools.deps.alpha.specs/lib :mvn/coord)
Coordinates of a project tools deps style for a maven dependency.
:fr.jeremyschoffen.mbt.alpha.project/name
string?
Name of the project. Used to generate git tags and maven artefact id.
:fr.jeremyschoffen.mbt.alpha.project/output-dir
path?
The directory in which the build tool outputs stuff.
:fr.jeremyschoffen.mbt.alpha.project/version
(and string? seq)
Version of the project. Used in maven related activities.
:fr.jeremyschoffen.mbt.alpha.project/working-dir
(every-pred path-like? absolute?)
Working directory / root of the project.
:fr.jeremyschoffen.mbt.alpha.project.deps/aliases
(coll-of keyword? :into #{})
Aliases to be used in conjunction with the project's deps.
:fr.jeremyschoffen.mbt.alpha.project.deps/file
path?
Location of the deps.edn
file to use.
:fr.jeremyschoffen.mbt.alpha.project.license/comment
string?
License data in poms.
:fr.jeremyschoffen.mbt.alpha.project.license/distribution
license-distros
License data in poms.
:fr.jeremyschoffen.mbt.alpha.project.license/file
path?
Path to the license file. (Will be included in jars.)
:fr.jeremyschoffen.mbt.alpha.project.license/name
string?
License data in poms.
:fr.jeremyschoffen.mbt.alpha.project.license/url
string?
License data in poms.
:fr.jeremyschoffen.mbt.alpha.shell/command
(cat
:cmd
(* string?)
:opts
(* (cat :opt-name keyword? :opt-value any?)))
Command to be run in another process. Basically:
(apply clojure.java.shell/sh command)
:fr.jeremyschoffen.mbt.alpha.shell/err
string?
Key in the return value of a shell process.
:fr.jeremyschoffen.mbt.alpha.shell/exit
int?
Key in the return value of a shell process.
:fr.jeremyschoffen.mbt.alpha.shell/out
string?
Key in the return value of a shell process.
:fr.jeremyschoffen.mbt.alpha.shell/result
(keys
:req-un
[:fr.jeremyschoffen.mbt.alpha.shell/exit
:fr.jeremyschoffen.mbt.alpha.shell/out
:fr.jeremyschoffen.mbt.alpha.shell/err])
Return value of a shell process.
:fr.jeremyschoffen.mbt.alpha.version-file/ns
symbol?
Namespace of the version file.
:fr.jeremyschoffen.mbt.alpha.version-file/path
path?
Where to put the version file.
:fr.jeremyschoffen.mbt.alpha.versioning/bump-level
keyword?
Bump level to use when releasing a new version of the project. Depends on the versioning scheme used.
:fr.jeremyschoffen.mbt.alpha.versioning/major
keyword?
Optional marker that will be used when creating git tag names and maven artefact names.
:fr.jeremyschoffen.mbt.alpha.versioning/scheme
(satisfies? VersionScheme %)
The versioning scheme to use.
:fr.jeremyschoffen.mbt.alpha.versioning/tag-base-name
string?
The base part of generated tag names, mbt-alpha
in mbt-alpha-vX
:fr.jeremyschoffen.mbt.alpha.versioning/version
any?
A a representation of a version generated and used by the version scheme.
Can you improve this documentation?Edit on GitHub
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close