Workspace.Checks.ForbiddenDeps (Workspace v0.2.1)

View Source

Ensures that the given dependencies are not defined.

This check can be used to ensure that all projects or a subset of your mono-repo projects do not have some dependencies defined.

Common use cases

A common use case for this check is when you want to deprecate a specific dependency in favor of another one and want to ensure that it is not introduced again in your workspace.

Configuration

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

Example

The following check ensures that :foo and :bar are not defined as dependencies across the workspace

[
  module: Workspace.Checks.ForbiddenDeps,
  description: ":foo and :bar are forbidden deps",
  opts: [
    deps: [:foo, :bar]
  ]
]