Medic

View Source

Medic is a tool for helping developers to set up a project on their workstation. It is optimized for MacOS, with a number of assumptions built in.

  • Homebrew for system dependencies
  • ASDF for language dependencies

It ships with a set of checks and high-level runners.

Runners

  • Medic.Doctor - runs checks to make sure that a development workstation can run the application
  • Medic.Test - runs the required set of tests to validate your application
  • Medic.Update - all the things you want to do after (and including) git pull

Checks

Checks are defined as modules and functions in the Medic.Checks namespace.

Checks are configured to run via Medic.Doctor via MFA ({module, function, arguments}) syntax, with {module, function} as a shortcut for zero-arity checks.

Local Checks

Local checks can be created by adding exs files in .medic/checks. Any elixir script files present in that directory will be automatically loaded by Medic prior to execution.

Checks should return a Medic.Check.check_return_t/0.

For example, if the following module is added at .medic/checks/local_check.exs

defmodule Local.Checks.LocalCheck do
  def :check do
    :ok
  end
end

Then it can be added to .medic/doctor.exs:

[
  {Local.Checks.LocalCheck, :check}
]