Liking cljdoc? Tell your friends :D

badigeon.uberjar


bundle

(bundle out-path)
(bundle out-path
        {:keys [deps-map aliases excluded-libs allow-unstable-deps?
                warn-on-resource-conflicts?],
         :or {warn-on-resource-conflicts? true}})

Creates a directory that contains all the resources from all the dependencies resolved from "deps-map". Resource conflicts (multiple resources with the same path) are not copied to the output directory. ".class" files are an exception, they are always copied to the ouput directory. Use the "badigeon.uberjar/find-resource-conflicts" function to list resource conflicts. By default, an exception is thrown when the project depends on a local dependency or a SNAPSHOT version of a dependency.

  • out-path: The path of the output directory.
  • deps-map: A map with the same format than a deps.edn map. The dependencies of the project are resolved from this map in order to be copied to the output directory. Default to the deps.edn map of the project (without merging the system-level and user-level deps.edn maps), with the addition of the maven central and clojars repositories.
  • aliases: Alias keywords used while resolving the project resources and its dependencies.
  • excluded-libs: A set of lib symbols to be excluded from the produced directory. Only the lib is excluded and not its dependencies.
  • allow-unstable-deps?: A boolean. When set to true, the project can depend on local dependencies or a SNAPSHOT version of a dependency. Default to false.
  • warn-on-resource-conflicts?. A boolean. When set to true and resource conflicts are found, then a warning is printed to err.
Creates a directory that contains all the resources from all the dependencies resolved from "deps-map". Resource conflicts (multiple resources with the same path) are not copied to the output directory. ".class" files are an exception, they are always copied to the ouput directory. Use the "badigeon.uberjar/find-resource-conflicts" function to list resource conflicts. By default, an exception is thrown when the project depends on a local dependency or a SNAPSHOT version of a dependency.
- out-path: The path of the output directory.
- deps-map: A map with the same format than a deps.edn map. The dependencies of the project are resolved from this map in order to be copied to the output directory. Default to the deps.edn map of the project (without merging the system-level and user-level deps.edn maps), with the addition of the maven central and clojars repositories.
- aliases: Alias keywords used while resolving the project resources and its dependencies.
- excluded-libs: A set of lib symbols to be excluded from the produced directory. Only the lib is excluded and not its dependencies.
- allow-unstable-deps?: A boolean. When set to true, the project can depend on local dependencies or a SNAPSHOT version of a dependency. Default to false.
- warn-on-resource-conflicts?. A boolean. When set to true and resource conflicts are found, then a warning is printed to *err*.
raw docstring

default-resource-mergers


find-resource-conflicts

(find-resource-conflicts)
(find-resource-conflicts {:keys [deps-map aliases], :as params})

Return the paths of all the resource conflicts (multiple resources with the same path) found on the classpath.

  • deps-map: A map with the same format than a deps.edn map. The dependencies resolved from this map are searched for conflicts. Default to the deps.edn map of the project (without merging the system-level and user-level deps.edn maps), with the addition of the maven central and clojars repository.
  • aliases: Alias keywords used while resolving the project resources and its dependencies.
Return the paths of all the resource conflicts (multiple resources with the same path) found on the classpath.
- deps-map: A map with the same format than a deps.edn map. The dependencies resolved from this map are searched for conflicts. Default to the deps.edn map of the project (without merging the system-level and user-level deps.edn maps), with the addition of the maven central and clojars repository.
- aliases: Alias keywords used while resolving the project resources and its dependencies.
raw docstring

make-out-path

(make-out-path lib version)

Build a path using a library name and its version number.

Build a path using a library name and its version number.
raw docstring

merge-resource-conflicts

(merge-resource-conflicts out-path)
(merge-resource-conflicts out-path
                          {:keys [deps-map aliases resource-mergers],
                           :or {resource-mergers
                                  default-resource-mergers}})

Merge the resource conflicts (multiple resources with the same path) found on the classpath and handled by the provided "resource-mergers".

  • out-path: The path of the output directory.
  • deps-map: A map with the same format than a deps.edn map. The dependencies resolved from this map are searched for conflicts. Default to the deps.edn map of the project (without merging the system-level and user-level deps.edn maps), with the addition of the maven central and clojars repository.
  • aliases: Alias keywords used while resolving the project resources and its dependencies.
  • resource-mergers: A map which keys are strings or regexps and values are maps called "mergers". "Mergers" are used to merge the resources which path matches one of the keys of "resource-mergers". "Mergers" must be maps containing three keys: :read, :merge, and :write. Default to "badigeon.uberjar/default-resource-mergers".
Merge the resource conflicts (multiple resources with the same path) found on the classpath and handled by the provided "resource-mergers".
- out-path: The path of the output directory.
- deps-map: A map with the same format than a deps.edn map. The dependencies resolved from this map are searched for conflicts. Default to the deps.edn map of the project (without merging the system-level and user-level deps.edn maps), with the addition of the maven central and clojars repository.
- aliases: Alias keywords used while resolving the project resources and its dependencies.
- resource-mergers: A map which keys are strings or regexps and values are maps called "mergers". "Mergers" are used to merge the resources which path matches one of the keys of "resource-mergers". "Mergers" must be maps containing three keys: :read, :merge, and :write. Default to "badigeon.uberjar/default-resource-mergers".
raw docstring

walk-directory

(walk-directory directory f)

Recursively visit all the files of a directory. For each visited file, the function f is called with two parameters: The path of the directory being recursively visited and the path of the file being visited, relative to the directory.

Recursively visit all the files of a directory. For each visited file, the function f is called with two parameters: The path of the directory being recursively visited and the path of the file being visited, relative to the directory.
raw docstring

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

× close