Dialyzer Configuration

VerifiedSafe

Configure Dialyzer for static analysis and type checking in Erlang/Elixir. Manage PLTs, analysis flags, and warning filters.

Sby Skills Guide Bot
DevelopmentIntermediate
3/9/2026
Claude CodeCursorWindsurfCopilotCodex
#elixir#erlang#dialyzer#static-analysis#mix

Recommended for

Automated summary

Guides configuration of Dialyzer (through Dialyxir) for Erlang/Elixir projects: PLT management, analysis flags, warning ignore files, and CI integration.

Strengths

  • Provides concrete config snippets for mix.exs, .dialyzer_ignore.exs, and dialyzer.ignore-warnings
  • Covers PLT management (plt_add_apps, plt_core_path, plt_file, plt_add_deps) to speed up analysis
  • Explains each analysis flag (:underspecs, :unmatched_returns, :error_handling, :overspecs, :unknown)
  • Includes a GitHub Actions example using --format github plus incremental-adoption best practices

Limitations

  • Covers only Mix/Dialyxir configuration, not raw dialyzer CLI usage or rebar3 setups
  • Does not explain how to fix the reported warnings or how to write thorough @spec annotations
  • Ignore-filter semantics (exact match vs regex, per-module scoping) are only lightly described
When to use it

Use it when setting up or tuning Dialyzer static analysis in an Elixir/Erlang project, especially PLTs, analysis flags, and warning exclusions.

When not to use it

Skip it for non-Elixir/Erlang projects, or when the task is to diagnose and fix one specific Dialyzer warning rather than configure the tool.

Security analysis

Safe
Quality score86/100

The skill is purely documentation about Dialyzer configuration for Erlang/Elixir. It contains no instructions to execute destructive commands, exfiltrate data, obfuscate payloads, or disable safety mechanisms.

No concerns found

How this analysis is made

Examples

Configure Dialyxir in mix.exs
Add Dialyxir to my Elixir project with a project-local PLT in priv/plts, enable :underspecs and :unmatched_returns, and turn on list_unused_filters.
Ignore legacy warnings
Create a .dialyzer_ignore.exs that ignores :unknown_function warnings for everything under lib/legacy/ but keeps unused-filter reporting enabled.
Add Dialyzer to CI
Add a GitHub Actions step that runs mix dialyzer --format github, and show the conditional mix.exs dependency setup for dev and test only.

name: dialyzer-configuration description: Use when configuring Dialyzer for Erlang/Elixir type checking and static analysis. allowed-tools: []

Dialyzer Configuration

Dialyzer is a static analysis tool for Erlang and Elixir that identifies software discrepancies such as type errors, unreachable code, and unnecessary tests.

Configuration Files

dialyzer.ignore-warnings

# Ignore specific warnings
lib/my_module.ex:42:pattern_match_cov

.dialyzer_ignore.exs

[
  {"lib/generated_code.ex", :no_return},
  {~r/lib\/legacy\/.*/, :unknown_function}
]

mix.exs Configuration

def project do
  [
    app: :my_app,
    dialyzer: [
      plt_add_apps: [:mix, :ex_unit],
      plt_core_path: "priv/plts",
      plt_file: {:no_warn, "priv/plts/dialyzer.plt"},
      flags: [:error_handling, :underspecs, :unmatched_returns],
      ignore_warnings: ".dialyzer_ignore.exs",
      list_unused_filters: true
    ]
  ]
end

Common Configuration Options

PLT Management

  • plt_add_apps: Additional applications to include in PLT
  • plt_core_path: Directory for core PLT files
  • plt_file: Custom PLT file location
  • plt_add_deps: Include dependencies (:app_tree, :apps_direct, :transitive)

Analysis Flags

  • :error_handling - Check error handling
  • :underspecs - Warn on under-specified functions
  • :unmatched_returns - Warn on unmatched return values
  • :unknown - Warn on unknown functions/types
  • :overspecs - Warn on over-specified functions

Filter Options

  • ignore_warnings: File with warning patterns to ignore
  • list_unused_filters: Show unused ignore patterns

Best Practices

  1. Incremental PLT Building: Use project-specific PLTs to speed up analysis
  2. Gradual Adoption: Start with subset of checks, expand over time
  3. CI Integration: Run Dialyzer in continuous integration
  4. Type Specs: Add comprehensive @spec annotations
  5. Warning Management: Document intentional ignores

Common Patterns

Conditional Analysis

if Mix.env() in [:dev, :test] do
  {:dialyxir, "~> 1.4", only: [:dev, :test], runtime: false}
end

Custom Check Script

#!/bin/bash
mix dialyzer --format github

GitHub Actions Integration

- name: Run Dialyzer
  run: mix dialyzer --format github

From the file to a first result

The download contains exactly the content displayed on this page. This copy may differ from the latest version in the source repository.

View the source and supporting files

This download contains SKILL.md only. Any scripts, references, templates and dependencies are not included. Get the required files from the source, preserving their directory structure, before continuing.

1. Download the file

Download SKILL.md

From the root of a test project, save the file as .skill-downloads/dialyzer-configuration-mmio716t/SKILL.md, or use the command below. This folder is for inspecting the skill before installation.

Command for macOS/Linux or WSL: requires a POSIX shell and curl. On Windows without WSL, use the download button and create the folder manually.

mkdir -p '.skill-downloads/dialyzer-configuration-mmio716t' && curl --fail --show-error --location 'https://skills-guides.com/api/skills/dialyzer-configuration-mmio716t/download' --output '.skill-downloads/dialyzer-configuration-mmio716t/SKILL.md.part' && mv '.skill-downloads/dialyzer-configuration-mmio716t/SKILL.md.part' '.skill-downloads/dialyzer-configuration-mmio716t/SKILL.md'

2. Check prerequisites

Read SKILL.md before using it. If it references scripts or external services, inspect them and prepare the required access in your test environment.

No recognized prerequisites section in this file. This does not mean it is self-contained: libraries, tools and access requirements may be mentioned elsewhere in the content or source repository.

The platforms on this page are catalog indications. The paths below follow tool documentation; they do not prove this skill has been run in those tools. No minimum tool version is confirmed for this listing.

3. Load the skill

After inspection, copy the complete folder into your project using one of the commands below, then open a new tool session. The command stops if a folder with the same name already exists: compare the files before replacing it.

Claude Code
test -f '.skill-downloads/dialyzer-configuration-mmio716t/SKILL.md' && test -s '.skill-downloads/dialyzer-configuration-mmio716t/SKILL.md' && mkdir -p '.claude/skills' && test ! -e '.claude/skills/dialyzer-configuration' && cp -R '.skill-downloads/dialyzer-configuration-mmio716t' '.claude/skills/dialyzer-configuration'

Cursor
test -f '.skill-downloads/dialyzer-configuration-mmio716t/SKILL.md' && test -s '.skill-downloads/dialyzer-configuration-mmio716t/SKILL.md' && mkdir -p '.cursor/skills' && test ! -e '.cursor/skills/dialyzer-configuration' && cp -R '.skill-downloads/dialyzer-configuration-mmio716t' '.cursor/skills/dialyzer-configuration'

Codex
test -f '.skill-downloads/dialyzer-configuration-mmio716t/SKILL.md' && test -s '.skill-downloads/dialyzer-configuration-mmio716t/SKILL.md' && mkdir -p '.agents/skills' && test ! -e '.agents/skills/dialyzer-configuration' && cp -R '.skill-downloads/dialyzer-configuration-mmio716t' '.agents/skills/dialyzer-configuration'

OpenSkills

OpenSkills must already be installed. The local install/read procedure is checked with OpenSkills 1.5.0, which requires Node.js ≥ 20.6.0. Catalog slugs are not resolved automatically.

Official OpenSkills installation
openskills install './.skill-downloads/dialyzer-configuration-mmio716t'

openskills read 'dialyzer-configuration-mmio716t'

Reading should display the installed file content and its base directory. It does not run the skill or install its dependencies.

For an agent that reads AGENTS.md, then sync the index. This command changes AGENTS.md: review the diff before using it.

openskills sync

Manual method or another tool: attach SKILL.md to a conversation, or open it in an agent that can read files. Include any required supporting resources. No universal folder is recognized by every tool.

4. Try a first task

Use a short, synthetic input: an API endpoint, a small document or an interface brief. In a new conversation, attach the file or give the agent its path, then adapt this request:

Read .skill-downloads/dialyzer-configuration-mmio716t/SKILL.md and apply its instructions to this example: [describe a test input]. Identify any missing files, dependencies or access. Produce the result requested by the skill without inventing data or running unreviewed scripts.

Expected result: output matching the skill instructions, or a precise list of missing prerequisites. A read confirmation alone does not validate a first use. If an external resource is unavailable, that path remains untested.

Related skills