View Source Explico.Check.Vale (explico v0.1.1)

Basics

This check has a base priority of normal and requires Elixir >= 1.14.0.

Explanation

Runs Vale over documentation extracted from Credo's selected Elixir source files.

Add this check to the :extra checks in a configuration in your project's .credo.exs. When the Vale executable is not found, the check is skipped. Configuration and execution failures are reported as Credo issues.

Check-Specific Parameters

Use the following parameters to configure this check:

:vale_config

Path to a Vale configuration file, relative to the project root.

This parameter defaults to nil.

:vale_executable

Executable name or absolute path.

This parameter defaults to "vale".

General Parameters

Like with all checks, general params can be applied.

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