Packages

analyze

0.1.14
0.2.0-slim0 0.1.14 0.1.13 0.1.12 0.1.11 0.1.10 0.1.9 0.1.8 0.1.7 0.1.6 0.1.5 0.1.4 0.1.3 0.1.2-rc.3 0.1.2-rc.2 0.1.2-rc.1 0.1.1 0.1.0 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

Mix task to analyze and report Elixir code.

HexDocs

Current section

Files

Jump to
Readme
28 Versions
8 Dependencies
Dependants
Files
Activity
analyze lib analyze checks documentation.ex
Raw

lib/analyze/checks/documentation.ex 

defmodule Analyze.Checks.Documentation do

  @types [:doc]



  def title, do: "Documentation Check"

  def description, do: "Checking documentation quality..."



  def run(_options) do

    app =

      ~r/app: *:(?<app>[a-z\_]+)/

      |> Regex.named_captures(File.read!("./mix.exs"))

      |> Map.get("app")

      |> String.to_existing_atom()



    Application.load(app)



    report = Tidy.analyze_app(app)

    error_count = Tidy.errors?(report, type: @types)



    if error_count <= 0 do

      {:ok, "Documentation looking good.", "", []}

    else

      {:error, "#{error_count} documentation errors.",

       report

       |> Tidy.errors(type: @types)

       |> String.replace(~r/\x1b\[[0-9;]*m/, ""), []}

    end

  end

end