phoenix-elixir
Elixir guidelines
When & Why to Use This Skill
This Claude skill provides comprehensive Elixir and Phoenix development guidelines designed to ensure high-quality, idiomatic code. It focuses on functional programming best practices, covering critical areas such as immutable variable handling, efficient list access, struct manipulation, and Mix task optimization. By adhering to these standards, developers can avoid common pitfalls like memory leaks, cyclic dependencies, and inefficient dependency management, ultimately improving application performance and maintainability.
Use Cases
- Automated Code Auditing: Use the skill to review Elixir codebases for anti-patterns, such as using index-based access on lists or improper variable rebinding in conditional blocks.
- Architectural Consistency: Ensure project scalability by enforcing rules against module nesting and promoting the correct use of OTP primitives like DynamicSupervisor and Registry.
- Performance Optimization: Prevent memory leaks by identifying risky uses of String.to_atom/1 on user input and optimizing concurrent enumeration with Task.async_stream.
- Standard Library Alignment: Guide developers to utilize Elixir's robust built-in libraries for date/time manipulation and Mix tasks, reducing reliance on unnecessary external dependencies.
| name | phoenix-elixir |
|---|---|
| description | Elixir guidelines |
Elixir guidelines
Elixir lists do not support index based access via the access syntax
Never do this (invalid):
i = 0 mylist = ["blue", "green"] mylist[i]Instead, always use
Enum.at, pattern matching, orListfor index based list access, ie:i = 0 mylist = ["blue", "green"] Enum.at(mylist, i)Elixir variables are immutable, but can be rebound, so for block expressions like
if,case,cond, etc you must bind the result of the expression to a variable if you want to use it and you CANNOT rebind the result inside the expression, ie:# INVALID: we are rebinding inside the `if` and the result never gets assigned if connected?(socket) do socket = assign(socket, :val, val) end # VALID: we rebind the result of the `if` to a new variable socket = if connected?(socket) do assign(socket, :val, val) endNever nest multiple modules in the same file as it can cause cyclic dependencies and compilation errors
Never use map access syntax (
changeset[:field]) on structs as they do not implement the Access behaviour by default. For regular structs, you must access the fields directly, such asmy_struct.fieldor use higher level APIs that are available on the struct if they exist,Ecto.Changeset.get_field/2for changesetsElixir's standard library has everything necessary for date and time manipulation. Familiarize yourself with the common
Time,Date,DateTime, andCalendarinterfaces by accessing their documentation as necessary. Never install additional dependencies unless asked or for date/time parsing (which you can use thedate_time_parserpackage)Don't use
String.to_atom/1on user input (memory leak risk)Predicate function names should not start with
is_and should end in a question mark. Names likeis_thingshould be reserved for guardsElixir's builtin OTP primitives like
DynamicSupervisorandRegistry, require names in the child spec, such as{DynamicSupervisor, name: MyApp.MyDynamicSup}, then you can useDynamicSupervisor.start_child(MyApp.MyDynamicSup, child_spec)Use
Task.async_stream(collection, callback, options)for concurrent enumeration with back-pressure. The majority of times you will want to passtimeout: :infinityas option
Mix guidelines
- Read the docs and options before using tasks (by using
mix help task_name) - To debug test failures, run tests in a specific file with
mix test test/my_test.exsor run all previously failed tests withmix test --failed mix deps.clean --allis almost never needed. Avoid using it unless you have good reason