Packages

doctor

0.1.0
0.23.0 0.22.0 0.21.0 0.20.0 0.19.0 0.18.0 0.17.0 0.16.0 0.15.0 0.14.0 0.13.0 0.12.0 0.11.0 0.10.0 0.9.0 0.8.0 0.7.0 0.6.0 0.5.0 0.4.0 0.3.0 0.2.0 0.1.0

Simple utility to create documentation coverage reports

HexDocs

Current section

Files

Jump to
Readme
23 Versions
1 Dependency
2 Dependants
Files
Activity
doctor lib config.ex
Raw

lib/config.ex 

defmodule Doctor.Config do

  # TODO: Convert this to a struct



  @default_config %{

    moduledoc_required: true,

    min_overall_doc_coverage: 50,

    min_overall_spec_coverage: 0,

    min_module_doc_coverage: 40,

    min_module_spec_coverage: 0,

    ignore_modules: [],

    ignore_paths: [],

    reporter: Doctor.Reporters.Full

  }



  @config_file ".doctor.exs"



  def config_defaults_as_map, do: @default_config



  def config_defaults_as_string do

    config = quote do: unquote(@default_config)



    config

    |> Macro.to_string()

    |> Code.format_string!()

  end



  def config_file, do: @config_file

end