Liking cljdoc? Tell your friends :D

badigeon.bundle


bin-script

(bin-script out-path main)
(bin-script out-path
            main
            {:keys [os-type script-path script-header command
                    classpath jvm-opts args],
             :or {os-type posix-like,
                  script-path (make-script-path os-type),
                  script-header (make-script-header os-type),
                  classpath (str ".."
                                 (classpath-separator os-type)
                                 ".."
                                 (file-separator os-type)
                                 "lib"
                                 (file-separator os-type)
                                 "*"),
                  jvm-opts [],
                  args []}})

Write a start script for the bundle under "out-path", using the "main" parameter as the CLojure namespace defining the -main method entry point.

  • os-type: Either the badigeon.bundle.windows-like constant or the badigeon.bundle.posix-like constant, depending on the wanted script type. Default to badigeon.bundle.posix-like .
  • script-path: The output path of the script, relative to the "out-path" parameter. Default to bin/run.sh or bin/run.bat, depending on the os-type .
  • script-header: A string prefixed to the script. Default to "#!/bin/sh " or "@echo off ", depending on the os-type.
  • command: The command run by the script. Default to "java" or "runtime/bin/java" if the "runtime" folder contains a custom JRE created with jlink.
  • classpath: The classpath argument used when executing the command. Default a classpath containing the root folder and the lib directory.
  • jvm-opts: A vector of jvm arguments used when executing the command. Default to the empty vector.
  • args: A vector of arguments provided to the program. Default to the empty vector.
Write a start script for the bundle under "out-path", using the "main" parameter as the CLojure namespace defining the -main method entry point.
  - os-type: Either the badigeon.bundle.windows-like constant or the badigeon.bundle.posix-like constant, depending on the wanted script type. Default to badigeon.bundle.posix-like .
  - script-path: The output path of the script, relative to the "out-path" parameter. Default to bin/run.sh or bin/run.bat, depending on the os-type .
  - script-header: A string prefixed to the script. Default to "#!/bin/sh
" or "@echo off
", depending on the os-type.
  - command: The command run by the script. Default to "java" or "runtime/bin/java" if the "runtime" folder contains a custom JRE created with jlink.
  - classpath: The classpath argument used when executing the command. Default a classpath containing the root folder and the lib directory.
  - jvm-opts: A vector of jvm arguments used when executing the command. Default to the empty vector.
  - args: A vector of arguments provided to the program. Default to the empty vector.
raw docstring

bundle

(bundle out-path)
(bundle out-path
        {:keys [deps-map aliases excluded-libs allow-unstable-deps?
                libs-path]})

Creates a standalone bundle of the project resources and its dependencies. By default jar dependencies are copied in a "lib" folder, under the ouput directory. Other dependencies (local and git) are copied by copying their :paths content to the root of the output directory. By default, an exception is thrown when the project dependends 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 bundle. 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.
  • libs-path: The path of the folder where dependencies are copied, relative to the output folder. Default to "lib".
Creates a standalone bundle of the project resources and its dependencies. By default jar dependencies are copied in a "lib" folder, under the ouput directory. Other dependencies (local and git) are copied by copying their :paths content to the root of the output directory. By default, an exception is thrown when the project dependends 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 bundle. 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.
- libs-path: The path of the folder where dependencies are copied, relative to the output folder. Default to "lib".
raw docstring

classpath-separatormultimethod


copy-directory

(copy-directory from to-directory)

extract-native-dependencies

(extract-native-dependencies out-path)
(extract-native-dependencies
  out-path
  {:keys [deps-map aliases allow-unstable-deps? native-path
          native-prefixes native-extensions],
   :as opts})

Extract native dependencies (.so, .dylib, .dll, .a, .lib, .scx files) from jar dependencies. By default native dependencies are extracted to a "lib" folder under the output directory.

  • out-path: The path of the output directory.
  • deps-map: A map with the same format than a deps.edn map. The dependencies with a jar format resolved from this map are searched for native dependencies. 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 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.
  • native-path: The path of the folder where native dependencies are extracted, relative to the output folder. Default to "lib".
  • native-prefixes: A map from libs (symbol) to a path prefix (string). Libs with a specified native-prefix are searched for native dependencies under the path of the native prefix only. The native-prefix is excluded from the output path of the native dependency.
  • native-extensions: A collection of native extension regexp. Files which name match one of these regexps are considered a native dependency. Default to badigeon.bundle/native-extensions.
Extract native dependencies (.so, .dylib, .dll, .a, .lib, .scx files) from jar dependencies. By default native dependencies are extracted to a "lib" folder under the output directory.
- out-path: The path of the output directory.
- deps-map: A map with the same format than a deps.edn map. The dependencies with a jar format resolved from this map are searched for native dependencies. 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 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.
- native-path: The path of the folder where native dependencies are extracted, relative to the output folder. Default to "lib".
- native-prefixes: A map from libs (symbol) to a path prefix (string). Libs with a specified native-prefix are searched for native dependencies under the path of the native prefix only. The native-prefix is excluded from the output path of the native dependency.
- native-extensions: A collection of native extension regexp. Files which name match one of these regexps are considered a native dependency. Default to badigeon.bundle/native-extensions.
raw docstring

extract-native-dependencies-from-file

(extract-native-dependencies-from-file out-path file-path)
(extract-native-dependencies-from-file
  out-path
  file-path
  {:keys [native-path native-prefix native-extensions], :as opts})

Extract native dependencies (.so, .dylib, .dll, .a, .lib, .scx files) from a jar file. By default native dependencies are extracted to a "lib" folder under the output directory.

  • out-path: The path of the output directory.
  • file-path: The path of jar file from which the native dependencies are extracted.
  • native-path: The path of the folder where native dependencies are extracted, relative to the output folder. Default to "lib".
  • native-prefix: A path prefix (string). The file is searched for native dependencies under the path of the native prefix only. The native-prefix is excluded from the output path of the native dependency.
  • native-extensions: A collection of native extension regexp. Files which name match one of these regexps are considered a native dependency. Default to badigeon.bundle/native-extensions.
Extract native dependencies (.so, .dylib, .dll, .a, .lib, .scx files) from a jar file. By default native dependencies are extracted to a "lib" folder under the output directory.
- out-path: The path of the output directory.
- file-path: The path of jar file from which the native dependencies are extracted.
- native-path: The path of the folder where native dependencies are extracted, relative to the output folder. Default to "lib".
- native-prefix: A path prefix (string). The file is searched for native dependencies under the path of the native prefix only. The native-prefix is excluded from the output path of the native dependency.
- native-extensions: A collection of native extension regexp. Files which name match one of these regexps are considered a native dependency. Default to badigeon.bundle/native-extensions.
raw docstring

file-separatormultimethod


format-jvm-opts

(format-jvm-opts jvm-opts)

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

make-script-headermultimethod


make-script-pathmultimethod


native-extensions


posix-like


post-visit-directory

(post-visit-directory root-path to dir exception)

pre-visit-directory

(pre-visit-directory root-path to dir attrs)

visit-file-failed

(visit-file-failed file exception)

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

windows-like

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

× close