Current section

Files

Jump to
igniter mix.exs
Raw

mix.exs

# SPDX-FileCopyrightText: 2024 igniter contributors <https://github.com/ash-project/igniter/graphs/contributors>
#
# SPDX-License-Identifier: MIT

defmodule Igniter.MixProject do
  use Mix.Project

  @version "0.8.5"
  @install_version "~> 0.6"

  @description """
  A code generation and project patching framework
  """

  def project do
    [
      app: :igniter,
      version: @version,
      elixir: "~> 1.15",
      start_permanent: Mix.env() == :prod,
      elixirc_paths: elixirc_paths(Mix.env()),
      description: @description,
      aliases: aliases(),
      package: package(),
      docs: docs(),
      deps: deps(),
      dialyzer: [
        plt_add_apps: [:mix, :hex, :ex_unit]
      ]
    ]
  end

  defp elixirc_paths(:test) do
    elixirc_paths(:dev) ++ ["test/support"]
  end

  defp elixirc_paths(_env) do
    ["lib"]
  end

  # Run "mix help compile.app" to learn about applications.
  def application do
    [
      # if you change this, change it in the installer archive too.
      extra_applications: [:logger, :public_key, :ssl, :inets, :eex]
    ]
  end

  defp docs do
    [
      main: "readme",
      source_ref: "v#{@version}",
      source_url: "https://github.com/ash-project/igniter",
      logo: "logos/igniter-logo-small.png",
      extra_section: "GUIDES",
      extras: [
        {"README.md", title: "Home"},
        "documentation/writing-generators.md",
        "documentation/configuring-igniter.md",
        "documentation/documenting-tasks.md",
        "documentation/upgrades.md",
        "CHANGELOG.md"
      ],
      groups_for_modules: [
        "Writing Mix tasks": [~r"Igniter\.Mix\..*"],
        "Project modifications": [~r"Igniter\.Refactors\..*", ~r"Igniter\.Project\..*"],
        "Code modifications": [~r"Igniter\.Code\..*"],
        Extensions: [Igniter.Extension, ~r"Igniter\.Extensions\..*"],
        "Library support": [~r"Igniter\.Libs\..*"],
        Utilities: [~r"Igniter\.Util\..*"]
      ],
      before_closing_head_tag: fn type ->
        if type == :html do
          """
          <script>
            if (location.hostname === "hexdocs.pm") {
              var script = document.createElement("script");
              script.src = "https://plausible.io/js/script.js";
              script.setAttribute("defer", "defer")
              script.setAttribute("data-domain", "ashhexdocs")
              document.head.appendChild(script);
            }
          </script>
          """
        end
      end
    ]
  end

  defp package do
    [
      maintainers: [
        "Zach Daniel <zach@zachdaniel.dev>"
      ],
      licenses: ["MIT"],
      files: ~w(lib .formatter.exs mix.exs README* LICENSE*
      CHANGELOG* usage-rules.md),
      links: %{
        "GitHub" => "https://github.com/ash-project/igniter",
        "Changelog" => "https://github.com/ash-project/igniter/blob/main/CHANGELOG.md",
        "Discord" => "https://discord.gg/HTHRaaVPUc",
        "Website" => "https://ash-hq.org",
        "Forum" => "https://elixirforum.com/c/ash-framework-forum/",
        "REUSE Compliance" => "https://api.reuse.software/info/github.com/ash-project/igniter"
      }
    ]
  end

  # Run "mix help deps" to learn about dependencies.
  defp deps do
    [
      {:rewrite, "~> 1.1 and >= 1.1.1"},
      {:glob_ex, "~> 0.1.7"},
      {:spitfire, "~> 0.1 and >= 0.1.3"},
      {:sourceror, "~> 1.4"},
      {:jason, "~> 1.4.5"},
      {:req, "~> 0.7"},
      {:phx_new, "~> 1.7", optional: true},
      {:ex_ast, "~> 0.16"},
      {:owl, "~> 0.11"},
      # Dev/Test dependencies
      {:eflame, "~> 1.0", only: [:dev, :test]},
      {:ex_doc, "~> 0.32", only: [:dev, :test], runtime: false},
      {:ex_check, "~> 0.12", only: [:dev, :test]},
      {:credo, ">= 0.0.0", only: [:dev, :test], runtime: false},
      {:dialyxir, ">= 0.0.0", only: [:dev, :test], runtime: false},
      {:mimic, "~> 2.0", only: [:test]},
      {:git_ops, github: "zachdaniel/git_ops", branch: "no-igniter", only: :dev},
      {:mix_audit, ">= 0.0.0", only: [:dev, :test], runtime: false},
      {:benchee, "~> 1.1", only: [:dev, :test]},
      {:doctor, "~> 0.23", only: [:dev, :test]}
    ]
  end

  defp aliases do
    [
      credo: "credo --strict",
      "archive.build": &raise_on_archive_build/1
    ]
  end

  @doc false
  def install_version, do: @install_version

  defp raise_on_archive_build(_) do
    Mix.raise("""
    You are trying to install "igniter" as an archive, which is not supported. \
    You probably meant to install "igniter_new" instead.
    """)
  end
end