Liking cljdoc? Tell your friends :D

lice-comb.deps

Functionality related to combing tools.deps dependency maps and lib maps for license information.

Functionality related to combing tools.deps dependency maps and lib maps for
license information.
raw docstring

lice-comb.files

Functionality related to combing files, directories, and ZIP format archives for license information.

Functionality related to combing files, directories, and ZIP format archives
for license information.
raw docstring

lice-comb.impl.data

Data handling functionality. Note: this namespace is not part of the public API of lice-comb and may change without notice.

Data handling functionality. Note: this namespace is not part of the public
API of lice-comb and may change without notice.
raw docstring

lice-comb.impl.expressions-info

lice-comb expressions-info map helper functionality. Note: this namespace is not part of the public API of lice-comb and may change without notice.

lice-comb expressions-info map helper functionality. Note: this namespace is
not part of the public API of lice-comb and may change without notice.
raw docstring

lice-comb.impl.http

HTTP helper functionality. Note: this namespace is not part of the public API of lice-comb and may change without notice.

HTTP helper functionality. Note: this namespace is not part of
the public API of lice-comb and may change without notice.
raw docstring

lice-comb.impl.matching

Matching helper functionality. Note: this namespace is not part of the public API of lice-comb and may change without notice.

Matching helper functionality. Note: this namespace is not part of
the public API of lice-comb and may change without notice.
raw docstring

lice-comb.impl.regex-matching

Helper functionality focused on regex matching. Note: this namespace is not part of the public API of lice-comb and may change without notice.

Helper functionality focused on regex matching. Note: this namespace is not
part of the public API of lice-comb and may change without notice.
raw docstring

lice-comb.impl.spdx

SPDX-related functionality. Note: this namespace is not part of the public API of lice-comb and may change without notice.

SPDX-related functionality. Note: this namespace is not part of the public
API of lice-comb and may change without notice.
raw docstring

lice-comb.impl.utils

General purpose utility fns that I seem to end up needing in every single project I write... Note: this namespace is not part of the public API of lice-comb and may change without notice.

General purpose utility fns that I seem to end up needing in every single
project I write... Note: this namespace is not part of the public API of
lice-comb and may change without notice.
raw docstring

lice-comb.lein

Functionality related to combing Leiningen dependency sequences for license information.

Functionality related to combing Leiningen dependency sequences for license
information.
raw docstring

lice-comb.matching

The core matching functionality within lice-comb. Matching is provided for three categories of input, and uses a different process for each:

  1. License names
  2. License uris
  3. License texts

Each matching fn has two variants:

  1. A 'simple' version that returns a set of SPDX expressions (Strings)
  2. An 'info' version that returns an 'expressions-info map'

An expressions-info map has this structure:

  • key: an SPDX expression (String), which may be a single SPDX license identifier
  • value: a sequence of 'expression-info' maps

Each lice-comb expression-info map has this structure:

  • :id (String, optional): The SPDX identifier within the expression that this info map refers to.
  • :type (either :declared or :concluded, mandatory): Whether this identifier was unambiguously declared within the input or was instead concluded by lice-comb (see SPDX specification for more detail on the definition of these two terms).
  • :confidence (one of: :high, :medium, :low, only provided when :type = :concluded): Indicates the approximate confidence lice-comb has in its conclusions for this particular SPDX identifier.
  • :strategy (a keyword, mandatory): The strategy lice-comb used to determine this particular SPDX identifier. See the source for lice-comb.utils for an up-to-date list of all possible values.
  • :source (a sequence of Strings): The list of sources used to arrive at this SPDX identifier, starting from the most general (the input) to the most specific (the smallest subset of the input that was used to make this determination).
The core matching functionality within lice-comb. Matching is provided for
three categories of input, and uses a different process for each:
1. License names
2. License uris
3. License texts

Each matching fn has two variants:
1. A 'simple' version that returns a set of SPDX expressions (Strings)
2. An 'info' version that returns an 'expressions-info map'

An expressions-info map has this structure:
* key:   an SPDX expression (String), which may be a single SPDX license
         identifier
* value: a sequence of 'expression-info' maps

Each lice-comb expression-info map has this structure:
* :id (String, optional):
  The SPDX identifier within the expression that this info map refers to.
* :type (either :declared or :concluded, mandatory):
  Whether this identifier was unambiguously declared within the input or
  was instead concluded by lice-comb (see SPDX specification for more detail
  on the definition of these two terms).
* :confidence (one of: :high, :medium, :low, only provided when :type = :concluded):
  Indicates the approximate confidence lice-comb has in its conclusions for
  this particular SPDX identifier.
* :strategy (a keyword, mandatory):
  The strategy lice-comb used to determine this particular SPDX identifier.
  See the source for lice-comb.utils for an up-to-date list of all possible
  values.
* :source (a sequence of Strings):
  The list of sources used to arrive at this SPDX identifier, starting from
  the most general (the input) to the most specific (the smallest subset of
  the input that was used to make this determination).
raw docstring

lice-comb.maven

Functionality related to combing Maven POMs for license information.

In this namespace abbreviations are used for Maven's groupId, artifactId, and version concepts. So for example:

  • GA means groupId & artifactId
  • GAV means groupId, artifactId & version

In function calls where a version isn't required or provided, the library will determine and use the latest available version, as determined from (in order):

  1. your local Maven cache (usually ~/.m2/repository)
  2. Maven Central
  3. Clojars

Other/custom Maven artifact repositories are not currently supported.

Functionality related to combing Maven POMs for license information.

In this namespace abbreviations are used for Maven's groupId, artifactId, and
version concepts.  So for example:
* `GA` means groupId & artifactId
* `GAV` means groupId, artifactId & version

In function calls where a version isn't required or provided, the library will
determine and use the latest available version, as determined from (in order):
1. your local Maven cache (usually ~/.m2/repository)
2. Maven Central
3. Clojars

Other/custom Maven artifact repositories are not currently supported.
raw docstring

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

× close