API Reference assay v#0.6.0

Copy Markdown View Source

Modules

Public entrypoints for running incremental Dialyzer via Assay.

Minimal configuration loader backed directly by Mix.Project.config/0.

JSON-RPC daemon that exposes incremental Dialyzer runs to tooling (e.g. MCP).

Parses and normalizes Dialyzer command-line flags.

Formats Dialyzer warnings into various output formats.

Formatter-agnostic helpers used across warning renderers to normalize Erlang terms and render rich diffs.

Provides actionable, context-aware suggestions for fixing Dialyzer warnings. Extracts information from multiple sources in the warning entry to provide specific, helpful guidance.

Shared helpers for turning Dialyzer warning payloads into friendly, Elixir-style text sections. A handler can take an entry (as delivered by the formatter), produce a %Result{headline, details}, and lean on these utilities for consistent indentation, diff highlighting, and term rendering.

Struct returned by Assay.Formatter.Warning.render/2 representing a formatted Dialyzer warning with a headline and optional detail lines.

Warning decoration and ignore rule filtering.

Minimal Model Context Protocol (MCP) server built on top of the Assay daemon.

Executes incremental Dialyzer runs directly via :dialyzer.run/1.

File watching and incremental Dialyzer re-execution.

Mix Tasks

Run incremental Dialyzer using the host project's mix.exs config.

Run Assay as a JSON-RPC daemon over stdio.

Installs and configures Assay in the current project.

Run Assay as an MCP (Model Context Protocol) server over stdio.

Watch project files and rerun incremental Dialyzer on change.