PID_ONE

PID_ONE

I’m trying to write a couple of mix format plugins for my project. So far I’ve been able to achieve most of what I want (e.g. rewriting function calls) via manipulating the AST except for one that I’m trying to write that involves comments and whitespace modifications.

Specifically, I’d like this plugin to be able to insert blank lines at arbitrary points in the file it’s formatting. For example, I’d like it to be able to insert a comment or then insert some number of blank lines between that comment and the module definition or to insert blank lines between function definitions.

defmodule MyModule do
...

would become

# This is my comment

defmodule MyModule do

and

def function_one(foo) do
...
end
def function_two(bar) do
...
end

would become

def function_one(foo) do
...
end

def function_two(bar) do
...
end

Is this possible through manipulating the AST? And if so, how?

So far I haven’t been able to by changing the line metadata of the AST nodes. However, reading through some of the Styler codebase they are at least manipulating multiline functions through the metadata. To me that seems essentially the same so it seems like I am missing something.

However, from my testing it also seems like information about whitespace gets lost/ignored in the translation to/from AST. For example, this is an AST from my plugin generated from Code.string_to_quoted_with_comments!/2 and despite changing all the line metadata this information is lost going from AST back to string (to be written to the file):

iex(1)> new_ast = {:defmodule, [do: [line: 36], end: [line: 40], line: 36], [{:__aliases__, [last: [line: 36], line: 36], [:PlaygroundSimple]}, [{{:__block__, [line: 36], [:do]}, {:def, [do: [line: 37], end: [line: 39], line: 37], [{:test, [line: 37], nil}, [{{:__block__, [line: 37], [:do]}, {:__block__, [delimiter: "\"", line: 38], ["Hello, World"]}}]]}}]]}
{:defmodule, [do: [line: 36], end: [line: 40], line: 36],
 [
   {:__aliases__, [last: [line: 36], line: 36], [:PlaygroundSimple]},
   [
     {{:__block__, [line: 36], [:do]},
      {:def, [do: [line: 37], end: [line: 39], line: 37],
       [
         {:test, [line: 37], nil},
         [
           {{:__block__, [line: 37], [:do]},
            {:__block__, [delimiter: "\"", line: 38], ["Hello, World"]}}
         ]
       ]}}
   ]
 ]}

iex(3)> Code.quoted_to_algebra(new_ast) |> Inspect.Algebra.format(120)
["defmodule", " ", "PlaygroundSimple", " do", "\n  ", "def", " ", "test", " do",
 "\n    ", "\"", "Hello, World", "\"", "\n  ", "end", "\n", "end"]

If that is the case is there a way around the AST not being able to manipulate whitespace that is recommended? Using regex/string manipulation seems like an alternative but not a particularly robust one.

Showing Posts 1 to 1

hst337

hst337

hexdocs.pm/sourceror

— 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
kszambelanczyk
Hello! Could someone please give me a help/sample code, how to delete a file from s3 using waffle/waffle_ecto from Phoenix app. I creat...
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
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
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
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

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
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
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
netoum
Corex is an accessible, unstyled UI component library for Phoenix that integrates Zag.js state machines using Vanilla JavaScript and Live...
New

We're in Beta

About us Mission Statement

Options

Thread Display Mode




Thread Preview

Skip Thread Previews