Hex
Hex v2.0.6

View Source Hex.Solver (Hex v2.0.6)

Link to this section Summary

Types

constraint()
dependency()
label()
locked()
optional()
package()
repo()
result()

Functions

parse_constraint(string)

Parses or converts a SemVer version or Elixir version requirement to an internal solver constraint that can be returned by the Hex.Solver.Registry or passed to Hex.Solver.run/4.

parse_constraint!(string)

Parses or converts a SemVer version or Elixir version requirement to an internal solver constraint that can be returned by the Hex.Solver.Registry or passed to Hex.Solver.run/4.

run(registry, dependencies, locked, overrides, opts \\ [])

Runs the version solver.

Link to this section Types

Link to this opaque

constraint()

View Source (opaque) 
@opaque constraint()
Link to this type

dependency()

View Source 
@type dependency() :: %{
  repo: repo(),
  name: package(),
  constraint: constraint(),
  optional: optional(),
  label: label()
}
Link to this type

label()

View Source 
@type label() :: String.t()
Link to this type

locked()

View Source 
@type locked() :: %{
  repo: repo(),
  name: package(),
  version: Version.t(),
  label: label()
}
Link to this type

optional()

View Source 
@type optional() :: boolean()
Link to this type

package()

View Source 
@type package() :: String.t()
Link to this type

repo()

View Source 
@type repo() :: String.t() | nil
Link to this type

result()

View Source 
@type result() :: %{required(package()) => {Version.t(), repo()}}

Link to this section Functions

Link to this function

parse_constraint(string)

View Source 
@spec parse_constraint(String.t() | Version.t() | Version.Requirement.t()) ::
  {:ok, constraint()} | :error

Parses or converts a SemVer version or Elixir version requirement to an internal solver constraint that can be returned by the Hex.Solver.Registry or passed to Hex.Solver.run/4.

Link to this function

parse_constraint!(string)

View Source 
@spec parse_constraint!(String.t() | Version.t() | Version.Requirement.t()) ::
  constraint()

Parses or converts a SemVer version or Elixir version requirement to an internal solver constraint that can be returned by the Hex.Solver.Registry or passed to Hex.Solver.run/4.

Link to this function

run(registry, dependencies, locked, overrides, opts \\ [])

View Source 
@spec run(module(), [dependency()], [locked()], [label()], [{:ansi, boolean()}]) ::
  {:ok, result()} | {:error, String.t()}

Runs the version solver.

Takes a Hex.Solver.Registry implementation, a list of root dependencies, a list of locked package versions, and a list of packages that are overridden by the root dependencies.

Locked dependencies are treated as optional dependencies with a single version as their constraint.

The overrides are a set of labels. If a dependency with a matching label is declared the solver will ignore that dependency unless it's a root dependency.

Returns a map of packages and their selected versions or a human readable explanation of why a solution could not be found.

options

 Options

  • :ansi - If true adds ANSI formatting to the failure message (Default: false)