Elixir 1.14+ with ExDoc & Credo

Enforce Elixir 1.14+ standards with ASDF, ExDoc, ExUnit, and Credo.

836|66|Updated Feb 3, 2025
One-click install
npx skills add https://github.com/kreuzberg-dev/html-to-markdown --skill elixir-1-14-with-exdoc-credo-kreuzberg-dev
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: Elixir 1.14+ with ExDoc & Credo
Source: https://github.com/kreuzberg-dev/html-to-markdown/tree/main/.remote-cache/kreuzberg-shared-rules/.ai-rulez/skills/elixir-114-with-exdoc-credo
Command: npx skills add https://github.com/kreuzberg-dev/html-to-markdown --skill elixir-1-14-with-exdoc-credo-kreuzberg-dev

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill provides a comprehensive set of best practices and tools for developing high-quality Elixir applications, ensuring maintainability, testability, and adherence to modern standards.

Core Features & Use Cases

  • Version Management: Enforces Elixir 1.14+ using ASDF.
  • Code Quality: Integrates ExDoc for documentation, ExUnit for testing (with high coverage), and Credo for strict linting.
  • Robustness: Promotes OTP principles, result tuples, and pure functions for reliable and maintainable code.
  • Use Case: A developer needs to set up a new Elixir project that adheres to strict coding standards, including comprehensive documentation and automated testing.

Quick Start

Configure a new Elixir project to use Elixir version 1.14 and enable strict Credo linting.

Frequently Asked Questions about Elixir 1.14+ with ExDoc & Credo

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I enforce strict coding standards in an Elixir project?

Enforce strict Elixir coding standards by configuring Credo for strict linting, ExUnit for high-coverage testing, and ExDoc for documentation. This combination ensures code maintainability and adherence to modern development practices.

What's the best way to structure robust Elixir applications following OTP principles?

Structure robust Elixir applications by using result tuples, guard clauses, type specifications, and pure functions. Following these OTP principles ensures reliable control flow and maintainable state management across your project.

How do I set up a new Elixir project with ASDF and version 1.14+?

Set up a new Elixir project by using ASDF to enforce Elixir version 1.14 or higher. Configure the environment to require adherence to type specifications and strict Credo linting from the start.

Does this Elixir workflow require comprehensive testing with ExUnit?

Yes, this workflow requires comprehensive testing using ExUnit to achieve high coverage. It integrates testing alongside documentation and linting to ensure the creation of robust and well-documented Elixir applications.

Why should I use result tuples and pure functions in Elixir?

Use result tuples and pure functions in Elixir to achieve reliable control flow and predictable state management. This approach enforces strict coding standards and promotes highly maintainable application architecture.

Can I generate documentation for Elixir 1.14+ projects using ExDoc?

Yes, you can generate documentation using ExDoc for Elixir 1.14+ projects. Integrating ExDoc enforces comprehensive documentation standards alongside strict Credo linting and ExUnit testing.