Skip to main content

mix.exs

defmodule Ftfy.MixProject do
  use Mix.Project

  @source_url "https://github.com/fuww/ftfy"

  def project do
    [
      app: :ftfy,
      version: "0.1.0",
      elixir: "~> 1.15",
      start_permanent: Mix.env() == :prod,
      name: "ftfy",
      description:
        "An Elixir port of the Python ftfy library: fixes broken Unicode text, " <>
          "most importantly mojibake (text decoded in the wrong encoding).",
      source_url: @source_url,
      package: package(),
      docs: docs(),
      escript: escript(),
      aliases: aliases(),
      deps: deps()
    ]
  end

  defp package do
    [
      licenses: ["Apache-2.0"],
      maintainers: ["FashionUnited"],
      links: %{
        "GitHub" => @source_url,
        "Original (python-ftfy)" => "https://github.com/rspeer/python-ftfy"
      },
      files: ~w(lib mix.exs README.md LICENSE NOTICE .formatter.exs)
    ]
  end

  defp docs do
    [
      main: "readme",
      extras: ["README.md"],
      source_url: @source_url
    ]
  end

  defp escript do
    [main_module: Ftfy.CLI, name: "ftfy"]
  end

  # Run "mix help compile.app" to learn about applications.
  def application do
    [
      extra_applications: [:logger]
    ]
  end

  defp aliases do
    [bench: ["run bench/fix_text_bench.exs"]]
  end

  # Run "mix help deps" to learn about dependencies.
  defp deps do
    [
      {:benchee, "~> 1.3", only: :dev, runtime: false},
      {:ex_doc, "~> 0.34", only: :dev, runtime: false}
    ]
  end
end