Packages

Fil is a pluggable file storage abstraction for Elixir.

Current section

Files

Jump to
fil mix.exs
Raw

mix.exs

defmodule Fil.MixProject do
  use Mix.Project

  @version "0.2.0"
  @source_url "https://github.com/pehbehbeh/fil"

  def project do
    [
      app: :fil,
      version: @version,
      elixir: "~> 1.18",
      start_permanent: Mix.env() == :prod,
      elixirc_paths: elixirc_paths(Mix.env()),
      compilers: compilers(),
      deps: deps(),
      aliases: aliases(),
      description: "Fil is a pluggable file storage abstraction for Elixir.",
      package: package(),
      docs: docs(),
      name: "Fil",
      source_url: @source_url
    ]
  end

  def cli do
    [preferred_envs: ["test.integration": :test]]
  end

  def application do
    [mod: {Fil.Application, []}, extra_applications: [:logger, :crypto, :xmerl]]
  end

  defp elixirc_paths(:test), do: ["lib", "test/support"]
  defp elixirc_paths(_), do: ["lib"]

  # LiveView's compiler writes the manifest of Fil's colocated JS (`phoenix-colocated/fil/index.js`), which apps import
  # the uploader of `Fil.LiveView` from. It writes only the manifest of the project it runs in, so Fil runs it itself
  # when LiveView is there, and apps without LiveView compile Fil without it. In an app, Mix evaluates this again after
  # LiveView is compiled. In Fil's own checkout, LiveView isn't loaded yet when Mix reads this, so no manifest is
  # written. Nothing in the tests needs it; `mix run -e "Phoenix.LiveView.ColocatedAssets.compile()"` writes it.
  defp compilers do
    if Code.ensure_loaded?(Mix.Tasks.Compile.PhoenixLiveView) do
      [:phoenix_live_view | Mix.compilers()]
    else
      Mix.compilers()
    end
  end

  defp deps do
    [
      # Core
      {:nimble_options, "~> 1.1"},
      {:req, "~> 0.7"},
      {:mime, "~> 2.0"},
      {:telemetry, "~> 1.3"},

      # Optional: Fil.Plug serves signed URLs of Local and Memory disks, and Req.Test stubs are plugs.
      {:plug, "~> 1.14", optional: true},
      # Optional: Fil.Plugin.Thumbnails resizes images with libvips.
      {:vix, "~> 0.33", optional: true},
      # Optional: Fil.Kino browses disks in Livebook and adds a smart cell.
      {:kino, "~> 0.19", optional: true},
      # Optional: Fil.LiveView stores LiveView uploads on a disk. Its uploader for direct uploads is colocated JS, which
      # needs Phoenix 1.8 (LiveView 1.2 allows older ones), so Phoenix is listed for its version.
      {:phoenix_live_view, "~> 1.2", optional: true},
      {:phoenix, "~> 1.8", optional: true},
      # Optional: Fil.Ecto.Ref stores refs in Ecto schemas.
      {:ecto, "~> 3.12", optional: true},

      # Test
      {:lazy_html, ">= 0.1.0", only: :test},
      # Fil.Ecto.Ref's tests round-trip through an in-memory SQLite database.
      {:ecto_sql, "~> 3.12", only: :test},
      {:ecto_sqlite3, "~> 0.25", only: :test},

      # Development
      {:ex_doc, "~> 0.40", only: :dev, runtime: false},
      {:credo, "~> 1.7", only: [:dev, :test], runtime: false},
      {:quokka, "~> 2.13", only: [:dev, :test], runtime: false}
    ]
  end

  defp aliases do
    ["test.integration": ["test --only integration"]]
  end

  defp package do
    [
      licenses: ["Apache-2.0"],
      links: %{"GitHub" => @source_url, "Changelog" => "#{@source_url}/blob/main/CHANGELOG.md"},
      files: ~w(lib guides mix.exs README.md CHANGELOG.md LICENSE)
    ]
  end

  defp docs do
    [
      main: "Fil",
      api_reference: false,
      logo: "assets/icon.svg",
      favicon: "assets/icon.svg",
      source_ref: "v#{@version}",
      extra_section: "Guides",
      extras: [
        "guides/tour.livemd",
        "guides/installation.md",
        "guides/plugins.md",
        "guides/phoenix.md",
        "CHANGELOG.md"
      ],
      groups_for_docs: [
        Building: &(&1[:section] == :building),
        Operations: &(&1[:section] == :operations),
        "Bang variants": &(&1[:section] == :bang),
        "Upload field": &(&1[:section] == :upload_field)
      ],
      groups_for_modules: [
        Adapters: ~r/^Fil\.Adapter(\.\w+)?$/,
        Plugins: ~r/^Fil\.Plugin\./,
        Integrations: [Fil.Plug, Fil.Kino, Fil.LiveView, Fil.Ecto.Ref],
        Errors: ~r/^Fil\.\w+Error$/
      ]
    ]
  end
end