Current section

Files

Jump to
docusign mix.exs
Raw

mix.exs

defmodule DocuSign.MixProject do
  @moduledoc false
  use Mix.Project

  @version "4.1.0"
  @url "https://github.com/neilberkman/docusign_elixir"
  @maintainers [
    "Neil Berkman"
  ]

  def project do
    [
      name: "DocuSign",
      app: :docusign,
      version: @version,
      elixir: ">= 1.18.0",
      package: package(),
      source_url: @url,
      maintainers: @maintainers,
      description: "Unofficial DocuSign Elixir Library used to interact with the eSign REST API.",
      homepage_url: @url,
      deps: deps(),
      elixirc_paths: elixirc_paths(Mix.env()),
      docs: docs(),
      dialyzer: [
        plt_add_apps: [:mix]
      ],
      aliases: aliases()
    ]
  end

  def cli do
    [
      preferred_envs: [
        precommit: :test
      ]
    ]
  end

  defp elixirc_paths(:test), do: ["lib", "test/support"]
  defp elixirc_paths(_), do: ["lib"]

  # Run "mix help compile.app" to learn about applications.
  def application do
    [
      extra_applications: [:logger],
      mod: {DocuSign.Application, []}
    ]
  end

  # Run "mix help deps" to learn about dependencies.
  defp deps do
    [
      {:req, "~> 0.7"},
      {:joken, "~> 2.0"},
      {:oauth2, "~> 2.0"},
      {:castore, "~> 1.0"},
      {:finch, "~> 0.21"},
      {:temp, "~> 0.4"},
      {:plug, "~> 1.18"},

      # test
      {:bandit, "~> 1.12", only: :test},
      {:mox, "~> 1.0", only: :test},
      {:briefly, "~> 0.5", only: :test},

      # dev
      {:ex_doc, "~> 0.40", only: :dev},
      {:credo, "~> 1.7", only: [:dev, :test], runtime: false},
      {:dialyxir, "~> 1.4", only: [:dev], runtime: false},
      {:mix_test_watch, "~> 1.4", only: :dev, runtime: false},
      {:quokka, "~> 2.12", only: [:dev, :test], runtime: false}
    ]
  end

  defp aliases do
    [
      precommit: [
        "format --check-formatted",
        "compile --warnings-as-errors",
        "credo --strict",
        "test"
      ]
    ]
  end

  defp docs do
    [
      extras: [
        "README.md",
        "CHANGELOG.md",
        "MIGRATING.md",
        "examples/embedded_signing.livemd",
        "examples/oauth_authorization_code_flow.livemd"
      ],
      main: "readme",
      source_ref: "v#{@version}",
      source_url: @url,
      extra_section: "GUIDES",
      groups_for_extras: [
        Guides: ~r/examples\/.*/,
        "Migration Guides": ~r/MIGRATING\.md/,
        Changelog: ~r/CHANGELOG\.md/
      ],
      groups_for_modules: [
        API: ~r/DocuSign\.Api\..*/,
        Models: ~r/DocuSign\.Model\..*/,
        Core: ~r/DocuSign\.(Connection|ClientRegistry|OAuth|User|Util).*/,
        WebHook: ~r/DocuSign\.Webhook.*/
      ]
    ]
  end

  defp package do
    [
      maintainers: @maintainers,
      licenses: ["MIT"],
      links: %{
        "Changelog" => "https://hexdocs.pm/docusign/changelog.html",
        "GitHub" => @url
      },
      files:
        ~w(lib) ++
          ~w(LICENSE mix.exs README.md CHANGELOG.md MIGRATING.md examples/embedded_signing.livemd examples/oauth_authorization_code_flow.livemd)
    ]
  end
end