Elixir v0.12.4 → Overview → Mix → SCM

Mix.SCM behaviour

This module provides helper functions and defines the behaviour required by any SCM used by mix.

Source

Summary
↑

append(mod)

Aopend the given SCM module to the list of available SCMs
available()

Returns all available SCM. Each SCM is tried in order until a matching one is found
prepend(mod)

Prepend the given SCM module to the list of available SCMs

Types ↑

opts :: Keyword.t

Functions

append(mod)
(function) # ↑

Aopend the given SCM module to the list of available SCMs.

Source
available()
(function) # ↑

Returns all available SCM. Each SCM is tried in order until a matching one is found.

Source
prepend(mod)
(function) # ↑

Prepend the given SCM module to the list of available SCMs.

Source

Callbacks

accepts_options(app, opts)
(callback) # ↑

Specs:

  • accepts_options(app :: atom, opts) :: opts | nil

This behaviour function receives a keyword list of opts and should return an updated list in case the SCM consumes the available options. For example, when a developer specifies a dependency:

{ :foo, "0.1.0", github: "foo/bar" }

Each registered SCM will be asked if they consume this dependency, receiving [github: "foo/bar"] as argument. Since this option makes sense for the Git SCM, it will return an update list of options while other SCMs would simply return nil.

Source
checked_out?(opts)
(callback) # ↑

Specs:

  • checked_out?(opts) :: boolean

This behaviour function returns a boolean if the dependency is available.

Source
checkout(opts)
(callback) # ↑

Specs:

  • checkout(opts) :: any

This behaviour function checks out dependencies.

If the dependency is locked, a lock is received in opts and the repository must be check out at the lock. Otherwise, no lock is given and the repository can be checked out to the latest version.

It must return the current lock.

Source
equal?(opts1, opts2)
(callback) # ↑

Specs:

  • equal?(opts1 :: opts, opts2 :: opts) :: boolean

Receives two options and must return true if they refer to the same repository. The options are guaranteed to belong to the same SCM.

Source
fetchable?()
(callback) # ↑

Specs:

  • fetchable? :: boolean

Returns a boolean if the dependency can be fetched or it is meant to be previously available in the filesystem.

Source
format(opts)
(callback) # ↑

Specs:

Returns a string representing the SCM. This is used when printing the dependency and not for inspection, so the amount of information should be concise and easy to spot.

Source
format_lock(opts)
(callback) # ↑

Specs:

Returns a string representing the SCM. This is used when printing the dependency and not for inspection, so the amount of information should be concise and easy to spot.

If nil is returned, it means no lock information is available.

Source
lock_status(opts)
(callback) # ↑

Specs:

  • lock_status(opts) :: :mismatch | :outdated | :ok

This behaviour function checks the status of the lock. In particular, it checks if the revision stored in the lock is the same as the repository is currently in. It may return:

  • :mismatch - if the lock doesn't match and we need to simply move to the latest lock
  • :outdated - the repository options are out of dated in the lock and we need to trigger a full update
  • :ok - everything is fine

The lock is sent via opts[:lock] but it may not always be available. In such cases, if the SCM requires a lock, it must return :lockmismatch, otherwise simply :ok.

Note the lock may also belong to another SCM and as such, an structural check is required. A structural mismatch should always return :outdated.

Source
update(opts)
(callback) # ↑

Specs:

  • update(opts) :: any

This behaviour function updates dependencies. It may be called by deps.get or deps.update.

In the first scenario, a lock is received in opts and the repository must be updated to the lock. In the second, no lock is given and the repository can be updated freely.

It must return the current lock.

Source