chulkilee

chulkilee

How to remove comments from Elixir code?

I found Code.string_to_quoted/2 returns quoted expression, but couldn’t find a way to rebuild it to code. Also, it has all location information and complicated nest format… so it’s doable but doesn’t seem “easy” at the first glance (e.g. no documentation on the structure? )

I already have a shell script to remove any line starting with # (with optional leading white spaces).. but of course that can break things (e.g. # in multiline string)

Any tips?

First 6 of 6 Posts Switch mode

kokolegorille

kokolegorille

Maybe sed?

or awk?

awk '!/^ *#/ && NF' file
chulkilee

chulkilee OP

I’m already using sed but I’d like to handle it with AST so that it doesn’t remove markdown header from multistring @doc, for example

Here is a command I usually run after mix new

sed -i '/^ *#/d' \
  .gitignore \
  config/*.exs \
  lib/**/*.ex \
  mix.exs \
  test/**/*.ex \
  test/**/*.exs

mix format
Schultzer

Schultzer

You are looking for Macro — Elixir v1.20.2

NobbZ

NobbZ

You can use Macro.to_string/1/2:

iex(1)> """
...(1)> defmodule M do
...(1)>   # a function
...(1)>   def foo, do: :foo
...(1)> end
...(1)> """
"defmodule M do\n  # a function\n  def foo, do: :foo\nend\n"
iex(2)> Code.string_to_quoted(v(1))
{:ok,
 {:defmodule, [line: 1],
  [
    {:__aliases__, [line: 1], [:M]},
    [do: {:def, [line: 3], [{:foo, [line: 3], nil}, [do: :foo]]}]
  ]}}
iex(3)> v(2) |> elem(1) |> Macro.to_string
"defmodule(M) do\n  def(foo) do\n    :foo\n  end\nend"
iex(4)> IO.puts(v(3))
defmodule(M) do
  def(foo) do
    :foo
  end
end
:ok
chulkilee

chulkilee OP

Thanks - but I found it does not return same format as mix format for .exs

remove-comment.exs file

# top-level comment

defmodule RemoveComment do
  # in-module comment

  def run(code_string) do
    # in-func comment
    code_string
    |> Code.string_to_quoted!()
    |> Macro.to_string()
  end
end

"./remove-comment.exs"
|> File.read!()
|> RemoveComment.run()
|> IO.puts()

$ elixir --version
Erlang/OTP 22 [erts-10.4.4] [source] [64-bit] [smp:8:8] [ds:8:8:10] [async-threads:1] [hipe]

Elixir 1.9.0 (compiled with Erlang/OTP 22)

$ elixir remove-comment.exs
(
  defmodule(RemoveComment) do
    def(run(code_string)) do
      code_string |> Code.string_to_quoted!() |> Macro.to_string()
    end
  end
  "./remove-comment.exs" |> File.read!() |> RemoveComment.run() |> IO.puts()
)
Schultzer

Schultzer

Thats properly because the formatter use Inspect.Algebra — Elixir v1.20.2

— All posts loaded —

Where Next? Top

Trending in Questions Top

stjefim
Hello! Suppose you are building workflow (order / task / payment) processing system with the following requirements: Each workflow con...
New
jonnycharles
I’m in search of an Elixir library that offers PDF generation capabilities similar to Ruby’s Prawn. While there have been discussions abo...
New
spammy
I’m looking to build a personal workflow to quickly deploy web applications written in elixir/phoenix, for local consumption (ie not on t...
New
silverdr
Using Phoenix.LiveView.TagEngine as an EEx.Engine is deprecated! To compile HEEx, use Phoenix.LiveView.TagEngine.compile/2 instead. Sta...
New
dli
Before I dive in myself, did anyone successfully sprinkle Hologram into their existing LiveView app? Looking for hints regarding: Addi...
New
bottlenecked
Hi all, I wanted to ask how the community is dealing with post-release steps. Today we have Ecto migrations, which make sure that the db...
New
michallepicki
I am using Oban and occasionally, shortly after a deployment, a handful of jobs can fail because of dependency on other parts of the syst...
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
jimsynz
Beam Bots (or just BB for short) is a framework for building fault-tolerant robotics applications in Elixir using familiar OTP patterns. ...
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
ausimian
Emily is an Elixir library that runs Nx computations on Apple’s MLX. Install it as the default Nx backend and Nx, defn, Axon, Nx.Serving,...
New
type1fool
I just stumbled on a newly redesigned elixir-lang.org. :tada: It looks like @Software_Mansion did the work, and I think it is generally a...
New
juhalehtonen
There has been a thread to discuss the Stack Overflow Developer Survey on this forum every year since 2018, so here’s yet another one for...
New

We're in Beta

About us Mission Statement