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
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
|
defmodule ExDoc.Config do
@moduledoc false
# Defaults
@default_source_ref "main"
def filter_modules(_module, _metadata), do: true
def before_closing_head_tag(_), do: ""
def before_closing_footer_tag(_), do: ""
def before_closing_body_tag(_), do: ""
def annotations_for_docs(_), do: []
def skip_undefined_reference_warnings_on(_string), do: false
def skip_code_autolink_to(_string), do: false
defstruct annotations_for_docs: &__MODULE__.annotations_for_docs/1,
api_reference: true,
apps: [],
assets: %{},
authors: nil,
before_closing_body_tag: &__MODULE__.before_closing_body_tag/1,
before_closing_footer_tag: &__MODULE__.before_closing_footer_tag/1,
before_closing_head_tag: &__MODULE__.before_closing_head_tag/1,
canonical: nil,
cover: nil,
deps: [],
extra_section: nil,
extras: [],
filter_modules: &__MODULE__.filter_modules/2,
formatter: "html",
formatters: [],
groups_for_extras: [],
groups_for_docs: [],
groups_for_modules: [],
homepage_url: nil,
language: "en",
logo: nil,
main: nil,
nest_modules_by_prefix: [],
output: "./doc",
package: nil,
proglang: :elixir,
project: nil,
redirects: %{},
retriever: ExDoc.Retriever,
skip_undefined_reference_warnings_on:
&__MODULE__.skip_undefined_reference_warnings_on/1,
skip_code_autolink_to: &__MODULE__.skip_code_autolink_to/1,
source_beam: nil,
source_ref: @default_source_ref,
source_url: nil,
source_url_pattern: nil,
title: nil,
version: nil
@type t :: %__MODULE__{
annotations_for_docs: (map() -> list()),
api_reference: boolean(),
apps: [atom()],
assets: %{binary() => binary()},
authors: nil | [String.t()],
before_closing_body_tag: (atom() -> String.t()) | mfa() | map(),
before_closing_footer_tag: (atom() -> String.t()) | mfa() | map(),
before_closing_head_tag: (atom() -> String.t()) | mfa() | map(),
canonical: nil | String.t(),
cover: nil | Path.t(),
deps: [{ebin_path :: String.t(), doc_url :: String.t()}],
extra_section: nil | String.t(),
extras: list(),
filter_modules: (module, map -> boolean),
formatter: nil | String.t(),
formatters: [String.t()],
groups_for_extras: keyword(),
groups_for_docs: keyword((keyword() -> boolean)),
groups_for_modules: keyword(),
homepage_url: nil | String.t(),
language: String.t(),
logo: nil | Path.t(),
main: nil | String.t(),
nest_modules_by_prefix: [String.t()],
output: nil | Path.t(),
package: :atom | nil,
project: nil | String.t(),
redirects: %{optional(String.t()) => String.t()} | [{String.t(), String.t()}],
retriever: atom(),
skip_undefined_reference_warnings_on: (String.t() -> boolean),
skip_code_autolink_to: (String.t() -> boolean),
source_beam: nil | String.t(),
source_ref: nil | String.t(),
source_url: nil | String.t(),
source_url_pattern: nil | String.t(),
title: nil | String.t(),
version: nil | String.t()
}
@spec build(String.t(), String.t(), Keyword.t()) :: ExDoc.Config.t()
def build(project, vsn, options) do
{output, options} = Keyword.pop(options, :output, "./doc")
{groups_for_modules, options} = Keyword.pop(options, :groups_for_modules, [])
{nest_modules_by_prefix, options} = Keyword.pop(options, :nest_modules_by_prefix, [])
{proglang, options} = Keyword.pop(options, :proglang, :elixir)
{filter_modules, options} = Keyword.pop(options, :filter_modules, &filter_modules/2)
options =
if groups_for_functions = options[:groups_for_functions] do
IO.warn(":groups_for_functions is deprecated, please use :groups_for_docs instead")
Keyword.put_new(options, :groups_for_docs, groups_for_functions)
else
options
end
{skip_undefined_reference_warnings_on, options} =
Keyword.pop(
options,
:skip_undefined_reference_warnings_on,
&skip_undefined_reference_warnings_on/1
)
{skip_code_autolink_to, options} =
Keyword.pop(options, :skip_code_autolink_to, &skip_code_autolink_to/1)
{source_url_pattern, options} =
Keyword.pop_lazy(options, :source_url_pattern, fn ->
guess_url(options[:source_url], options[:source_ref] || @default_source_ref)
end)
preconfig = %__MODULE__{
filter_modules: normalize_filter_modules(filter_modules),
groups_for_modules: normalize_groups_for_modules(groups_for_modules),
homepage_url: options[:homepage_url],
main: options[:main],
nest_modules_by_prefix: normalize_nest_modules_by_prefix(nest_modules_by_prefix),
output: normalize_output(output),
proglang: normalize_proglang(proglang),
project: project,
skip_undefined_reference_warnings_on:
normalize_skip_list_function(skip_undefined_reference_warnings_on),
skip_code_autolink_to: normalize_skip_list_function(skip_code_autolink_to),
source_url_pattern: source_url_pattern,
version: vsn
}
struct(preconfig, options)
end
defp normalize_output(output) do
String.trim_trailing(output, "/")
end
defp normalize_proglang(binary) when is_binary(binary) do
binary |> String.to_atom() |> normalize_proglang()
end
defp normalize_proglang(proglang) when proglang in [:elixir, :erlang] do
proglang
end
defp normalize_proglang(proglang) do
raise ArgumentError, "#{inspect(proglang)} is not supported"
end
# TODO: The default module groups must be returned by the language
defp normalize_groups_for_modules(groups_for_modules) do
default_groups = [Deprecated: &deprecated?/1, Exceptions: &exception?/1]
groups_for_modules ++
Enum.reject(default_groups, fn {k, _} -> Keyword.has_key?(groups_for_modules, k) end)
end
defp deprecated?(metadata), do: metadata[:deprecated] != nil
defp exception?(metadata), do: metadata[:kind] == :exception
defp normalize_nest_modules_by_prefix(nest_modules_by_prefix) do
nest_modules_by_prefix
|> Enum.map(&inspect_atoms/1)
|> Enum.sort()
|> Enum.reverse()
end
defp inspect_atoms(atom) when is_atom(atom), do: inspect(atom)
defp inspect_atoms(binary) when is_binary(binary), do: binary
defp normalize_filter_modules(string) when is_binary(string),
do: normalize_filter_modules(Regex.compile!(string))
defp normalize_filter_modules(%Regex{} = regex),
do: fn module, _ -> Atom.to_string(module) =~ regex end
defp normalize_filter_modules(fun) when is_function(fun, 2),
do: fun
defp normalize_skip_list_function(strings) when is_list(strings),
do: &(&1 in strings)
defp normalize_skip_list_function(fun) when is_function(fun, 1),
do: fun
defp guess_url(url, ref) do
with {:ok, host_with_path} <- http_or_https(url),
{:ok, pattern} <- known_pattern(host_with_path, ref) do
"https://" <> append_slash(host_with_path) <> pattern
else
_ -> url
end
end
defp http_or_https("http://" <> rest),
do: {:ok, rest}
defp http_or_https("https://" <> rest),
do: {:ok, rest}
defp http_or_https(_),
do: :error
defp known_pattern("github.com/" <> _, ref),
do: {:ok, "blob/#{ref}/%{path}#L%{line}"}
defp known_pattern("gitlab.com/" <> _, ref),
do: {:ok, "blob/#{ref}/%{path}#L%{line}"}
defp known_pattern("bitbucket.org/" <> _, ref),
do: {:ok, "src/#{ref}/%{path}#cl-%{line}"}
defp known_pattern(_host_with_path, _ref),
do: :error
defp append_slash(url) do
if :binary.last(url) == ?/, do: url, else: url <> "/"
end
end
|
