bedrock/mix.exs at develop · bedrock-kv/bedrock · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
defmodule Bedrock.MixProject do
  use Mix.Project

  def project do
    [
      app: :bedrock,
      version: "0.6.1",
      elixir: "~> 1.17",
      start_permanent: Mix.env() == :prod,
      deps: deps(),
      description: description(),
      package: package(),
      docs: &docs/0,
      test_coverage: [tool: ExCoveralls],
      elixirc_paths: elixirc_paths(Mix.env()),
      dialyzer: dialyzer(),
      aliases: aliases(),
      source_url: "https://github.com/bedrock-kv/bedrock"
    ]
  end

  def cli do
    [
      preferred_envs: [
        coveralls: :test,
        "coveralls.json": :test,
        dialyzer: :dev
      ]
    ]
  end

  defp description do
    "An embedded, distributed key-value store with guarantees beyond ACID, featuring consistent reads, strict serialization, and transactions across the key-space."
  end

  defp package do
    [
      name: "bedrock",
      files: ~w(lib priv/schemas mix.exs README.md CHANGELOG.md LICENSE .formatter.exs),
      licenses: ["MIT"],
      links: %{
        "GitHub" => "https://github.com/bedrock-kv/bedrock",
        "Livebook Example" =>
          "https://livebook.dev/run?url=https%3A%2F%2Fraw.githubusercontent.com%2Fbedrock-kv%2Fbedrock%2Frefs%2Fheads%2Fdevelop%2Flivebooks%2Fclass_scheduling.livemd"
      },
      maintainers: ["Jason Allum"]
    ]
  end

  defp aliases, do: [quality: ["format --check-formatted", "credo --strict", "dialyzer"]]

  defp dialyzer do
    [
      plt_core_path: "plts",
      plt_file: {:no_warn, "plts/dialyzer.plt"},
      plt_add_apps: [:ex_unit, :mix],
      # Disable opaque type checks due to OTP 28 issues with structs containing
      # MapSet/queue. See: https://github.com/elixir-lang/elixir/issues/14576
      flags: [:no_opaque]
    ]
  end

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

  # Run "mix help deps" to learn about dependencies.
  defp deps do
    add_deps_for_dev_and_test([
      {:bedrock_raft, "~> 0.9"},
      {:flatbuffer, "~> 0.3"},
      {:jason, "~> 1.4"},
      {:telemetry, "~> 1.2"},
      {:ex_aws, "~> 2.7"},
      {:ex_aws_s3, "~> 2.5"},
      {:req, "~> 0.7"},
      {:sweet_xml, "~> 0.7"}
    ])
  end

  def add_deps_for_dev_and_test(deps) do
    deps ++
      [
        {:stream_data, "~> 1.1", only: :test},
        {:credo, "~> 1.7", only: [:dev, :test], runtime: false},
        {:mix_audit, "~> 2.1", only: [:dev, :test], runtime: false},
        {:dialyxir, "~> 1.4.7", only: [:dev, :test], runtime: false},
        {:faker, "~> 0.17", only: :test},
        {:mix_test_watch, "~> 1.0", only: [:dev, :test], runtime: false},
        {:mox, "~> 1.1", only: :test},
        {:minio_server, "~> 0.4.0", only: [:dev, :test]},
        {:excoveralls, "~> 0.18", only: :test},
        {:benchee, "~> 1.3", only: :dev},
        {:ex_doc, "~> 0.39", only: :dev, runtime: false, warn_if_outdated: true},
        {:styler, "~> 1.0", only: [:dev, :test], runtime: false}
      ]
  end

  defp docs do
    [
      main: "Bedrock",
      extras: [
        "README.md",
        "guides/durability-foundation.md",
        "guides/durability-profile.md",
        "guides/object-storage-s3.md",
        "guides/async-persistence-queue.md",
        "guides/distributed-durability-tests.md"
      ]
    ]
  end

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