Liking cljdoc? Tell your friends :D

metav.metadata


*scheme*clj


*separator*clj


artefact-nameclj

(artefact-name)
(artefact-name working-dir
               module-name
               &
               {:keys [scheme separator] :or {scheme *scheme*}})

invocation-contextclj

(invocation-context {:keys [version-scheme module-name-override] :as options})
(invocation-context {:keys [version-scheme module-name-override] :as options}
                    working-dir)

execution context: working-dir, module-name, version

execution context: working-dir, module-name, version
raw docstring

iso-nowclj

(iso-now)

metadata-as-codeclj

(metadata-as-code {:keys [working-dir namespace] :as invocation-context}
                  version)

metadata-as-ednclj

(metadata-as-edn {:keys [working-dir module-name] :as invocation-context}
                 version)

return a map of the repo metadata: version, name, path, etc.

return a map of the repo metadata: version, name, path, etc.
raw docstring

module-nameclj

(module-name)
(module-name working-dir module-name-override)

Determine the name for the project by analyzing the environment, path until the git root or folder name if just under the root

Determine the name for the project by analyzing the environment, path until the git root or folder name if just under the root
raw docstring

prefixclj

(prefix working-dir module-name)

return the prefix used before the version in tag (not to be confused with the git prefix even if we deduce the tag prefix with the git prefix)

return the prefix used before the version in tag (not to be confused with the git prefix even if we deduce the tag prefix with the git prefix)
raw docstring

tagclj

(tag working-dir module-name version)

in case of monorepo return the tag as the module name concatenated with the version

in case of monorepo return the tag as the module name concatenated with the version
raw docstring

versionclj

(version)
(version working-dir
         module-name
         &
         {:keys [scheme separator] :or {scheme *scheme*}})

Determine the version for the project by dynamically interrogating the environment, you can choose the "maven" or "semver" version scheme

Determine the version for the project by dynamically interrogating the environment,
you can choose the "maven" or "semver" version scheme
raw docstring

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

× close