From cc3106e42598b6d606db8fc1c96fe8e21d0a9f1b Mon Sep 17 00:00:00 2001
From: Thomas Citharel <tcit@tcit.fr>
Date: Mon, 27 Sep 2021 09:41:49 +0200
Subject: [PATCH] Add Doctor to check docs & specs

Signed-off-by: Thomas Citharel <tcit@tcit.fr>
---
 .doctor.exs | 15 +++++++++++++++
 mix.exs     |  3 ++-
 mix.lock    |  1 +
 3 files changed, 18 insertions(+), 1 deletion(-)
 create mode 100644 .doctor.exs

diff --git a/.doctor.exs b/.doctor.exs
new file mode 100644
index 000000000..593403e07
--- /dev/null
+++ b/.doctor.exs
@@ -0,0 +1,15 @@
+%Doctor.Config{
+  exception_moduledoc_required: true,
+  failed: false,
+  ignore_modules: [],
+  ignore_paths: [],
+  min_module_doc_coverage: 70,
+  min_module_spec_coverage: 50,
+  min_overall_doc_coverage: 90,
+  min_overall_spec_coverage: 30,
+  moduledoc_required: true,
+  raise: false,
+  reporter: Doctor.Reporters.Full,
+  struct_type_spec_required: true,
+  umbrella: false
+}
diff --git a/mix.exs b/mix.exs
index 2b169c631..db86fd195 100644
--- a/mix.exs
+++ b/mix.exs
@@ -179,7 +179,8 @@ defmodule Mobilizon.Mixfile do
       {:elixir_feed_parser, "~> 2.1.0", only: :test},
       {:mox, "~> 1.0", only: :test},
       {:junit_formatter, "~> 3.1", only: [:test]},
-      {:sobelow, "~> 0.8", only: [:dev, :test]}
+      {:sobelow, "~> 0.8", only: [:dev, :test]},
+      {:doctor, "~> 0.18.0", only: :dev}
     ] ++ oauth_deps()
   end
 
diff --git a/mix.lock b/mix.lock
index 97047f20f..a6350ac69 100644
--- a/mix.lock
+++ b/mix.lock
@@ -23,6 +23,7 @@
   "db_connection": {:hex, :db_connection, "2.4.0", "d04b1b73795dae60cead94189f1b8a51cc9e1f911c234cc23074017c43c031e5", [:mix], [{:connection, "~> 1.0", [hex: :connection, repo: "hexpm", optional: false]}, {:telemetry, "~> 0.4 or ~> 1.0", [hex: :telemetry, repo: "hexpm", optional: false]}], "hexpm", "ad416c21ad9f61b3103d254a71b63696ecadb6a917b36f563921e0de00d7d7c8"},
   "decimal": {:hex, :decimal, "2.0.0", "a78296e617b0f5dd4c6caf57c714431347912ffb1d0842e998e9792b5642d697", [:mix], [], "hexpm", "34666e9c55dea81013e77d9d87370fe6cb6291d1ef32f46a1600230b1d44f577"},
   "dialyxir": {:hex, :dialyxir, "1.1.0", "c5aab0d6e71e5522e77beff7ba9e08f8e02bad90dfbeffae60eaf0cb47e29488", [:mix], [{:erlex, ">= 0.2.6", [hex: :erlex, repo: "hexpm", optional: false]}], "hexpm", "07ea8e49c45f15264ebe6d5b93799d4dd56a44036cf42d0ad9c960bc266c0b9a"},
+  "doctor": {:hex, :doctor, "0.18.0", "114934c1740239953208a39db617699b7e2660770e81129d7f95cdf7837ab766", [:mix], [{:decimal, "~> 2.0", [hex: :decimal, repo: "hexpm", optional: false]}], "hexpm", "829c88c365f72c0666e443ea670ffb6f180de7b90c23d536edabdd8c722b88f4"},
   "earmark": {:hex, :earmark, "1.4.15", "2c7f924bf495ec1f65bd144b355d0949a05a254d0ec561740308a54946a67888", [:mix], [{:earmark_parser, ">= 1.4.13", [hex: :earmark_parser, repo: "hexpm", optional: false]}], "hexpm", "3b1209b85bc9f3586f370f7c363f6533788fb4e51db23aa79565875e7f9999ee"},
   "earmark_parser": {:hex, :earmark_parser, "1.4.15", "b29e8e729f4aa4a00436580dcc2c9c5c51890613457c193cc8525c388ccb2f06", [:mix], [], "hexpm", "044523d6438ea19c1b8ec877ec221b008661d3c27e3b848f4c879f500421ca5c"},
   "eblurhash": {:hex, :eblurhash, "1.2.1", "36b187459244f5374bb7f47fd0b3001ee3f74d72b18bb04b00cdb7080cdf70f2", [:rebar3], [], "hexpm", "c0b168e734562f8edf1f0abf145b95f93e7657187e1bfaacc32a5714921e920b"},