Fl4m3Ph03n1x

Fl4m3Ph03n1x

Background

Recently I decided to do a Mix Task to run some script files in the project. Being my first Mix Task, I followed a tutorial and got the following structure:

defmodule Mix.Tasks.Deploy do
  use Mix.Task
  

  @shortdoc "Compiles the app for PROD and starts a Rolling Release."
  def run(_) do
    #do really awesome stuff here
end

Problem

We are using credo and one of the warnings it gives me is the following:

┃ [D] :down_right_arrow: Nested modules could be aliased at the top of the invoking module.
┃ lib/mix/tasks/deploy.ex:21:19 #(Mix.Tasks.Deploy.run)

Now, I checked the project dos referring to this error:

And from my understanding I take it I should use a alias somewhere, but I don’t see how.

Question

I can I fix the problem and make the warning go away?

Showing Posts 1 to 6

Matt

Matt

It sounds like you are calling a function like this:

defmodule Mix.Tasks.Deploy do
  use Mix.Task

  def run(_) do
    # doing really cool stuff
    # ...

    Comeonin.Argon2.hashpwsalt("some password")

    # ...
    # more cool stuff
  end
end

What credo is suggesting is to do something like this:

defmodule Mix.Tasks.Deploy do
  use Mix.Task
  alias Comeonin.Argon2

  def run(_) do
    # best programming you have ever seen
    # ...

    Argon2.hashpwsalt("bestpassword")

    # ...
    # more cool programming
  end
end

So, credo is complaining that you are calling a function with nested module names, Comeonin.Argon2.hashpwsalt/1, for example. It wants you to call a function with a singular module name, like Argon2.hashpwsalt/1. So you can use alias for this purpose. The cool think about alias is that it is lexically scoped. This means you can use it within a function :exploding_head: if you need.

axelson

axelson

Scenic Core Team

Although do note that the “[D] :arrow_lower_right:” part of the “warning” indicates that is is a very low severity “issue”, really more of a suggestion. I don’t think it’s idiomatic Elixir code to alias every single module you reference. In fact I tend to only alias modules that are used very often in the module, leaving a full module reference to indicate that longer module reference is not used/tied as deeply with the rest of the containing module (sorry this is a little hard to follow).

Matt

Matt

I think your reply is meant for @ Fl4m3Ph03n1x?

I do the same, I actually rarely use alias. In fact, I tend not to like using alias often, because I like to know the origin of the functions I am calling. Right or wrong, that is just personal preference on my part though.

OvermindDL1

OvermindDL1

I alias out parts that are ‘obvious’, like the main namespace at the very least, sometimes down to the specific function call (import) if perfectly obvious, otherwise I keep a name mapping or 2 or 3 worth of dots.

pferdefleisch

pferdefleisch

I alias a lot because it is easy to see when I use too many aliases.
I see this as a code smell that is telling me I have too many dependencies.

But I agree that this warning is a bit too pedantic and shouldn’t give a non-zero return.
Credo forcing aliasing of hex dependencies pushed me to bring this old thread to life :slight_smile:

Adzz

Adzz

I think the main thing is to make sure you don’t lose the ability to search (grep) for the full module name and have all the places where it is used to show up:

defmodule My.Module.Name do
end

defmodule My.OtherModule.Name do
end

defmodule Some.Other do
  # This is a bad alias because if I search for `My.Module.Name` this wont show up
  alias My.Module
  # This is fine, but not always neccessary - you can use the fully qualified name
  alias My.Module.Other
  # In the case of conflicting final names, this is preferred, because I can still search 
  # for `My.OtherModule.Name` and have this show up.
  alias My.OtherModule.Name, as: OtherModuleName
end
— All posts loaded —

Where Next? Top

Trending in Questions Top

itzmidinesh
Hi all, I’m working on a Phoenix project where I need to make external HTTP requests and I’m trying to choose between Req and HTTPoison....
New
yarrichar
I’m very new to Elixir, so sorry if this is a silly question: I am wondering what happens to the mailbox of a process when the machine i...
New
pragdave
How do I tell Hologram not to escape HTML when substituting into templates? {Textile.render(@product.long_description)} escapes the HTM...
New
Fl4m3Ph03n1x
Background When trying to execute mix release on a Windows 11 machine for a Phoenix project I get the following error: * assembling mark...
New
rlipscombe
I’d like to create a file with 600 permissions (rw-------), but there’s a race condition if I create it and then change the permissions. ...
New
saleyn
Is there a way to import record definitions in the iex shell for pretty printing (similar to the rr command in the erl shell)? This woul...
New
rlipscombe
When I use Mix.install with a git dependency, using git@github.com:... how do I change the SSH identity used? I’ve got two Github accoun...
New

Other Trending Topics Top

dominicletz
Hey there, I haven’t seen a list of useful Elixir specific skills for the popular AI tools yet so I’m starting one here with my first. ...
New
raa-ziq
Hi everyone :waving_hand: I wanted to share something I’ve been building — NowBlind, a random chat app designed to help people discover ...
New
mudasobwa
I fully migrated to my own harness from Anthropic/Gemini and I think it’s time to share it. Welcome DSH, the DeepSeek Harness, fully writ...
New
OndrejValenta
(I just needed to vent somewhere and LinkedIn is full of hope, or hype, I’m not sure which exactly) AI dream has many faces, but general...
New
kip
Localize is the next generation localisation library for Elixir. Think of it as ex_cldr version 3.0. The first version will be released ...
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

We're in Beta

About us Mission Statement

Options

Thread Display Mode




Thread Preview

Skip Thread Previews