predicator

defmodule Predicator.MixProject do
  use Mix.Project

  @app :predicator
  @version "9.4.4"
  @description "A secure, non-evaling condition (boolean predicate) engine for end users"
  @source_url "https://github.com/riddler/predicator-ex"
  @deps [
    # Development and testing
    {:castore, "~> 1.0", only: [:dev, :test]},
    {:dialyxir, "~> 1.4", only: [:dev, :test], runtime: false},
    {:ex_doc, "~> 0.40", only: :dev, runtime: false},
    {:credo, "~> 1.7", only: [:dev, :test], runtime: false},
    {:excoveralls, "~> 0.18", only: :test},
    {:ex_quality, "~> 0.15", only: :dev, runtime: false},
    {:benchee, "~> 1.3", only: :dev, runtime: false}
  ]

  def project do
    [
      app: @app,
      version: @version,
      elixir: "~> 1.18",
      start_permanent: Mix.env() == :prod,
      deps: @deps,
      docs: docs(),
      description: @description,
      package: package(),
      aliases: aliases(),
      test_coverage: [tool: ExCoveralls],
      preferred_cli_env: [
        coveralls: :test,
        "coveralls.detail": :test,
        "coveralls.post": :test,
        "coveralls.html": :test,
        "coveralls.json": :test,
        "test.coverage": :test,
        "test.coverage.html": :test,
        "test.coverage.detail": :test
      ],
      dialyzer: [
        plt_file: {:no_warn, "priv/plts/dialyzer.plt"},
        plt_add_apps: [:mix, :ex_unit],
        warnings: [:unknown]
      ]
    ]
  end

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

  defp package do
    [
      name: @app,
      # Every file README.md links to relatively ships in this tarball. hex.pm
      # renders the package page from the README inside the tarball, so a
      # relative link there resolves to that path in the tarball and answers
      # 404 unless the file ships; the same link also works on GitHub and, since
      # each target is an extra in docs(), on hexdocs. A README link to a new
      # file adds it both here and to docs()'s extras. The rest of docs/ stays
      # out: hexdocs builds from docs()'s extras on the publisher's disk.
      # docs/contributing.md and LICENSE ship but are not extras: the README
      # links both by absolute GitHub URL.
      #
      # The whole conformance apparatus is excluded because nothing an
      # application does at runtime touches it, and the audience
      # that does - sibling implementers - works from a git checkout. That is
      # three things, excluded three ways (px-35i.4):
      #
      #   conformance/                   the corpus, manifest, and schemas;
      #                                  simply absent from files:
      #   lib/mix/tasks/corpus.*.ex      the dev tasks that regenerate it;
      #                                  lib/predicator* never matched them
      #   lib/predicator/conformance/    the generator modules the tasks call;
      #                                  matched by the glob, so removed by
      #                                  exclude_patterns below
      #
      # Nothing under lib/ outside those two directories references
      # Predicator.Conformance, so dropping it cannot break a consumer's
      # compile. A test guards that invariant.
      files: ~w(
        lib/predicator* mix.exs README.md LICENSE CHANGELOG.md
        docs/reference/language.md
        docs/isa.md
        docs/guides/nested-data-access.md
        docs/guides/custom-functions.md
        docs/guides/location-expressions.md
        docs/guides/embedding.md
        docs/guides/simple-subset.md
        docs/guides/porting.md
        docs/architecture.md
        docs/explanation/why-a-predicate-language-of-its-own.md
        docs/contributing.md
      ),
      exclude_patterns: [~r{\Alib/predicator/conformance/}],
      licenses: ["MIT"],
      links: %{"GitHub" => @source_url},
      maintainers: ["Predicator Team"]
    ]
  end

  defp docs do
    [
      name: "Predicator",
      source_ref: "v#{@version}",
      canonical: "https://hexdocs.pm/predicator",
      source_url: @source_url,
      main: "readme",
      # These paths are read off disk at publish time: the docs tarball hexdocs
      # hosts is built by mix docs, separately from the package tarball. An
      # extra that README.md links to relatively is ALSO listed in package()'s
      # files:, because hex.pm renders the README from the package tarball and
      # a relative link there answers 404 unless the target ships in it.
      #
      # The groups are the family's kinds of page, in its order: How-to guides,
      # Reference, Explanation. README.md (main) and CHANGELOG.md stay
      # ungrouped at the top; every other extra sits in exactly one group. A
      # page in docs/guides/ that describes a surface rather than a task is
      # grouped as Reference; its file stays where it is. Decision records and
      # planning notes are not extras: the README links the records on GitHub.
      extras: [
        "README.md",
        "CHANGELOG.md",
        "docs/guides/custom-functions.md",
        "docs/guides/embedding.md",
        "docs/guides/porting.md",
        "docs/reference/language.md",
        "docs/reference/ast.md",
        "docs/isa.md",
        "docs/guides/nested-data-access.md",
        "docs/guides/location-expressions.md",
        "docs/guides/simple-subset.md",
        "docs/architecture.md",
        "docs/explanation/why-a-predicate-language-of-its-own.md"
      ],
      groups_for_extras: [
        "How-to guides": [
          "docs/guides/custom-functions.md",
          "docs/guides/embedding.md",
          "docs/guides/porting.md"
        ],
        Reference: [
          "docs/reference/language.md",
          "docs/reference/ast.md",
          "docs/isa.md",
          "docs/guides/nested-data-access.md",
          "docs/guides/location-expressions.md",
          "docs/guides/simple-subset.md"
        ],
        Explanation: [
          "docs/architecture.md",
          "docs/explanation/why-a-predicate-language-of-its-own.md"
        ]
      ],
      skip_undefined_reference_warnings_on: ["CHANGELOG.md"]
    ]
  end

  defp aliases do
    [
      "test.coverage": ["coveralls"],
      "test.coverage.html": ["coveralls.html"],
      "test.coverage.detail": ["coveralls.detail"]
    ]
  end
end