1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
|
defmodule EarmarkParser.Options do
# What we use to render
defstruct renderer: EarmarkParser.HtmlRenderer,
# Inline style options
all: false,
gfm: true,
gfm_tables: false,
breaks: false,
footnotes: false,
footnote_offset: 1,
wikilinks: false,
parse_inline: true,
# allow for annotations
annotations: nil,
# additional prefies for class of code blocks
code_class_prefix: nil,
# Filename and initial line number of the markdown block passed in
# for meaningful error messages
file: "<no file>",
line: 1,
# [{:error|:warning, lnb, text},...]
messages: MapSet.new([]),
pure_links: true,
sub_sup: false,
math: false,
# deprecated
pedantic: false,
smartypants: false,
timeout: nil
@type t :: %__MODULE__{
all: boolean(),
gfm: boolean(),
gfm_tables: boolean(),
breaks: boolean(),
footnotes: boolean(),
footnote_offset: non_neg_integer(),
wikilinks: boolean(),
parse_inline: boolean(),
# allow for annotations
annotations: nil | binary(),
# additional prefies for class of code blocks
code_class_prefix: nil | binary(),
# Filename and initial line number of the markdown block passed in
# for meaningful error messages
file: binary(),
line: number(),
# [{:error|:warning, lnb, text},...]
messages: MapSet.t(),
pure_links: boolean(),
sub_sup: boolean(),
# deprecated
pedantic: boolean(),
smartypants: boolean(),
timeout: nil | non_neg_integer()
}
@doc false
def add_deprecations(options, messages)
def add_deprecations(%__MODULE__{smartypants: true} = options, messages) do
add_deprecations(
%{options | smartypants: false},
[
{:deprecated, 0, "The smartypants option has no effect anymore and will be removed in EarmarkParser 1.5"}
| messages
]
)
end
def add_deprecations(%__MODULE__{timeout: timeout} = options, messages) when timeout != nil do
add_deprecations(
%{options | timeout: nil},
[
{:deprecated, 0, "The timeout option has no effect anymore and will be removed in EarmarkParser 1.5"}
| messages
]
)
end
def add_deprecations(%__MODULE__{pedantic: true} = options, messages) do
add_deprecations(
%{options | pedantic: false},
[
{:deprecated, 0, "The pedantic option has no effect anymore and will be removed in EarmarkParser 1.5"}
| messages
]
)
end
def add_deprecations(_options, messages) do
messages
end
@doc ~S"""
Use normalize before passing it into any API function
iex(1)> options = normalize(annotations: "%%")
...(1)> options.annotations
~r{\A(.*)(%%.*)}
"""
def normalize(options)
def normalize(%__MODULE__{} = options) do
case options.annotations do
%Regex{} ->
options
nil ->
options
_ ->
%{
options
| annotations: Regex.compile!("\\A(.*)(#{Regex.escape(options.annotations)}.*)")
}
end
|> _set_all_if_applicable()
|> _deprecate_old_messages()
end
def normalize(options) do
struct(__MODULE__, options) |> normalize()
end
defp _deprecate_old_messages(options)
defp _deprecate_old_messages(%__MODULE__{messages: %MapSet{}} = options) do
options
end
defp _deprecate_old_messages(%__MODULE__{} = options) do
%{
options
| messages:
MapSet.new([
{:deprecated, 0, "messages is an internal option that is ignored and will be removed from the API in v1.5"}
])
}
end
defp _set_all_if_applicable(options)
defp _set_all_if_applicable(%{all: true} = options) do
%{options | breaks: true, footnotes: true, gfm_tables: true, sub_sup: true, wikilinks: true}
end
defp _set_all_if_applicable(options) do
options
end
end
# SPDX-License-Identifier: Apache-2.0
|
