tidefall/mix.exs at main · cabol/tidefall · 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
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
defmodule Tidefall.MixProject do
  use Mix.Project

  @version "1.0.0"
  @source_url "https://github.com/cabol/tidefall"

  def project do
    [
      app: :tidefall,
      version: @version,
      elixir: "~> 1.14",
      elixirc_paths: elixirc_paths(Mix.env()),
      aliases: aliases(),
      deps: deps(),

      # Testing
      test_coverage: [tool: ExCoveralls, export: "test-coverage"],

      # Usage rules
      usage_rules: usage_rules(),

      # Dialyzer
      dialyzer: dialyzer(),

      # Hex
      package: package(),
      description: "ETS-based buffer for high-throughput writes and batch processing",

      # Docs
      name: "Tidefall",
      docs: docs()
    ]
  end

  def application do
    [
      mod: {Tidefall.Application, []},
      extra_applications: [:logger]
    ]
  end

  def cli do
    [
      preferred_envs: [
        coveralls: :test,
        "coveralls.detail": :test,
        "coveralls.post": :test,
        "coveralls.html": :test,
        "coveralls.json": :test,
        "test.ci": :test
      ]
    ]
  end

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

  defp deps do
    [
      {:nimble_options, "~> 1.0"},
      {:telemetry, "~> 1.0"},

      # Test & Code Analysis
      {:excoveralls, "~> 0.18", only: :test},
      {:credo, "~> 1.7", only: [:dev, :test], runtime: false},
      {:dialyxir, "~> 1.4", only: [:dev, :test], runtime: false},

      # Benchmarks
      {:benchee, "~> 1.5", only: [:dev, :test]},

      # Agent usage rules
      {:usage_rules, "~> 1.2", only: :dev, runtime: false},

      # Docs
      {:ex_doc, ">= 0.0.0", only: :dev, runtime: false}
    ]
  end

  defp aliases do
    [
      "test.ci": [
        "deps.unlock --check-unused",
        "compile --warnings-as-errors",
        "format --check-formatted",
        "credo --strict",
        "coveralls.html",
        "dialyzer --format short"
      ],
      "ur.sync": ["usage_rules.sync"]
    ]
  end

  defp package do
    [
      name: :tidefall,
      links: %{"GitHub" => @source_url},
      files: ~w(lib usage-rules .formatter.exs mix.exs README* CHANGELOG*),
      licenses: ~w(MIT)
    ]
  end

  defp docs do
    [
      main: "Tidefall",
      source_ref: "v#{@version}",
      source_url: @source_url,
      canonical: "https://hexdocs.pm/tidefall",
      groups_for_modules: [
        # Tidefall
        # Tidefall.Buffer
        # Tidefall.Buffer.Partition

        "Buffer implementations": [
          Tidefall.HashMap,
          Tidefall.Queue
        ]
      ]
    ]
  end

  defp dialyzer do
    [
      plt_file: {:no_warn, "priv/plts/" <> plt_file_name()},
      flags: [
        :error_handling,
        :extra_return,
        :no_opaque,
        :no_return
      ]
    ]
  end

  defp plt_file_name do
    "dialyzer-#{Mix.env()}-Elixir-#{System.version()}-OTP-#{System.otp_release()}.plt"
  end

  defp usage_rules do
    [
      # The file to write usage rules into (required for usage_rules syncing)
      file: "AGENTS.md",

      # Imported base guidance referenced from AGENTS.md via @deps/... links,
      # so contributors read the canonical rules without inlined drift.
      # Local rules in `usage-rules/` are not duplicated here.
      usage_rules: [
        {:usage_rules, [sub_rules: ["elixir", "otp"], link: :at]}
      ]
    ]
  end
end