EarmarkAstDsl v0.2.2 EarmarkAstDsl View Source
EarmarkAstDsl is a toolset to generate EarmarkParser conformant AST Nodes version 1.4.6 and on, which is the always return quadruples version.
Its main purpose is to remove boilerplate code from Earmark and
EarmarkParser tests.
Documentation for EarmarkAstDsl
.
tag
The most general helper is the tag function:
iex(1)> tag("div", "Some content")
{"div", [], ["Some content"], %{}}
Content and attributes can be provided as arrays, ...
iex(2)> tag("p", ~w[Hello World], class: "hidden")
{"p", [{"class", "hidden"}], ["Hello", "World"], %{}}
... or maps:
iex(3)> tag("p", ~w[Hello World], %{class: "hidden"})
{"p", [{"class", "hidden"}], ["Hello", "World"], %{}}
Shortcuts for p
and div
iex(4)> p("A para")
{"p", [], ["A para"], %{}}
iex(5)> div(tag("span", "content"))
{"div", [], [{"span", [], ["content"], %{}}], %{}}
Link to this section Summary
Functions
Tables
Tables are probably the raison d'être ot this little lib, as their ast is quite verbose, as we will see here
This is the base helper which emits a tag with its content, attributes and metadata can be added at the user's convenience
Void tags are just convenient shortcats for calls to tag
with the second argument
nil
or []
Link to this section Types
Link to this section Functions
Specs
div(content_t(), free_atts_t()) :: ast_t()
Specs
p(content_t(), free_atts_t()) :: ast_t()
Specs
table(table_t(), free_atts_t()) :: ast_t()
Tables
Tables are probably the raison d'être ot this little lib, as their ast is quite verbose, as we will see here:
iex(6)> table("one cell only") # and look at the output
{"table", [], [
{"tbody", [], [
{"tr", [], [
{"td", [{"style", "text-align: left;"}], ["one cell only"], %{}}
], %{}}
], %{}}
], %{}}
Now if we want a header and have some more data:
iex(7)> table([~w[1-1 1-2], ~w[2-1 2-2]], head: ~w[left right]) # This is quite verbose!
{"table", [], [
{"thead", [], [
{"tr", [], [
{"th", [{"style", "text-align: left;"}], ["left"], %{}},
{"th", [{"style", "text-align: left;"}], ["right"], %{}},
], %{}}
], %{}},
{"tbody", [], [
{"tr", [], [
{"td", [{"style", "text-align: left;"}], ["1-1"], %{}},
{"td", [{"style", "text-align: left;"}], ["1-2"], %{}},
], %{}},
{"tr", [], [
{"td", [{"style", "text-align: left;"}], ["2-1"], %{}},
{"td", [{"style", "text-align: left;"}], ["2-2"], %{}},
], %{}}
], %{}}
], %{}}
And tables can easily be aligned differently in Markdown, which makes some style helpers very useful
iex(8)> table([~w[1-1 1-2], ~w[2-1 2-2]],
...(8)> head: ~w[alpha beta],
...(8)> text_aligns: ~w[right center])
{"table", [], [
{"thead", [], [
{"tr", [], [
{"th", [{"style", "text-align: right;"}], ["alpha"], %{}},
{"th", [{"style", "text-align: center;"}], ["beta"], %{}},
], %{}}
], %{}},
{"tbody", [], [
{"tr", [], [
{"td", [{"style", "text-align: right;"}], ["1-1"], %{}},
{"td", [{"style", "text-align: center;"}], ["1-2"], %{}},
], %{}},
{"tr", [], [
{"td", [{"style", "text-align: right;"}], ["2-1"], %{}},
{"td", [{"style", "text-align: center;"}], ["2-2"], %{}},
], %{}}
], %{}}
], %{}}
Some leeway is given for the determination of the number of columns, bear in mind that Markdown only supports regularly shaped tables with a fixed number of columns.
Problems might arise when we have a table like the following
| alpha |
| beta *gamma* |
where the first cell contains one element, but the second two, we can hint that we only want one by grouping into tuples
iex(9)> table(["alpha", {"beta", tag("em", "gamma")}])
{"table", [], [
{"tbody", [], [
{"tr", [], [
{"td", [{"style", "text-align: left;"}], ["alpha"], %{}},
], %{}},
{"tr", [], [
{"td", [{"style", "text-align: left;"}], ["beta", {"em", [], ["gamma"], %{}}], %{}}
], %{}}
], %{}}
], %{}}
Specs
This is the base helper which emits a tag with its content, attributes and metadata can be added at the user's convenience
iex(10)> tag("div")
{"div", [], [], %{}}
With content,
iex(11)> tag("span", "hello")
{"span", [], ["hello"], %{}}
... and attributes,
iex(12)> tag("code", "let it(:be_light)", [class: "inline"])
{"code", [{"class", "inline"}], ["let it(:be_light)"], %{}}
... and metadata
iex(13)> tag("div", "content", [], %{verbatim: true})
{"div", [], ["content"], %{verbatim: true}}
Specs
void_tag(binary(), free_atts_t()) :: ast_t()
Void tags are just convenient shortcats for calls to tag
with the second argument
nil
or []
One cannot pass metadata to a void_tag call
iex(14)> void_tag("hr")
{"hr", [], [], %{}}
iex(15)> void_tag("hr", class: "thin")
{"hr", [{"class", "thin"}], [], %{}}