Skip to main content

mix.exs

defmodule DocxTmpl.MixProject do
  use Mix.Project

  @version "0.2.0"
  @source_url "https://github.com/osbre/docx_tmpl"

  def project do
    [
      app: :docx_tmpl,
      version: @version,
      elixir: "~> 1.17",
      start_permanent: Mix.env() == :prod,
      deps: deps(),
      aliases: aliases(),
      dialyzer: dialyzer(),
      description: description(),
      package: package(),
      docs: docs(),
      source_url: @source_url
    ]
  end

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

  defp deps do
    [
      {:ex_doc, "~> 0.34", only: :dev, runtime: false},
      {:credo, "~> 1.7", only: [:dev, :test], runtime: false},
      {:dialyxir, "~> 1.4", only: [:dev, :test], runtime: false},
      {:mix_audit, "~> 2.1", only: [:dev, :test], runtime: false}
    ]
  end

  defp aliases do
    [
      lint: [
        "format --check-formatted",
        "deps.unlock --check-unused",
        "credo --strict"
      ],
      ci: [
        "lint",
        "hex.audit",
        "deps.audit",
        "compile --warnings-as-errors",
        "test --warnings-as-errors",
        "dialyzer"
      ]
    ]
  end

  defp dialyzer do
    [
      plt_local_path: "priv/plts/local.plt",
      plt_core_path: "priv/plts/core.plt",
      plt_add_apps: [:mix, :ex_unit],
      flags: [:error_handling, :unknown, :unmatched_returns, :extra_return, :missing_return]
    ]
  end

  defp description do
    "Make new .docx files from a Handlebars-like template " <>
      "(variables, conditionals, loops, table-row repetition)."
  end

  defp package do
    [
      maintainers: ["Ostap Brehin"],
      licenses: ["MIT"],
      links: %{"GitHub" => @source_url},
      files: ~w(lib mix.exs README.md LICENSE .formatter.exs)
    ]
  end

  defp docs do
    [main: "DocxTmpl", source_ref: "v#{@version}"]
  end
end