Skip to main content

mix.exs

defmodule LexCredo.MixProject do
  use Mix.Project

  @source_url "https://github.com/sippy-platform/lex_credo"

  def project do
    [
      app: :lex_credo,
      version: "0.2.1",
      elixir: "~> 1.19",
      start_permanent: Mix.env() == :prod,
      deps: deps(),
      aliases: aliases(),
      package: package(),

      # ExDoc
      name: "LexCredo",
      description:
        "A collection of custom Credo checks for Elixir projects, designed to catch common anti-patterns.",
      source_url: @source_url,
      docs: docs(),

      # ExCoveralls
      test_coverage: [tool: ExCoveralls]
    ]
  end

  def cli do
    [
      preferred_envs: [
        precommit: :test,
        coveralls: :test,
        "coveralls.detail": :test,
        "coveralls.html": :test,
        "coveralls.json": :test
      ]
    ]
  end

  def application do
    [
      extra_applications: [:logger]
    ]
  end

  defp deps do
    [
      {:credo, "~> 1.7"},

      # Documentation
      {:ex_doc, "~> 0.31", only: :dev, runtime: false},

      # Testing
      {:excoveralls, "~> 0.18", only: :test, runtime: false}
    ]
  end

  defp aliases do
    [
      precommit: ["compile", "format", "credo --all", "test"]
    ]
  end

  defp docs do
    [
      main: "readme",
      extras: ["README.md", "CHANGELOG.md", "LICENSE"],
      groups_for_modules: [
        "Checks – Design": ~r/LexCredo\.Check\.Design/,
        "Checks – Readability": ~r/LexCredo\.Check\.Readability/,
        "Checks – Refactor": ~r/LexCredo\.Check\.Refactor/,
        "Checks – Warning": ~r/LexCredo\.Check\.Warning/
      ]
    ]
  end

  defp package() do
    [
      maintainers: ["Timothy Vanderaerden"],
      licenses: ["MIT"],
      links: %{"GitHub" => @source_url}
    ]
  end
end