Current section

Files

Jump to
ash_sqlite mix.exs
Raw

mix.exs

# SPDX-FileCopyrightText: 2023 ash_sqlite contributors <https://github.com/ash-project/ash_sqlite/graphs/contributors>
#
# SPDX-License-Identifier: MIT

defmodule AshSqlite.MixProject do
  use Mix.Project

  @description """
  The SQLite data layer for Ash Framework.
  """

  @version "0.3.0"

  def project do
    [
      app: :ash_sqlite,
      version: @version,
      elixir: "~> 1.11",
      start_permanent: Mix.env() == :prod,
      deps: deps(),
      description: @description,
      elixirc_paths: elixirc_paths(Mix.env()),
      cli: cli(),
      dialyzer: [
        plt_add_apps: [:ecto, :ash, :mix]
      ],
      docs: &docs/0,
      aliases: aliases(),
      package: package(),
      source_url: "https://github.com/ash-project/ash_sqlite",
      homepage_url: "https://github.com/ash-project/ash_sqlite",
      consolidate_protocols: Mix.env() != :test
    ]
  end

  defp cli do
    [
      preferred_envs: [
        coveralls: :test,
        "coveralls.github": :test,
        "test.create": :test,
        "test.migrate": :test,
        "test.rollback": :test,
        "test.check_migrations": :test,
        "test.drop": :test,
        "test.generate_migrations": :test,
        "test.reset": :test
      ]
    ]
  end

  if Mix.env() == :test do
    def application() do
      [
        mod: {AshSqlite.TestApp, []}
      ]
    end
  end

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

  defp package do
    [
      maintainers: [
        "Zach Daniel <zach@zachdaniel.dev>"
      ],
      licenses: ["MIT"],
      files: ~w(lib .formatter.exs mix.exs README* LICENSE* CHANGELOG* documentation),
      links: %{
        "GitHub" => "https://github.com/ash-project/ash_sqlite",
        "Changelog" => "https://github.com/ash-project/ash_sqlite/blob/main/CHANGELOG.md",
        "Discord" => "https://discord.gg/HTHRaaVPUc",
        "Website" => "https://ash-hq.org",
        "Forum" => "https://elixirforum.com/c/elixir-framework-forums/ash-framework-forum",
        "REUSE Compliance" => "https://api.reuse.software/info/github.com/ash-project/ash_sqlite"
      }
    ]
  end

  defp docs do
    [
      main: "readme",
      source_ref: "v#{@version}",
      logo: "logos/small-logo.png",
      extras: [
        {"README.md", title: "Home"},
        "documentation/tutorials/getting-started-with-ash-sqlite.md",
        "documentation/topics/about-ash-sqlite/what-is-ash-sqlite.md",
        "documentation/topics/about-ash-sqlite/transactions.md",
        "documentation/topics/resources/aggregates.md",
        "documentation/topics/resources/references.md",
        "documentation/topics/resources/polymorphic-resources.md",
        "documentation/topics/development/migrations-and-tasks.md",
        "documentation/topics/development/testing.md",
        "documentation/topics/advanced/expressions.md",
        "documentation/topics/advanced/manual-relationships.md",
        {"documentation/dsls/DSL-AshSqlite.DataLayer.md",
         search_data: Spark.Docs.search_data_for(AshSqlite.DataLayer)},
        "CHANGELOG.md"
      ],
      skip_undefined_reference_warnings_on: [
        "CHANGELOG.md"
      ],
      groups_for_extras: [
        Tutorials: [
          ~r'documentation/tutorials'
        ],
        "How To": ~r'documentation/how_to',
        Topics: ~r'documentation/topics',
        DSLs: ~r'documentation/dsls',
        "About AshSqlite": [
          "CHANGELOG.md"
        ]
      ],
      groups_for_modules: [
        AshSqlite: [
          AshSqlite,
          AshSqlite.Repo,
          AshSqlite.DataLayer
        ],
        Utilities: [
          AshSqlite.ManualRelationship
        ],
        Introspection: [
          AshSqlite.DataLayer.Info,
          AshSqlite.CustomExtension,
          AshSqlite.CustomIndex,
          AshSqlite.Reference,
          AshSqlite.Statement
        ],
        Types: [
          AshSqlite.Type
        ],
        "Custom Aggregates": [
          AshSqlite.CustomAggregate
        ],
        Expressions: [
          AshSqlite.Functions.Fragment,
          AshSqlite.Functions.Like
        ],
        Internals: ~r/.*/
      ]
    ]
  end

  # Run "mix help deps" to learn about dependencies.
  defp deps do
    [
      {:ecto_sql, "~> 3.13"},
      {:ecto_sqlite3, "~> 0.12"},
      {:ecto_libsql, "~> 0.9", optional: true},
      {:ecto, "~> 3.13"},
      {:jason, "~> 1.0"},
      {:ash, ash_version("~> 3.37 and >= 3.37.1")},
      {:ash_sql, ash_sql_version("~> 0.8 and >= 0.8.4")},
      {:igniter, "~> 0.6 and >= 0.6.14", optional: true},
      {:simple_sat, ">= 0.0.0", only: [:dev, :test]},
      {:git_ops, "~> 2.5", only: [:dev, :test]},
      {:ex_doc, "~> 0.37-rc", only: [:dev, :test], runtime: false},
      {:ex_check, "~> 0.14", only: [:dev, :test]},
      {:credo, ">= 0.0.0", only: [:dev, :test], runtime: false},
      {:dialyxir, ">= 0.0.0", only: [:dev, :test], runtime: false},
      {:sobelow, ">= 0.0.0", only: [:dev, :test], runtime: false},
      {:mix_audit, ">= 0.0.0", only: [:dev, :test], runtime: false}
    ]
  end

  defp ash_version(default_version) do
    case System.get_env("ASH_VERSION") do
      nil ->
        default_version

      "local" ->
        [path: "../ash", override: true]

      "main" ->
        [git: "https://github.com/ash-project/ash.git", override: true]

      version when is_binary(version) ->
        "~> #{version}"

      version ->
        version
    end
  end

  defp ash_sql_version(default_version) do
    case System.get_env("ASH_SQL_VERSION") do
      nil ->
        default_version

      "local" ->
        [path: "../ash_sql", override: true]

      "main" ->
        [git: "https://github.com/ash-project/ash_sql.git"]

      version when is_binary(version) ->
        "~> #{version}"

      version ->
        version
    end
  end

  defp aliases do
    [
      sobelow:
        "sobelow --skip -i Config.Secrets --ignore-files lib/migration_generator/migration_generator.ex",
      credo: "credo --strict",
      docs: [
        "spark.cheat_sheets",
        "docs",
        "spark.replace_doc_links"
      ],
      "spark.formatter": "spark.formatter --extensions AshSqlite.DataLayer",
      "spark.cheat_sheets": "spark.cheat_sheets --extensions AshSqlite.DataLayer",
      "test.generate_migrations": "ash_sqlite.generate_migrations",
      "test.check_migrations": "ash_sqlite.generate_migrations --check",
      "test.migrate": "ash_sqlite.migrate",
      "test.rollback": "ash_sqlite.rollback",
      "test.create": "ash_sqlite.create",
      "test.reset": ["test.drop", "test.create", "test.migrate"],
      "test.drop": "ash_sqlite.drop"
    ]
  end
end