gperales

gperales

Hi folks!

With the new release of Elixir 1.18, I would like to enforce pattern-matching by struct in our projects to take advantage of the type inference. To do so, I’m working on a Credo check and I would like feedback.

The rule will do the following:

:stop_sign: Pattern-matching by an atom key of a map:

# not preferred
def get_role(%{role: role}) do # if the map keys are atoms it should be a Struct.
  role
end

:white_check_mark: Pattern-matching by struct

# preferred
def get_role(%User{role: role}) do
  role
end
# preferred
def get_role(user = %User{}) do
  user.role
end

I’ve found that there are cases where there are maps with atom keys and they don’t have to be structs, like in the props of the LiveView Components, or the Phoenix Controllers, but I think it is worth having this check and disable it for those cases, or cheat the rule moving the pattern matching inside the body of the function like for this case:

def update(%{param_1: param_1, param_2: param_2}, socket) do
  ...
end

doing:

def update(params, socket) do
  %{param_1: param_1, param_2: param_2} = params
  ...
end

Do you think it would make sense? Would you find it useful enough to add it to Credo?

Showing Posts 1 to 1

sodapopcan

sodapopcan

Hey, welcome to the forum!

It can be contentious but I often destructure params inside the function body, preferring to only match what’s necessary in the function head (within reason). It’s even mention in the anti-pattern guide. That is just to say it’s hard to handle that case as it’s often legit. In any event, I think there needs to be some level of trust there!

Otherwise, it may be overkill but if there is a bare map you could have the rule require adding a guard with is_non_struct_map/1.

— All posts loaded —

Where Next? Top

Trending in Questions Top

RSP87
I’m working on a project that simulates the bumbl example in the programming phoenix book. It acts almost like an email client. We have a...
New
nseaSeb
Hello, I know there is an approach for handling lists that allows for optimized traversal, but I can’t recall the specific method (somet...
New
RemyXRenard
I’m seeing that a list inside a Kino.DataTable will be interpreted as a charlist, even if the Kino.configure() is set to charlists: :as_l...
New
brecabral
Documentation While reading the Scoped Routes section, I noticed that the documentation currently refers to a problem without explainin...
New
velrest
So my question is quite simple and i have found no conclusive answer on forum, google or AI. Should we use :erlang.float for Integer to ...
New
samoloth
Hi, I’ve just set up an application with ash_authentication. There is only magic link strategy for now, so there is no confirmation add o...
New
FlyingNoodle
If a change or preparation module uses Ash.Changeset.get_argument/2 or Ash.Query.get_argument/2 (or any of the other get_argument functio...
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
mudasobwa
I am happy to introduce the very α version of the new programming language compiled to BEAM. Welcome Cure. It has literally three kille...
New
marciok
Hi there! We created Gust: A task orchestrator inspired by Airflow. For those who have never heard about Aiflow, it’s a Python-based wor...
New
mhanberg
Hi everyone! The first release candidate for the Expert language server project is now available! We’ve published a press release detai...
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
Dmk
Xamal is a deployment tool for Elixir apps that deploys native releases to bare metal servers over SSH. It’s a port of GitHub - basecamp/...
New

We're in Beta

About us Mission Statement

Options

Thread Display Mode




Thread Preview

Skip Thread Previews