zpeters

zpeters

Examples of code that follow the "Elixir Way"?

I’ve been recently trying to “level up” my Elixir code. In Python there is the idea of code being very “Pythonic”. In Elixir…not sure what you’d call that. What are some examples of code (well known, personal projects, etc) that you feel exhibit good Elixir habits and design.

Thank you in advance!

First 9 of 9 Posts! Switch mode

leifericf

leifericf

It sounds like you’re asking about what would be considered idiomatic in terms of coding style and how to organize an application; both the source files and the code within the source files.

Python has The Zen of Python, which includes:

There should be one—and preferably only one—obvious way to do it.

I’m not aware of any similar set of aphorisms for Elixir, although I suppose the Python aphorisms could be successfully applied as general rules of thumb when coding in most languages.

I often hear Elixir developers talk about explicitness and readability. That seems to be important.

Elixir has a built-in code formatter which can help with structuring code “the correct way.” Certain frameworks and libraries, such as Phoenix, add a suggested folder- and file structure.

Other than that, I think pretty much anything goes.

I would suggest browsing through open source projects and looking at how they are structured at different levels. This might be helpful in building up an intuition for idiomatic Elixir.

zpeters

zpeters

Do you have a favorite project that might be a good jumping off point?

blatyo

blatyo

Conduit Core Team

I would also mention credo, which covers style guide conventions that a formatter would be unable to.

As far as idiomatic projects, I would suggest looking at:

leifericf

leifericf

I’m just a beginner myself, so my knowledge is rather limited. I’m sure a more experienced forum friend will drop in and provide some good references. I would appreciate that as well.

leifericf

leifericf

Awesome! I wasn’t aware of credo until now. That will be useful.

AstonJ

AstonJ

Yep, it’s called idiomatic-elixir :003:

I’ll add the tag to your thread for you :023:

zpeters

zpeters

heck yeah, thanks

zpeters

zpeters

Rock on, Thank you

mandarvaze

mandarvaze

credo can be incorporated in the IDE, so that it can point of “code smells” while you are writing the code. I’ve used it only with emacs/alchemist.el, I’m sure other integrations exists.

Having said that - in my opinion (I’m a elixir-beginner myself) the tool will catch errors, but need not help you write “idiomatic elixir” (Looking at credo source code might, but some “seasoned” developer confirm that)

Where Next?

Trending in Questions Top

jonnycharles
I’m in search of an Elixir library that offers PDF generation capabilities similar to Ruby’s Prawn. While there have been discussions abo...
New
spammy
I’m looking to build a personal workflow to quickly deploy web applications written in elixir/phoenix, for local consumption (ie not on t...
New
silverdr
Using Phoenix.LiveView.TagEngine as an EEx.Engine is deprecated! To compile HEEx, use Phoenix.LiveView.TagEngine.compile/2 instead. Sta...
New
saveman71
Hello ! We want new/edit form pages to POST/PUT to their own URL rather than the resources REST defaults (post /things, put /things/:id)...
New
dli
Before I dive in myself, did anyone successfully sprinkle Hologram into their existing LiveView app? Looking for hints regarding: Addi...
New
bottlenecked
Hi all, I wanted to ask how the community is dealing with post-release steps. Today we have Ecto migrations, which make sure that the db...
New
michallepicki
I am using Oban and occasionally, shortly after a deployment, a handful of jobs can fail because of dependency on other parts of the syst...
New

Other Trending Topics Top

JesseHerrick
Hey, I’m Jesse and I’m the main contributor behind Dexter, a full-featured, lightning-fast Elixir LSP optimized for large codebases. It s...
New
jimsynz
Beam Bots (or just BB for short) is a framework for building fault-tolerant robotics applications in Elixir using familiar OTP patterns. ...
New
Damirados
Hello everyone. After busy few months I am happy to announce v0.1.0 of Emerge & Solve. They are GUI (Emerge) and State management (S...
New
ausimian
Emily is an Elixir library that runs Nx computations on Apple’s MLX. Install it as the default Nx backend and Nx, defn, Axon, Nx.Serving,...
New
type1fool
I just stumbled on a newly redesigned elixir-lang.org. :tada: It looks like @Software_Mansion did the work, and I think it is generally a...
New
akoutmos
@hugobarauna and I (Alex Koutmos) have been hard at work on writing a book on Nerves that takes you from simply blinking LEDs to building...
New

We're in Beta

About us Mission Statement