Elixir Coding Conventions

[chriseyre]

I am a mentor on Exercism.IO. I had made a suggestion about using

do_XXX as the defp inner function of XX

They asked about other conventions. Do we have a standard list?
I could suggest pointing Credo at your code…

[david_ex]

I cannot find it again, but I recall @josevalim saying (somewhere on this forum) that where possible they’re moving away from using do_xxx and instead using either a private xxx function with a different arity (e.g. an accumulator as extra arg) or a more appropriately named private function.

[IRLeif]

I would suggest to use the code formatter + Credo

[LostKobrakai]

https://hexdocs.pm/elixir/naming-conventions.html
https://hexdocs.pm/elixir/syntax-reference.html
https://hexdocs.pm/elixir/library-guidelines.html

[IRLeif]

Whoa, I was not aware of those pages.

Are there any points in those style guides which are not enforced by the code formatter?

[peerreynders]

The Elixir Style Guide

I was recently asked to step up and become the maintainer for the Elixir Style Guide. It was, I believe, the first, and is now the most popular, community-driven style guide for Elixir. The guide aims to be very accessible and open to contributions, and if you’re willing to send us your changes and feedback, it’s a great way to give back to the Elixir community that has given us so much. As the guide says: Style matters. Elixir has plenty of style but like all languages it can be stifled. Do…