knoebber

knoebber

I’d like to extend Earmark to transform #hashtag into

<a href="/some/internal/route">hashtag</a>

Hashtags should only be transformed if they are inside of a string node, so I need to inspect the AST.

I’ve been looking through the Earmark docs and I don’t see a clear way to do this. I don’t think I can use map_ast as it says a string node must return a string.

I’ve found one example of something similar here:

https://github.com/almightycouch/gitgud/blob/cfc8f4652ebb62d9762010bd0a139c97cb59ebde/apps/gitgud_web/lib/gitgud_web/views/helpers/markdown.ex

It looks like they using Enum.map on the ast, but I don’t fully understand the transform_ast_node_text function, particularly the bits that pattern match on binary data. I hope I can do something simpler.

Any help is appreciated, thanks!

Showing Posts 1 to 4

RobertDober

RobertDober

This should not be too difficult

import Earmark.Transform
iex(11)> {:ok, ast,_} = EarmarkParser.as_ast(" #x")
{:ok, [{"p", [], [" #x"], %{}}], []}
iex(12)> transform = fn
...(12)> x when is_tuple(x) -> x
...(12)> _ -> [ " ", {"a", [{"href", "whatever"}], ["x"], %{}}] end # need to scan the parameter for hashtags and create a structure like the one I just put here
#Function<44.65746770/1 in :erl_eval.expr/5>
iex(13)> ast1 =map_ast(ast, transform)
[{"p", [], [[" ", {"a", [{"href", "whatever"}], ["x"], %{}}]], %{}}]
iex(14)> transform(ast1, [])
"<p>\n <a href=\"whatever\">x</a></p>\n"

HTH

knoebber

knoebber OP

hey, thanks for the great work on Earmark!

I realized after posting this that I only want to transform text leafs that are descendants of certain tags. Otherwise I might inject an <a> tag inside of a <code> block for example. Here’s what I came up with if anyone is interested:

def parse_tags(text_leaf) when is_binary(text_leaf) do
  Regex.split(
    ~r/#([a-zA-Z0-9]{2,})/,
    text_leaf,
    include_captures: true
  )
  |> Enum.map(fn
    <<?#, tagname::binary>> ->
      {"a",
       [
         {"class", "tag"},
         {"href", "/board?tag=#{tagname}"}
       ], [tagname], %{}}

    text ->
      text
  end)
end

def map_ast(ast, text_is_eligible_for_hashtag \\ false) do
  Enum.map(ast, fn
    {tag, atts, children, m} ->
      {tag, atts, map_ast(children, tag in ["p", "li"]), m}

    text_leaf ->
      if text_is_eligible_for_hashtag, do: parse_tags(text_leaf), else: text_leaf
  end)
end

def markdown(md) do
  case EarmarkParser.as_ast(md) do
    {:ok, ast, _} -> map_ast(ast) |> Earmark.Transform.transform()
    _ -> md
  end
end
RobertDober

RobertDober

naturally :wink:

yeah I guess in these cases you have to do it yourself, would be an interesting idea to generalize,
many things come into mind, e.g. an option to parse with a callback function that adds things to the meta Map in the AST, or an AST walker that keeps access to the parent nodes, …

Unfortunately no time at all.

RobertDober

RobertDober

I just realized with the release of Earmark 1.4.25 there are two ways to achieve your goals with Earmarks tools at hand

even before 1.4.25 you could have used map_ast_with to keep track of the condition if to replace hashtags or not in the accumulator

and now from 1.4.25 you can also, which IMHO is more elegant, change the mapper function dynamically when traversing with map_ast by not returning a quadruple but a tuple with the new function and a quadruple

here
you can find an example of how to do that

— All posts loaded —

Where Next? Top

Trending in Questions Top

Hellowman
Hello everyone! I am new to coding with Elixir/Erlang. And i am looking for some utilities for fuzzing testing like AFL++. Does anyone ...
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
mandar1045
I load tested a plain Phoenix chat app backed by Postgres with 100 million messages in it, everything on default settings, to see what br...
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

Other Trending Topics Top

GenericJam
Edit: 2026 May 15 - This post is archived. Mob is alive!! Main docs: mob v0.7.11 — Documentation A bit of explanation for the slightly c...
261 13183 112
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
mcass19
ExRatatui lets you cook up rich terminal UIs in Elixir, powered by Rust’s ratatui via Rustler NIFs. Build interactive terminal applicatio...
New
charlenopires
Hi everyone :waving_hand: I’ve been working on PhiaUI, an open-source UI component library for Phoenix LiveView, and I wanted to share i...
New

We're in Beta

About us Mission Statement

Options

Thread Display Mode




Thread Preview

Skip Thread Previews