KogenCredo.Check.Warning.DomainReach (KogenCredo v0.1.0)

Basics

This check has a base priority of low and works with any version of Elixir.

Explanation

A domain should depend on shared contracts, not on the internals of another domain. Configure each domain's namespace and paths; references from one domain's files to another's namespace are reported. Reach other domains through a contract/port or an event.

Check-Specific Parameters

Use the following parameters to configure this check:

:domains

List of [name:, namespace:, paths:, allow: []]. Empty disables the check.

This parameter defaults to [].

:shared

Modules (and their children) every domain may reference.

This parameter defaults to [].

:root_namespace

Application root namespace, used only with flag_unowned_root.

This parameter defaults to nil.

:flag_unowned_root

Also report references to unowned modules under root_namespace.

This parameter defaults to false.

General Parameters

Like with all checks, general params can be applied.

Parameters can be configured via the .credo.exs config file.