Skip to content

Autolink Kernel functions and special forms with shorthands #861

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 23, 2018
Merged

Autolink Kernel functions and special forms with shorthands #861

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion lib/ex_doc/formatter/html/autolink.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -419,7 +419,7 @@ defmodule ExDoc.Formatter.HTML.Autolink do
end

module_re = Regex.source(~r{(([A-Z][A-Za-z_\d]+)\.)+})
fun_re = Regex.source(~r{([ct]:)?(#{module_re}(([a-z_]+[A-Za-z_\d]*[\\?\\!]?)|[\{\}=&\\|\\.<>~*^@\\+\\%\\!-\/]+)/\d+)})
fun_re = Regex.source(~r{([ct]:)?((#{module_re})?(([a-z_]+[A-Za-z_\d]*[\\?\\!]?)|[\{\}=&\\|\\.<>~*^@\\+\\%\\!-\/]+)/\d+)})
@custom_re ~r{\[(.*?)\]\(`(#{fun_re})`\)}
@normal_re ~r{(?<!\[)`\s*(#{fun_re})\s*`(?!\])}

Expand All @@ -439,10 +439,19 @@ defmodule ExDoc.Formatter.HTML.Autolink do
{prefix, module, function, arity} = split_function(match)
text = text || "`#{module}.#{function}/#{arity}`"

aliases = []
elixir_docs = get_elixir_docs(aliases, lib_dirs)

cond do
match in project_funs ->
"[#{text}](#{module}#{extension}##{prefix}#{enc_h function}/#{arity})"

match in @kernel_function_strings ->
"[#{text}](#{elixir_docs}Kernel#{extension}##{prefix}#{enc_h function}/#{arity})"

match in @special_form_strings ->
"[#{text}](#{elixir_docs}Kernel.SpecialForms#{extension}##{prefix}#{enc_h function}/#{arity})"

doc = lib_dirs_to_doc("Elixir." <> module, lib_dirs) ->
"[#{text}](#{doc}#{module}.html##{prefix}#{enc_h function}/#{arity})"

Expand Down
12 changes: 12 additions & 0 deletions test/ex_doc/formatter/html/autolink_test.exs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,6 +147,18 @@ defmodule ExDoc.Formatter.HTML.AutolinkTest do

assert Autolink.elixir_functions("[`foo`](`Foo.//2`)", ["Foo.//2"]) ==
"[`foo`](Foo.html#//2)"

assert Autolink.elixir_functions("[`for`](`Kernel.SpecialForms.for/1`)", []) ==
"[`for`](#{@elixir_docs}elixir/Kernel.SpecialForms.html#for/1)"

assert Autolink.elixir_functions("[`for`](`for/1`)", []) ==
"[`for`](#{@elixir_docs}elixir/Kernel.SpecialForms.html#for/1)"

assert Autolink.elixir_functions("[`is_boolean`](`Kernel.is_boolean/1`)", []) ==
"[`is_boolean`](#{@elixir_docs}elixir/Kernel.html#is_boolean/1)"

assert Autolink.elixir_functions("[`is_boolean`](`is_boolean/1`)", []) ==
"[`is_boolean`](#{@elixir_docs}elixir/Kernel.html#is_boolean/1)"
end

test "autolink functions to types in the project" do
Expand Down