Fix ex_doc and rebar.config (#186)

Author: NelsonVides

.gitignore

@@ -12,6 +12,7 @@ priv/_*.json
 .eunit/
 db/
 _build/
+doc/
 Mnesia.nonode@nohost/
 *.DCD
 *.DCL

Makefile

@@ -19,6 +19,7 @@ clean:
 
 .PHONY: test
 test:
+	rebar3 xref
 	rebar3 eunit
 	rebar3 fmt --check
 	rebar3 dialyzer

rebar.config

@@ -1,6 +1,3 @@
-%%-*- mode: erlang -*-
-{cover_enabled, true}.
-
 {erl_opts, [
     debug_info,
     fail_on_warning,
@@ -10,7 +7,12 @@
 
 {minimum_otp_vsn, "27"}.
 
-{project_plugins, [erlfmt, rebar3_depup]}.
+{project_plugins, [
+    {rebar3_depup, "0.4.0"},
+    {rebar3_hex, "~> 7.0"},
+    {rebar3_ex_doc, "~> 0.2"},
+    {erlfmt, "~> 1.6"}
+]}.
 
 {deps, [
     {lager, "3.9.2"},
@@ -22,18 +24,19 @@
     {opentelemetry_api, "1.4.0"},
     {meck, "1.0.0"}
 ]}.
-{profiles, [{test, [{deps, [proper]}]}]}.
 
-{format, [
-    {formatter, default_formatter},
-    {files, ["src/**/*.?rl", "include/**/*.?rl"]},
-    {options, #{
-        paper => 160,
-        ribbon => 150,
-        inline_attributes => none,
-        inline_qualified_function_composition => true
-    }}
+{profiles, [
+    {test, [
+        {deps, [{proper, "1.4.0"}]},
+        {erl_opts, [nowarn_export_all, nowarn_missing_spec, nowarn_missing_doc]},
+        {covertool, [{coverdata_files, ["eunit.coverdata", "ct.coverdata"]}]},
+        %% Increment min_coverage when deprecations are removed
+        {cover_opts, [verbose, {min_coverage, 40}]},
+        {cover_enabled, true},
+        {cover_export_enabled, true}
+    ]}
 ]}.
+
 {depup, [{only, minor}]}.
 
 {shell, [{apps, [erldns]}, {config, "erldns.config"}]}.
@@ -50,16 +53,26 @@
     {extended_start_script, true}
 ]}.
 
-{overrides, [
-    {override, dns_erlang, [
-        {plugins, [{provider_asn1, "0.2.3"}]},
-        {provider_hooks, [
-            {pre, [{compile, {asn, compile}}]},
-            {post, [{clean, {asn, clean}}]}
-        ]}
-    ]}
-]}.
 {dialyzer, [{warnings, [no_unknown]}]}.
 {erlfmt, [write, {print_width, 140}]}.
 
+{xref_checks, [
+    locals_not_used,
+    undefined_functions,
+    undefined_function_calls,
+    {deprecated_function_calls, next_major_release},
+    {deprecated_functions, next_major_release}
+]}.
+
+{hex, [{doc, #{provider => ex_doc}}]}.
+
+{ex_doc, [
+    {source_url, <<"https://github.com/dnsimple/erldns">>},
+    {main, <<"readme">>},
+    {extras, [
+        {'README.md', #{title => <<"Overview">>}},
+        {'LICENSE.md', #{title => <<"License">>}}
+    ]}
+]}.
+
 %% This is a rebar3-ism

src/erldns_storage.erl

@@ -13,6 +13,10 @@
 %% ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 %% OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 
+%% Public API
+%% @doc API for a module's function calls. Please note that all crashes should be handled at the
+%% lowest level of the API (ex. erldns_storage_json).
+%% @end
 -module(erldns_storage).
 
 -behaviour(gen_server).
@@ -81,11 +85,6 @@ terminate(_Reason, _State) ->
 code_change(_OldVsn, State, _Extra) ->
     {ok, State}.
 
-%% Public API
-%% @doc API for a module's function calls. Please note that all crashes should be handled at the
-%% lowest level of the API (ex. erldns_storage_json).
-%% @end
-
 %% @doc Call to a module's create. Creates a new table.
 -spec create(atom()) -> ok | {error, Reason :: term()}.
 create(Table) ->
@@ -116,14 +115,14 @@ select_delete(Table, MatchSpec) ->
     Module:select_delete(Table, MatchSpec).
 
 %% @doc Backup the table to the JSON file.
-%% @see https://github.com/SiftLogic/erl-dns/issues/3
+%% https://github.com/SiftLogic/erl-dns/issues/3
 -spec backup_table(atom()) -> ok | {error, Reason :: term()}.
 backup_table(Table) ->
     Module = mod(Table),
     Module:backup_table(Table).
 
 %% @doc Backup the tables to the JSON file.
-%% @see https://github.com/SiftLogic/erl-dns/issues/3
+%% https://github.com/SiftLogic/erl-dns/issues/3
 -spec backup_tables() -> ok | {error, Reason :: term()}.
 backup_tables() ->
     Module = mod(),

src/erldns_storage_json.erl

@@ -79,13 +79,13 @@ select_delete(Table, MatchSpec) ->
     {ok, Count}.
 
 %% @doc Backup a specific ets table.
-%% @see https://github.com/SiftLogic/erl-dns/issues/3
+%% https://github.com/SiftLogic/erl-dns/issues/3
 -spec backup_table(atom()) -> ok | {error, Reason :: term()}.
 backup_table(_Table) ->
     {error, not_implemented}.
 
 %% @doc Should backup all ets tables.
-%% @see https://github.com/SiftLogic/erl-dns/issues/3
+%% https://github.com/SiftLogic/erl-dns/issues/3
 -spec backup_tables() -> ok | {error, Reason :: term()}.
 backup_tables() ->
     {error, not_implemented}.

src/erldns_storage_mnesia.erl

@@ -237,15 +237,14 @@ select_delete(Table, [{{{ZoneName, Fqdn, Type}, _}, _, _}]) ->
         end,
     mnesia:activity(transaction, SelectDelete).
 
-%%
 %% @doc Should backup the tables in the schema.
-%% @see https://github.com/SiftLogic/erl-dns/issues/3
+%% https://github.com/SiftLogic/erl-dns/issues/3
 -spec backup_table(atom()) -> ok | {error, Reason :: term()}.
 backup_table(_Table) ->
     Backup = fun() -> mnesia:backup(mnesia:schema()) end,
     mnesia:activity(transaction, Backup).
 
-%% @see https://github.com/SiftLogic/erl-dns/issues/3
+%% https://github.com/SiftLogic/erl-dns/issues/3
 -spec backup_tables() -> ok | {error, Reason :: term()}.
 backup_tables() ->
     {error, not_implemented}.

src/gen_nb_server.erl

@@ -61,7 +61,7 @@
 
 -export_type([state/0]).
 
-%% @spec start_link(CallbackModule, IpAddr, Port, InitParams) -> Result
+%% start_link(CallbackModule, IpAddr, Port, InitParams) -> Result
 %% CallbackModule = atom()
 %% IpAddr = string()
 %% Port = integer()
@@ -159,7 +159,7 @@ code_change(_OldVsn, State, _Extra) ->
 %% Internal functions
 
 %% @hidden
-%% @spec listen_on(CallbackModule, IpAddr, Port) -> Result
+%% listen_on(CallbackModule, IpAddr, Port) -> Result
 %% CallbackModule = atom()
 %% IpAddr = string()
 %% Port = integer()