.cursorrules Elixir Engineer Guidelines

by @Zane Riley

Act as an expert senior Elixir engineer.

Stack: 
Elixir, Phoenix, Docker, PostgreSQL, Tailwind CSS, LeftHook, Sobelow, Credo, Ecto, ExUnit, Plug, Phoenix LiveView, Phoenix LiveDashboard, Gettext, Jason, Swoosh, Finch, DNS Cluster, File System Watcher, Release Please, ExCoveralls

[optional scope]: 

[optional body]

[optional footer(s)]

Where:

type: One of the following:

scope (optional): A noun describing a section of the codebase (e.g., fluxcd, deployment).

description: A brief summary of the change in present tense.

body (optional): A more detailed explanation of the change.

footer (optional): One or more footers in the following format:

Elixir Development Toolkit

A suite of tools designed to enhance Elixir-based development, focusing on microservices, real-time collaboration, and automation:

Elixir Microservices Platform

Creates and manages microservices using Elixir, Docker, and PostgreSQL, with real-time updates via Phoenix LiveView.

Real-Time Collaboration Tool

Enables simultaneous collaboration on projects using Elixir and Phoenix LiveView, with modern styling via Tailwind CSS.

Automated DevOps Pipeline

Automates deployment processes using Docker, integrating security and style checks with tools like Sobelow and Credo.

Localisation Management System

Manages translations using Gettext, providing a user-friendly dashboard for multilingual support.

Secure Communication Platform

Develops a secure messaging app using Elixir and Phoenix, with continuous security scans via Sobelow.

Incident Monitoring and Response Tool

Creates an alerting system using DNS Cluster and Phoenix LiveDashboard for network monitoring.

Cloud-Based E-commerce Solution

Builds a scalable e-commerce platform using Phoenix LiveView and PostgreSQL, with easy deployment via Docker.

Interactive Learning Platform

Develops interactive coding tutorials with real-time feedback using Phoenix LiveView and Ecto.

API Management and Gateway

Develops an API gateway solution using Elixir’s Plug, allowing API usage rules and traffic monitoring.

Customizable Dashboarding Tool

Creates customized dashboards using Phoenix LiveDashboard, integrating metrics via Ecto and visualizing with Tailwind CSS.

Overview of .cursorrules prompt

The .cursorrules file outlines guidelines for an expert senior Elixir engineer working with a tech stack that includes Elixir, Phoenix, Docker, and various other tools and libraries. It emphasizes the importance of thorough consideration of code requirements before development and the provision of insightful follow-up questions after responses. The file also provides a structured approach to writing commit messages, detailing types, optional scope, description, and potential body or footer for changes made within software projects. This ensures clarity, consistency, and proper categorization of code alterations.

Updated: March 14, 2025

Developers working with Elixir and Phoenix would benefit by standardizing robust commit messages and building scalable, maintainable applications with comprehensive code quality and CI practices.

Usefull for: