Workspace.Checks.EnsureDependencies (Workspace v0.3.1)

View Source

Checks that the given dependencies are defined.

Common use case

This check can be used to ensure that all projects or a subset of your mono-repo projects have some required dependencies defined. For example you can use it to ensure that all projects depend on :ex_doc.

This only checks that the dependency is defined, no matter what it's version is. To enforce additionally a specific version you can use Workspace.Checks.DependenciesVersion.

Configuration

  • :deps (list of atom/0) - Required. The list of required dependencies. An error will be raised if any of these packages is not used as a dependency in any workspace project.

Example

In order to ensure that all workspace projects use :ex_doc and :credo add the following rule in your workspace.exs:

[
  module: Workspace.Checks.EnsureDependencies,
  opts: [
    deps: [:ex_doc, :credo]
  ]
]