ichor

defmodule Ichor.MixProject do
  use Mix.Project

  @version "0.7.2"

  # `mix precommit` includes `test` as a step; without this, Mix runs
  # the whole alias chain (including `mix test`) in :dev, and `mix test`
  # itself refuses to run outside :test when invoked as a sub-task
  # rather than the top-level command.
  def cli do
    [preferred_envs: [precommit: :test]]
  end

  def project do
    [
      app: :ichor,
      version: @version,
      elixir: "~> 1.19",
      start_permanent: Mix.env() == :prod,
      elixirc_paths: elixirc_paths(Mix.env()),
      deps: deps(),
      description: description(),
      package: package(),
      name: "Ichor",
      docs: docs(),
      aliases: aliases(),
      test_coverage: [tool: ExCoveralls],
      dialyzer: [plt_add_apps: [:mix]]
    ]
  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]
    ]
  end

  # Run "mix help deps" to learn about dependencies.
  defp deps do
    [
      # === CODE QUALITY & STATIC ANALYSIS ===
      {:credo, "~> 1.7", only: [:dev, :test], runtime: false},
      {:dialyxir, "~> 1.4", only: [:dev, :test], runtime: false},
      {:sobelow, "~> 0.14", only: [:dev, :test], runtime: false},
      {:excoveralls, "~> 0.18", only: [:dev, :test], runtime: false},
      # Credo is invoked via `MIX_ENV=test mix credo`
      # Dialyzer is invoked via `MIX_ENV=test mix dialyzer`
      # Sobelow is invoked via `MIX_ENV=test mix sobelow`
      # Coveralls is invoked via `MIX_ENV=test mix coveralls

      # === TESTING ===
      {:mox, "~> 1.2", only: [:dev, :test]},
      {:faker, "~> 0.19", only: [:test]},
      {:stream_data, "~> 1.4", only: [:test]},

      # === DEVELOPMENT TOOLING ===
      # Mix, and Hex are built-in (no deps needed)
      {:ex_doc, "~> 0.40", only: [:dev], runtime: false},
      # ExDoc is invoked via `MIX_ENV=dev mix docs`

      # === RUNTIME ===
      {:ichor_runtime, "~> 0.6.2"}
    ]
  end

  # Fast/cheap checks first so a broken commit fails quickly; dialyzer
  # (slowest, especially its first PLT build) runs last.
  defp aliases do
    [
      docs: [&readme_for_docs/1, "docs"],
      precommit: [
        "format",
        "compile --warnings-as-errors",
        "credo --strict",
        "sobelow",
        "test",
        "dialyzer"
      ]
    ]
  end

  # The README for ExDoc: GitHub's `> [!WARNING]` alert, which ExDoc does
  # not render, turned into ExDoc's own warning admonition. GitHub shows
  # the README itself; HexDocs shows this copy under the same name. Run
  # through the `docs` alias, which `mix hex.publish` builds through too.
  # The same in every Elixir Ichor, Cooper and Dextrin.
  defp readme_for_docs(_args) do
    File.mkdir_p!("doc_src")

    readme =
      "README.md"
      |> File.read!()
      |> String.replace("> [!WARNING]", "> #### Warning {: .warning}")

    File.write!("doc_src/README.md", readme)
  end

  defp description do
    "Under heavy development: not for production use before 1.0.0. " <>
      "Compiles grammar definitions -- Aether, its own DSL, plus ABNF/EBNF/PEG/BNF " <>
      "importers -- into separated Lexer/Parser/Analysis/Executor modules, with " <>
      "both an interpreted VM backend and a compile-time native codegen backend."
  end

  defp package do
    [
      licenses: ["Apache-2.0"],
      links: %{
        "GitHub" => "https://github.com/joetjen/ichor",
        "GitHub Pages" => "https://joetjen.github.io/ichor/"
      },
      files: ~w(lib priv/grammar .formatter.exs mix.exs README.md CHANGELOG.md LICENSE)
    ]
  end

  defp docs do
    [
      main: "readme",
      source_url: "https://github.com/joetjen/ichor",
      source_ref: "v#{@version}",
      extras: extras(),
      groups_for_extras: groups_for_extras(),
      groups_for_modules: groups_for_modules()
    ]
  end

  defp extras do
    [
      # The README as `readme_for_docs/1` rewrites it, so its warning is a
      # box: same page name, and View Source still opens the real README.
      {"doc_src/README.md", filename: "readme", source: "README.md"},
      "guides/TUTORIAL.md",
      "guides/EXAMPLES.md",
      "guides/CHEATSHEET.md",
      "guides/mix_tasks/ICHOR_GEN.md",
      "guides/mix_tasks/ICHOR_TOKENS.md",
      "guides/aether/TUTORIAL.md",
      "guides/aether/AETHER.md",
      "guides/aether/AETHER_GRAMMAR.md",
      "guides/aether/AETHER_EXAMPLES.md",
      "guides/aether/AETHER_CHEATSHEET.md",
      "CHANGELOG.md",
      "CONTRIBUTING.md",
      "LICENSE"
    ]
  end

  defp groups_for_extras do
    [
      "Mix Tasks": Path.wildcard("guides/mix_tasks/*.md"),
      Aether: Path.wildcard("guides/aether/*.md")
    ]
  end

  defp groups_for_modules do
    [
      Core: [
        Ichor,
        Ichor.GrammarImport
      ],
      "Grammar IR": [
        Grammar.IR,
        Grammar.IR.AndPred,
        Grammar.IR.Any,
        Grammar.IR.Capture,
        Grammar.IR.CharClass,
        Grammar.IR.Choice,
        Grammar.IR.Indent,
        Grammar.IR.Literal,
        Grammar.IR.Meta,
        Grammar.IR.NotPred,
        Grammar.IR.Opt,
        Grammar.IR.Plus,
        Grammar.IR.Rep,
        Grammar.IR.RuleRef,
        Grammar.IR.Seq,
        Grammar.IR.Star
      ],
      "Aether Front-end": [
        Aether.Grammar,
        Aether.Lexer,
        Aether.Parser,
        Aether.Token
      ],
      Analysis: [
        Grammar.Analysis
      ],
      "VM Backend": [
        Grammar.VM,
        Grammar.VM.CharCompiler,
        Grammar.VM.CharInterpreter,
        Grammar.VM.Compiler,
        Grammar.VM.Lexer,
        Grammar.VM.Linker,
        Grammar.VM.Program,
        Grammar.VM.RuleCompiler,
        Grammar.VM.TokenInterpreter
      ],
      "Native Backend": [
        Grammar.Native,
        Grammar.Native.CharCompiler,
        Grammar.Native.RuleCompiler
      ],
      Tooling: [
        Grammar.Tokens,
        Mix.Tasks.Ichor.Tokens,
        Mix.Tasks.Ichor.Gen
      ],
      "Format Importers": [
        Ichor.ABNF,
        Ichor.ABNF.Actions,
        Ichor.BNF,
        Ichor.BNF.Actions,
        Ichor.EBNF.ISO,
        Ichor.EBNF.ISO.Actions,
        Ichor.EBNF.W3C,
        Ichor.EBNF.W3C.Actions,
        Ichor.PEG,
        Ichor.PEG.Actions
      ]
    ]
  end
end