Paraxial v2.7.6

View Source Paraxial.License (Paraxial v2.7.6)

Stores license information for a dependency.

Link to this section Summary

Types

t()

Functions

%Paraxial.License{}

The struct that keeps information about a dependency's license.

Link to this section Types

Link to this type

t()

View Source 
@type t() :: %Paraxial.License{
  app: atom(),
  certainty: float(),
  dep: Mix.Dep.t(),
  file: String.t() | nil,
  hex_metadata: [String.t()] | nil,
  license: String.t() | nil,
  mix: [String.t()] | nil,
  name: String.t(),
  version: String.t() | nil
}

Link to this section Functions

Link to this function

%Paraxial.License{}

View Source (struct)

The struct that keeps information about a dependency's license.

It contains:

  • app - the depedency's name as an atom
  • version - the version of the dependency being used
  • license - the best guess of the license
  • certainty - the certainty that the guessed license is correct on a scale of 0.0 to 1.0
  • license_mix - the license defined in the dependency's mix.exs file
  • license_file - the license defined in the dependency's LICENSE or LICENSE.md file