Licensir v0.2.0 Licensir.License

Stores license information for a dependency.

Link to this section Summary

Functions

The struct that keeps information about a dependency’s license

Link to this section Types

Link to this type t()
t() :: %Licensir.License{app: atom(), certainty: float(), dep: Mix.Dep.t(), license: String.t() | nil, license_file: String.t() | nil, license_mix: [String.t()] | nil, name: String.t(), version: String.t() | nil}

Link to this section Functions

Link to this function %Licensir.License{} (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