Liking cljdoc? Tell your friends :D

fr.jeremyschoffen.mbt.alpha.core.jar

Api grouping the different utilities around building jars provided in fr.jeremyschoffen.mbt.alpha.core.jar.XXX namespaces.

Api grouping the different utilities around building jars provided in
`fr.jeremyschoffen.mbt.alpha.core.jar.XXX` namespaces.
      
raw docstring

add-entries!clj

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

Use fr.jeremyschoffen.mbt.alpha.core.jar.temp/add-entry! to copy all the entries under the key :fr...mbt.alpha.jar/entries

Use [[fr.jeremyschoffen.mbt.alpha.core.jar.temp/add-entry!]] to copy all the entries
under the key `:fr...mbt.alpha.jar/entries`
sourceraw docstring

add-entry!clj

(add-entry! {output :fr.jeremyschoffen.mbt.alpha.jar/temp-output
             exclude? :fr.jeremyschoffen.mbt.alpha.jar/exclude?
             entry :fr.jeremyschoffen.mbt.alpha.jar/entry})

Function that copies a jar entry into the temp output, handling the exclusion cases and the clashes.

Function that copies a jar entry into the temp output, handling the exclusion cases and the clashes.
sourceraw docstring

add-srcs!clj

(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
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
sourceraw docstring

make-jar-archive!clj

(make-jar-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.

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`.
sourceraw docstring

read-only-jar-fsclj

(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.

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

to-entriesclj

(to-entries this)
(to-entries this exclude)

Function making instances of fr.jeremyschoffen.mbt.alpha.core.jar.protocols/JarEntries.

Args:

  • this: the value out of which we want to make a fr.jeremyschoffen.mbt.alpha.core.jar.protocols/JarEntries.
  • exclude: An exclusion function that will be specific to the fr.jeremyschoffen.mbt.alpha.core.jar.protocols/JarEntries being made. 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:
    • :jar.entry/src: absolute path to the entry
    • :jar.entry/dest: relative path (to the dest jar) indicating where to place the entry in the jar
    • :jar/temp-output: path to the temporary directory
Function making instances of [[fr.jeremyschoffen.mbt.alpha.core.jar.protocols/JarEntries]].

Args:
- `this`: the value out of which we want to make a
[[fr.jeremyschoffen.mbt.alpha.core.jar.protocols/JarEntries]].
- `exclude`: An exclusion function that will be specific to the
  [[fr.jeremyschoffen.mbt.alpha.core.jar.protocols/JarEntries]] being made. 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:
  - `:jar.entry/src`: absolute path to the entry
  - `:jar.entry/dest`: relative path (to the dest jar) indicating where to place the entry in the jar
  - `:jar/temp-output`: path to the temporary directory
sourceraw docstring

writable-jar-fsclj

(writable-jar-fs {output :fr.jeremyschoffen.mbt.alpha.jar/output})

Create a jar file system located at the path specified under the key :jar/output. This file system is created with the purpose of the creation of a fresh jar in mind.

Create a jar file system located at the path specified under the key `:jar/output`.
This file system is created with the purpose of the creation of a fresh jar in mind.
sourceraw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close