fr.jeremyschoffen.mbt.alpha.core — fr.jeremyschoffen/mbt-alpha 3

Facade grouping the core apis in one place.

classpath-indexed clj

(classpath-indexed {wd :fr.jeremyschoffen.mbt.alpha.project/working-dir
                    :as param})

Construct a classpath map using [[clojure.tools.deps.alpha/make-classpath-map]] takes the keys and group them into a map. The keys of this map are defined in fr.jeremyschoffen.mbt.alpha.core.specs/classpath-index-categories, the values are a seq of classpath entries corresponding to the categories.

classpath-raw clj

(classpath-raw {wd :fr.jeremyschoffen.mbt.alpha.project/working-dir :as param})

Returns the a string representing the classpath given the config in param. The paths inside it are all absolute.

clean! clj

(clean! {t :fr.jeremyschoffen.mbt.alpha.cleaning/target :as param})

Delete a file or directory at the path specified by the key :cleaning/target. The target can't be the project directory specified by the key :project/working-dir and must be inside it. You can still delete anything inside your project dir with this function, src dir included.

Returns the cleaning target.

compilation-clojure-external-nss clj

(compilation-clojure-external-nss
  {cp :fr.jeremyschoffen.mbt.alpha.classpath/index})

Use an indexed classpath to find all Clojure namespaces from src directories located outside the working directory. These would be namespaces from local deps or directly from a git repo.

See:

• fr.jeremyschoffen.mbt.alpha.core.classpath/indexed-classpath

compilation-clojure-jar-nss clj

(compilation-clojure-jar-nss {cp :fr.jeremyschoffen.mbt.alpha.classpath/index})

Use an indexed classpath to find all Clojure namespaces from jars.

See:

• fr.jeremyschoffen.mbt.alpha.core.classpath/indexed-classpath

compilation-clojure-project-nss clj

(compilation-clojure-project-nss
  {cp :fr.jeremyschoffen.mbt.alpha.classpath/index})

Use an indexed classpath to find all Clojure namespaces from src directories located inside the working directory.

See:

• fr.jeremyschoffen.mbt.alpha.core.classpath/indexed-classpath

compilation-java-compiler clj

(compilation-java-compiler & _)

Return the platform's default java compiler.

compilation-java-external-files clj

(compilation-java-external-files
  {i :fr.jeremyschoffen.mbt.alpha.classpath/index})

Use an indexed classpath to find all .java files from src directories located outside the working directory. These would be namespaces from local deps or directly from a git repo.

See:

• fr.jeremyschoffen.mbt.alpha.core.classpath/indexed-classpath.

compilation-java-jar-files clj

(compilation-java-jar-files {i :fr.jeremyschoffen.mbt.alpha.classpath/index})

compilation-java-project-files clj

(compilation-java-project-files
  {i :fr.jeremyschoffen.mbt.alpha.classpath/index})

Use an indexed classpath to find all .java files src directories from inside the working directory.

See:

• fr.jeremyschoffen.mbt.alpha.core.classpath/indexed-classpath

compilation-java-std-file-manager clj

(compilation-java-std-file-manager
  {compiler :fr.jeremyschoffen.mbt.alpha.compilation.java/compiler
   opts :fr.jeremyschoffen.mbt.alpha.compilation.java.file-manager/options})

Make a standard file manager from a java compiler.

compilation-java-unit clj

(compilation-java-unit
  {file-manager :fr.jeremyschoffen.mbt.alpha.compilation.java/file-manager
   sources :fr.jeremyschoffen.mbt.alpha.compilation.java/sources})

Make a compilation unit to give a compilation task using a file manager.

compile-clojure! clj

(compile-clojure!
  {output-dir :fr.jeremyschoffen.mbt.alpha.compilation.clojure/output-dir
   namespaces :fr.jeremyschoffen.mbt.alpha.compilation.clojure/namespaces})

Compile a list of namespaces provided under the key :compilation.clojure/namespaces, the results are placed at the location specified under the key :compilation.clojure/output-dir.

compile-java! clj

(compile-java!
  {compiler :fr.jeremyschoffen.mbt.alpha.compilation.java/compiler
   file-manager :fr.jeremyschoffen.mbt.alpha.compilation.java/file-manager
   out :fr.jeremyschoffen.mbt.alpha.compilation.java/compiler-out
   diagnostic-listener
     :fr.jeremyschoffen.mbt.alpha.compilation.java/diagnostic-listener
   options :fr.jeremyschoffen.mbt.alpha.compilation.java/options
   classes :fr.jeremyschoffen.mbt.alpha.compilation.java/compiler-classes
   compilation-unit
     :fr.jeremyschoffen.mbt.alpha.compilation.java/compilation-unit})

Compile java files. This function makes a compilation task with compiler.getTask and immediatly calls .call on it.

See: javax.tool.JavaCompiler.

deps-get clj

(deps-get {p :fr.jeremyschoffen.mbt.alpha.project.deps/file})

Slurp the deps.edn file of a project using [[clojure.tools.deps.alpha.reader/slurp-deps]]. The deps file's path is passed under the key :fr...mbt.alpha.project.deps/file.

deps-non-maven clj

(deps-non-maven {deps-map :fr.jeremyschoffen.mbt.alpha.project/deps})

Utility signaling non maven deps. These deps can't go into a pom file.

deps-symbolic-name clj

(deps-symbolic-name {group-id :fr.jeremyschoffen.mbt.alpha.maven/group-id
                     name :fr.jeremyschoffen.mbt.alpha.maven/artefact-name
                     classifier :fr.jeremyschoffen.mbt.alpha.maven/classifier})

Create a Clojure symbol following the clojure tools deps format used to specified maven dependencies.

For instance the hypothetical:

(make-symbolic-coord
  {::fr...mbt.alpha.maven/group-id 'org.clojure
   ::fr...mbt.alpha.maven/artefact-name 'clojure
   ::fr...mbt.alpha.maven/classifier 'docs})
;=> org.clojure/clojure$docs

git-add! clj

(git-add! {repo :fr.jeremyschoffen.mbt.alpha.git/repo
           addition :fr.jeremyschoffen.mbt.alpha.git/add!})

Git add operation using [[clj-jgit.porcelain/git-add]]. The parameter and options are specified under the key ::fr...mbt.alpha.git/add!.

git-add-all! clj

(git-add-all! param)

Use the git add operation on all patterns listed by fr.jeremyschoffen.mbt.alpha.core.git/list-all-changed-patterns. In effect stages modified and un-tracked files.

git-any-commit? clj

(git-any-commit? {repo :fr.jeremyschoffen.mbt.alpha.git/repo})

Test whether the git repo has any commits or not.

git-commit! clj

(git-commit! {repo :fr.jeremyschoffen.mbt.alpha.git/repo
              commit :fr.jeremyschoffen.mbt.alpha.git/commit!})

Commit to a git repo using [[clj-jgit.porcelain/git-commit]]. The options to the porcelain function are passed in the git/commit map, see the :fr...mbt.alpha.git/commit! spec.

git-describe clj

(git-describe {repo :fr.jeremyschoffen.mbt.alpha.git/repo :as param})

Get a git description in a map form. This is an evolved version of fr.jeremyschoffen.mbt.alpha.core.git/describe-raw with additional data.

See the spec :fr...mbt.alpha.git/description.

git-describe-raw clj

(git-describe-raw {repo :fr.jeremyschoffen.mbt.alpha.git/repo
                   tag-pattern
                     :fr.jeremyschoffen.mbt.alpha.git.describe/tag-pattern})

Get a git description.

Similar to:

git describe --long --match tag-pattern

tag-pattern being the value passed under the key :fr...mbt.alpha.git.describe/tag-pattern.

Can return nil if there are no tag matching the pattern or no tags at all.

git-dirty? clj

(git-dirty? {repo :fr.jeremyschoffen.mbt.alpha.git/repo})

Test whether the git repo is dirty or not.

git-get-tag clj

(git-get-tag {repo :fr.jeremyschoffen.mbt.alpha.git/repo
              tag-name :fr.jeremyschoffen.mbt.alpha.git.tag/name})

Get a git tag using its name. The original jgit object is accessible via metadata under the key :jgit/object.

git-last-commit clj

(git-last-commit {repo :fr.jeremyschoffen.mbt.alpha.git/repo})

Returns the last commit made on the current branch, the first commit to pop up in the git log.

git-list-all-changed-patterns clj

(git-list-all-changed-patterns param)

Make a list of strings taken from the :modified and :untracked sections of a git status.

See: [[status]]

git-make-jgit-repo clj

(git-make-jgit-repo param)

Builds a org.eclipse.jgit.api.Git object.

git-prefix clj

(git-prefix {wd :fr.jeremyschoffen.mbt.alpha.project/working-dir :as context})

Given the project's working dir, find the git prefix.

Similar to using:

git -C wd/ rev-parse --show-prefix

git-status clj

(git-status {repo :fr.jeremyschoffen.mbt.alpha.git/repo})

Get the status of the current repo via [[clj-jgit.porcelain/git-status]].

git-tag! clj

(git-tag! {repo :fr.jeremyschoffen.mbt.alpha.git/repo :as param})

Create a new git tag using [[clj-jgit.porcelain/git-tag-create]].

See the :fr...mbt.alpha.git/tag! specs for all the options.

git-top-level clj

(git-top-level {wd :fr.jeremyschoffen.mbt.alpha.project/working-dir})

Given the project's working dir, find the git top level.

Similar to using:

git -C wd/ rev-parse --show-toplevel

git-update-all! clj

(git-update-all! param)

Similar to fr.jeremyschoffen.mbt.alpha.core.git/add-all! but uses the :fr...mbt.alpha.git.add!/update? option set to true.

gpg-sign-file! clj

(gpg-sign-file! param)

Use gnupg to sign a file. The different options are:

• :fr...mbt.alpha.gpg/sign!: in/output passed to the gnupg call
• :fr...mbt.alpha.gpg/command: actual gnupg command to call gpg, gpg2...
• :fr...mbt.alpha.gpg/home-dir: option telling gnupg where the directory containing keys is located
• :fr...mbt.alpha.gpg/key-id: id of the key used to create the signature
• :fr...mbt.alpha.gpg/pass-phrase: option to directly give the pass phrase instead of being prompted by the gpg agent during execution
• :fr...mbt.alpha.gpg/version: optional gnupg version in the vector form described in gpg-version. Used to determine which gpg options may be necessary to use.
• :fr...mbt.alpha.project/working-dir: the project's working dir. It will position the shell used to call gnupg on it.

gpg-version clj

(gpg-version {cmd :fr.jeremyschoffen.mbt.alpha.gpg/command :as param})

Try to get the current gpg version installed on the system. Returns in a vector of 3 ints: major minor and patch numbers.

jar-add-srcs! clj

(jar-add-srcs! {srcs :fr.jeremyschoffen.mbt.alpha.jar/srcs :as param})

Copy the files grouped under the key :fr...mbt.alpha.jar/srcs into the temp jar directory specified under the key :fr...mbt.alpha.jar/temp-output.

A source can be is anything that satifies fr.jeremyschoffen.mbt.alpha.core.jar.protocols/JarSource

An optional exclusion function can be passed under the key :fr...mbt.alpha.jar/exclude. If this function returns true, the jar entry will be excluded from the jar. It must take only one argument which will be a map with the following keys:

• :fr...mbt.alpha.jar.entry/src: absolute path to the entry
• :fr...mbt.alpha.jar.entry/dest: relative path (to the dest jar) indicating where to place the entry in the jar
• :fr...mbt.alpha.jar/temp-output: path to the temporary directory

The return value is a sequence of map, each one basically a jar/entry with additional keys:

• :fr...mbt.alpha.jar/temp-output a reminder of the temp output path
• :fr...mbt.alpha.jar.adding/result: the :filtered-out keyword in the case of an exclusion, whichever value was returned by whichever copying function was used otherwise.
• :fr...mbt.alpha.jar.clash/strategy: a keyword indicating which clash strategy has been used for this entry if a clash happened

jar-make-archive! clj

(jar-make-archive! {temp :fr.jeremyschoffen.mbt.alpha.jar/temp-output
                    output :fr.jeremyschoffen.mbt.alpha.jar/output
                    :as param})

Zips the dir specified by under the key :jar/temp-output into a .jar archive file at the location provided under the key :jar/output.

jar-read-only-jar-fs clj

(jar-read-only-jar-fs jar-path)

Open a jar (zip) file system at the location passed as a parameter. This file system is read only.

manifest clj

(manifest {main :fr.jeremyschoffen.mbt.alpha.jar/main-ns
           manifest-overrides
             :fr.jeremyschoffen.mbt.alpha.jar.manifest/overrides
           :as param})

Format the content of a MANIFEST.MF file as a string.

Several keys option are specified by the keys:

• :jar/main-ns: A namespace to be added to the "Main" entry to the manifest. Default to nil.
• :jar.manifest/overrides: A map of additional entries to the manifest. Values of the manifest map can be maps to represent manifest sections. By default, the manifest contains the "Created-by", "Built-By" and "Build-Jdk" entries.

maven-default-local-repo clj

maven-default-settings-file clj

maven-deploy! clj

(maven-deploy! {local-repo :fr.jeremyschoffen.mbt.alpha.maven/local-repo
                :as param
                :or {local-repo common/default-local-repo}})

Deploy artefacts. Some key parameters:

• :maven.deploy/artefacts: sequence of maps respecting the :maven.deploy/artefact spec. These represents the artefacts to deploy like jars, pom.xml files, etc...
• :maven/server: info about the remote repo
• :maven/credentials: an optional parameter that would contain the credentials info needed to deploy to a particular repo. The user's maven setting.xml is consulted to fill blanks in this parameter. Note that the values specified here take priority over the ones in the settings file.
• :maven.settings/file: optional parameter allowing to change the location of the maven setting.xml file.

maven-install! clj

(maven-install! {install-dir :fr.jeremyschoffen.mbt.alpha.maven.install/dir
                 :or {install-dir common/default-local-repo}
                 :as param})

Locally install maven artefacts. Some key parameters:

• :maven.deploy/artefacts: sequence of maps respecting the :maven.deploy/artefact spec. These represents the artefacts to deploy like jars, pom.xml files, etc...
• :maven.install/dir: optional parameter allowing the installation dir to be different from the default local repo.

maven-new-pom-properties clj

(maven-new-pom-properties {group-id :fr.jeremyschoffen.mbt.alpha.maven/group-id
                           artefact-name
                             :fr.jeremyschoffen.mbt.alpha.maven/artefact-name
                           v :fr.jeremyschoffen.mbt.alpha.project/version})

Makes the text of the pom.properties file found in jars.

maven-read-pom clj

(maven-read-pom {pom-path :fr.jeremyschoffen.mbt.alpha.maven.pom/path})

Read a pom.xml file at :fr...mbt.alpha.maven.pom/path and turns it into xml data.

maven-sign-artefact! clj

(maven-sign-artefact!
  {artefact :fr.jeremyschoffen.mbt.alpha.maven.deploy/artefact :as param})

Sign one maven deployment artefact under the key :maven.deploy/artefact using gpg, return a map specifying the resulting signature as instance :maven.deploy/artefact spec.

maven-sign-artefacts! clj

(maven-sign-artefacts!
  {artefacts :fr.jeremyschoffen.mbt.alpha.maven.deploy/artefacts :as param})

Sign several maven deployment artefacts using gpg. See fr.jeremyschoffen.mbt.alpha.core.maven.common/sign-artefact!

maven-sync-pom! clj

(maven-sync-pom! {pom-path :fr.jeremyschoffen.mbt.alpha.maven.pom/path
                  :as param})

Function similar to clojure.tools.deps.alpha.gen.pom/sync-pom with added behaviour. This function fills the maven coordinates for the project, the licenses and scm parts.

Also returns the map version of the synced xml.

semver-version clj

(semver-version x)

Make a representation of a version in the semver style.

sh clj

(sh {wd :fr.jeremyschoffen.mbt.alpha.project/working-dir
     cmd :fr.jeremyschoffen.mbt.alpha.shell/command})

Wrapper around the clojure.java.shell/sh function. Position the sh current dir on the project's working dir if provided.

version-bump-git-distance clj

(version-bump-git-distance v)

(version-bump-git-distance v level)

version-bump-maven clj

(version-bump-maven v level)

Bump a version according to a level :major, :minor, or :patch in the general case and :alpha, :beta, :rc and :release in the maven case.

Using commit distances this function can throw exceptions when the bump would just make another version of the same artefact or would in effect progress backward.

Example:

• with commit distance 0, bumping from 0.0.1 to 0.0.2 would crete 2 version of the same artefact.
• bumping from 0.1.0-beta to 0.1.0-alpha would be going backward.

version-bump-semver clj

(version-bump-semver v level)

Bump a version according to a level :major, :minor, or :patch in the general case and :alpha, :beta, :rc and :release in the maven case.

Using commit distances this function can throw exceptions when the bump would just make another version of the same artefact or would in effect progress backward.

Example:

• with commit distance 0, bumping from 0.0.1 to 0.0.2 would crete 2 version of the same artefact.
• bumping from 0.1.0-beta to 0.1.0-alpha would be going backward.

version-git-distance clj

(version-git-distance x)

Make a representation of a version in the git distance model. Versions only have one version number which is the number of commits since the first version, starting at 0.

This versioning system allows for alpha and beta qualifiers. Absence of a qualifier means that the project is in a stable state. It can't go back to alpha nor beta. For this reason using these qualifiers imply their presence from the initial version.

version-initial-git-distance clj

(version-initial-git-distance)

(version-initial-git-distance level)

Initial value to use when starting the versioning process from scratch.

version-initial-maven clj

Initial value to use when starting the versioning process from scratch.

version-initial-semver clj

Initial value to use when starting the versioning process from scratch.

version-maven clj

(version-maven x)

Make a representation of a version in the maven style.

version-parse-git-distance clj

(version-parse-git-distance s)

version-parse-maven-like clj

(version-parse-maven-like s)