statifier_datamodel

defmodule StatifierDatamodel.MixProject do
  use Mix.Project

  @version "0.5.2"
  @source_url "https://github.com/riddler/statifier_datamodel"

  def project do
    [
      app: :statifier_datamodel,
      version: @version,
      elixir: "~> 1.18",
      start_permanent: Mix.env() == :prod,
      deps: deps(),
      name: "StatifierDatamodel",
      description:
        "The datamodel document and what can be decided from it: the typed three-scope declaration, its named record and shape types, the path/type index, the read check, compatibility and coverage - pure functions, no dependency on the block editor, the compiler or the UI",
      source_url: @source_url,
      docs: docs(),
      package: package(),
      test_coverage: [tool: ExCoveralls],
      dialyzer: [plt_add_apps: [:ex_unit]],
      preferred_cli_env: [
        coveralls: :test,
        "coveralls.detail": :test,
        "coveralls.html": :test
      ]
    ]
  end

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

  # Hexdocs configuration. These paths are read off the publisher's disk at
  # `mix docs` time and need no entry in package()'s files: list - the docs
  # tarball hexdocs hosts is built separately from the package tarball
  # `mix deps.get` fetches.
  defp docs do
    [
      name: "StatifierDatamodel",
      source_ref: "v#{@version}",
      canonical: "https://hexdocs.pm/statifier_datamodel",
      source_url: @source_url,
      main: "readme",
      # The README is the front page and the CHANGELOG sits beside it, both
      # ungrouped at the top of the sidebar. Every other page is grouped by
      # the kind of page it is, in this order and under these names only:
      # Tutorials, How-to guides, Reference, Explanation, Upgrading. A group
      # is added with its first page, never empty.
      # The decision records under docs/adr are a record for contributors,
      # not pages for a reader of the package: they are not extras, and the
      # README links them on GitHub by absolute URL.
      extras: [
        "README.md",
        "CHANGELOG.md",
        "docs/explanation/why-one-type-registry.md",
        "docs/upgrading.md"
      ],
      groups_for_extras: [
        Explanation: ~r{^docs/explanation/},
        Upgrading: ["docs/upgrading.md"]
      ],
      # The groups follow the package's own seams so the sidebar reads as the
      # architecture rather than as the alphabet: the document and its index,
      # the declared types and the read check, and what is decided across two
      # declarations or between a declaration and a value. Order matters:
      # ex_doc assigns each module to the first group whose pattern matches.
      # `StatifierDatamodel` itself matches none of them on purpose - the root
      # module is the package's own overview and belongs above the seams, not
      # inside one of them.
      groups_for_modules: [
        "Document and index": [
          ~r/^StatifierDatamodel\.(Document|Index|Schema)($|\.)/
        ],
        "Declared types": [
          ~r/^StatifierDatamodel\.(Types|Declarations)($|\.)/
        ],
        "Compatibility and coverage": [
          ~r/^StatifierDatamodel\.(Compatibility|Coverage)($|\.)/
        ]
      ],
      skip_undefined_reference_warnings_on: ["CHANGELOG.md"]
    ]
  end

  defp package do
    [
      name: "statifier_datamodel",
      licenses: ["MIT"],
      # priv/schemas carries the document's JSON Schema (ADR-0002), so it is
      # in the tarball a host fetches and not only in the repository.
      # The README links the pages under docs/explanation and the upgrading
      # page by a relative path, so they ship in the tarball for those links
      # to resolve on hex.pm.
      files:
        ~w(lib priv/schemas docs/explanation docs/upgrading.md mix.exs .formatter.exs README.md LICENSE CHANGELOG.md),
      links: %{
        "GitHub" => @source_url,
        "Changelog" => "#{@source_url}/blob/main/CHANGELOG.md"
      }
    ]
  end

  # No runtime dependencies, and none in the family. The two statifier_blocks
  # modules this package re-homes - the document index and the pure half of
  # the datamodel reader - normalize a decoded map and call nothing in
  # predicator or statifier; that was checked before this list was written,
  # and it is the property that lets both statifier_blocks and statifier_ui
  # take this package without either taking the other. A runtime dependency
  # added here is a decision to record, not a convenience to reach for.
  defp deps do
    [
      # Dev / test
      {:ex_quality, "~> 0.15", only: :dev, runtime: false},
      {:credo, "~> 1.7", only: [:dev, :test], runtime: false},
      {:dialyxir, "~> 1.4", only: [:dev, :test], runtime: false},
      {:excoveralls, "~> 0.18", only: :test},
      # The validator the schema's own tests run under (ADR-0002 decision
      # 10). Test-only: the package never validates a document, so this is
      # not a runtime dependency and lands in no host's tree.
      {:ex_json_schema, "~> 0.11", only: :test, runtime: false},
      {:ex_doc, "~> 0.40", only: :dev, runtime: false}
    ]
  end
end