Claude Cursor Skill

elixir-conventions

Elixir code conventions covering Elixir 1.14+/OTP 25+, pattern matching, mix format, Credo/Dialyzer, ExUnit, ExDoc, OTP process patterns, and dependency security. Load when writing or reviewing Elixir code.

LLM Mart · 0 points · 0 0 0

Virus-scanned Reviewed automatically before listing.

Full trust report

Download goldziher-ai-rulez-internal_builtins_languages_elixir_skills_elixir-conventions-ca967ad.zip · 0 KB

goldziher/ai-rulez 162 16 forks MIT Updated 5h ago

Part of goldziher/ai-rulez — 151 skills

Install

skills CLI

npx skills add https://github.com/Goldziher/ai-rulez/tree/main/internal/builtins/languages/elixir/skills/elixir-conventions

Claude Code claude plugin marketplace add https://llmmart.ai/marketplace.json && claude plugin install goldziher-ai-rulez@llmmart

Git git clone https://github.com/Goldziher/ai-rulez.git

The skills CLI installs just this skill, for any of its supported agents. Claude Code installs the whole goldziher/ai-rulez collection as a plugin from our marketplace. Git is the plain clone.

Skill manifest

Elixir 1.14+ OTP 25+, pattern matching extensively, mix format non-negotiable.
Configure .formatter.exs with :inputs and :import_deps for consistent formatting across team.
Linting: a linter (e.g., Credo --strict), type checking: Dialyzer (via dialyxir).
Security: mix_audit for dependency CVE scanning, a SAST tool (e.g., Sobelow) for static analysis. Run both in CI.
Testing: ExUnit with describe blocks, doctest for examples, a coverage tool (e.g., excoveralls) at 80%+.
Documentation: ExDoc for generation, @moduledoc on all modules, @doc + @spec on public functions.
{:ok, value} / {:error, reason} tuples — never raise for expected errors.
with for multi-step ops, guard clauses for function overloading.
OTP: GenServer for state, Supervisor for fault tolerance, |> pipe for transforms.
Dependencies: commit mix.lock, hex with ~> constraints.
Anti-patterns: mutable state outside processes, long-running NIFs, String.to_atom with user input.

Files (ai-rulez)

SKILL.md 1.2 KB

---
name: elixir-conventions
description: Elixir code conventions covering Elixir 1.14+/OTP 25+, pattern matching, mix format, Credo/Dialyzer, ExUnit, ExDoc, OTP process patterns, and dependency security. Load when writing or reviewing Elixir code.
---

- Elixir 1.14+ OTP 25+, pattern matching extensively, `mix format` non-negotiable.
- Configure `.formatter.exs` with `:inputs` and `:import_deps` for consistent formatting across team.
- Linting: a linter (e.g., Credo `--strict`), type checking: Dialyzer (via `dialyxir`).
- Security: `mix_audit` for dependency CVE scanning, a SAST tool (e.g., Sobelow) for static analysis. Run both in CI.
- Testing: ExUnit with `describe` blocks, `doctest` for examples, a coverage tool (e.g., excoveralls) at 80%+.
- Documentation: ExDoc for generation, `@moduledoc` on all modules, `@doc` + `@spec` on public functions.
- `{:ok, value}` / `{:error, reason}` tuples — never raise for expected errors.
- `with` for multi-step ops, guard clauses for function overloading.
- OTP: GenServer for state, Supervisor for fault tolerance, `|>` pipe for transforms.
- Dependencies: commit `mix.lock`, `hex` with `~>` constraints.
- Anti-patterns: mutable state outside processes, long-running NIFs, `String.to_atom` with user input.