zorn

zorn

Can I configure the Elixir formatter to auto-sort my alias calls?

I often will get reminded by credo to sort my alias calls like below.

Is there a way I could configure the Elixir formatter (that is kicked by VS Code) to auto-sort these for me?

┃ [R] ↘ The alias `RetroTaxi.JoinBoard` is not alphabetically ordered among its group.
┃       lib/retro_taxi/board_creation.ex:12:9 #(RetroTaxi.BoardCreation)

It looks like formatter Plugins are a recent/upcoming (1.13) thing. Anyone ever try to do this?

https://hexdocs.pm/mix/master/Mix.Tasks.Format.html#module-plugins

Most Liked

dorgan

dorgan

For now, formatter plugins only support sigils and custom file extensions. For what you want, you’d need to find a way to run code before or after the formatter, with Code.string_to_quoted_with_comments and Code.quoted_to_algebra + Inspect.Algebra.format. The challenge is in syncing the changes you did to the AST with the comments.

I created Sourceror specifically for this. Here is an example to sort dependencies in mix.exs:

source
|> Sourceror.parse_string!()
|> Macro.postwalk(fn
  {:defp, meta, [{:deps, _, _} = fun, body]} ->
    [{{_, _, [:do]}, block_ast}] = body
    {:__block__, block_meta, [deps]} = block_ast

    deps =
      Enum.sort_by(deps, fn {:__block__, _, [{{_, _, [name]}, _}]} ->
        Atom.to_string(name)
      end)

    {:defp, meta, [fun, [do: {:__block__, block_meta, [deps]}]]}

  quoted ->
    quoted
end)
|> Sourceror.to_string()
|> IO.puts()

You can do something similar to sort aliases.

Note: There is currently a bug affecting the ordering of comments under certain circumstances that I need to fix.

axelson

axelson

Scenic Core Team

Ah, that extension looks helpful! Although one downside is that (if I understand it correctly) is that you need to run it on each list of aliases you have.

There’s an elixir project that was started after this thread (and is based on Sourceror) that makes this even easier:

Recode has a Task.AliasOrder that if configured will auto-sort your aliases when you run mix recode :tada:

Fl4m3Ph03n1x

Fl4m3Ph03n1x

Although auto-sorting aliases on save is still not a thing the formatter has (at the time of this writing), I have found this VSCode extension to do the job just fine:

Highly recommend it.

xxdavid

xxdavid

Hi, I created a VS Code extension just for that. :slightly_smiling_face:

dimitarvp

dimitarvp

The Quokka formatter does this and I love it for it.

Where Next?

Popular in Questions Top

lessless
I believe there are people here who are dealing with CSV files import on the daily basis, and since Excel is a really popular tool there ...
New
openscript
Hello! Sorry for this astonishing simple question, but I’m really stuck. I try to set up the intellij-elixir plugin, but I don’t know ho...
New
_russellb
I want to try my hand at web scraping. What tools/libraries do I need to use. I’m hoping to turn this into something professional so don’...
New
fireproofsocks
I’m working on defining a simple Ecto schema for a table (in PostGres), but I don’t see where I can define a column as NOT NULL. Conside...
New
polypush135
As many of you may have realized by now (sorry for all the posts here) I’ve been working on a db problem where I’m trying to aggregate a ...
New
mcarvalho
What is the difference between System.get_env and Application.get_env? For example, what are best practices to use one versus another.
New
hpopp
To simplify some tasks at work, I wrote and published this package yesterday. It’s a simple macro that enables Access behaviour on struct...
New
Fl4m3Ph03n1x
About me? ( if you have nothing better to do than reading about some random guy in the internet :stuck_out_tongue: ) Hello all, this is ...
New
lucidguppy
I have a super simple question about elixir - how would I take a file like this foo bar baz and output a new file that enumerates th...
New
lanycrost
Hi everyone! I need implement if…else if…else condition from my elixir code, and anymore of this control flow structures not work proper...
New

Other popular topics Top

senggen
Erlang/OTP 25 [erts-13.2.2] [source] [64-bit] [smp:8:8] [ds:8:8:10] [async-threads:1] 15:22:35.803 [error] gen_event {lager_file_backend...
New
dotdotdotPaul
Okay, I'm having a heck of a time trying to figure out how to best handle the validation of belongs_to associations in Ecto. I'm sure I'...
New
JorisKok
I have a server on AWS, and was running a load test using artillery. When looking at the Phoenix dashboard I see the Ports going to 100% ...
New
axelson
This post is a wiki (feel free to hit the edit button near the bottom right of this post to add your own changes!) This post collects co...
239 45766 226
New
New
lastday4you
I wanted to check elixir version in phoenix because i found that my elixir is 1.5 but when i use Enum.chunk_by it said the function is un...
New
vac
Hi, I'm quite new in Elixir and I'm trying to format a string to a PEM format. I have the certificate value like MIIDBTCCAe2...... and ...
New
shahryarjb
Hello, I have map which I want to convert it to string like this: the map: %{last_name: "tavakkoli", name: "shahryar"} the string I ne...
New
beno
I will often find my self writing things similar to: case some_value do nil -> something() "" -> something() _ -> someth...
New
skosch
To my knowledge, put_in, Map.update etc. all have the one limitation of not automatically creating intermediate keys when needed (for exa...
New

We're in Beta

About us Mission Statement