Current section
Files
Jump to
Current section
Files
mix.exs
defmodule Knigge.MixProject do
use Mix.Project
def project do
[
app: :knigge,
config_path: "config/config.exs",
elixir: ">= 1.7.4 and < 2.0.0",
elixirc_paths: elixirc_paths(Mix.env()),
preferred_cli_env: [
coveralls: :test,
"coveralls.detail": :test,
"coveralls.post": :test,
"coveralls.html": :test
],
test_coverage: [tool: ExCoveralls],
start_permanent: Mix.env() == :prod,
aliases: aliases(),
deps: deps(),
# Deps
dialyzer: dialyzer(),
# Docs
name: "Knigge",
source_url: "https://github.com/sascha-wolf/knigge",
homepage_url: "https://github.com/sascha-wolf/knigge",
# Hex
description: description(),
docs: docs(),
package: package(),
version: version()
]
end
defp elixirc_paths(:test), do: ["lib", "test/support"]
defp elixirc_paths(_), do: ["lib"]
# Run "mix help compile.app" to learn about applications.
def application do
[
extra_applications: [:logger]
]
end
# Aliases are shortcuts or tasks specific to the current project.
# See the documentation for `Mix` for more info on aliases.
defp aliases do
[
"check.all": ["format --check-formatted", "credo", "dialyzer"]
]
end
# Run "mix help deps" to learn about dependencies.
defp deps do
[
{:bunt, "~> 0.2"},
# No Runtime
{:credo, ">= 1.0.0", only: :dev, runtime: false},
{:dialyxir, "~> 1.0", only: :dev, runtime: false},
{:ex_doc, "~> 0.23", only: :dev, runtime: false},
# Test
{:excoveralls, "~> 0.13", only: :test},
{:mox, "~> 0.5", only: :test},
# Docs
{:inch_ex, ">= 0.0.0", only: :docs}
]
end
defp dialyzer do
[
ignore_warnings: ".dialyzer_ignore.exs",
plt_file: {:no_warn, ".dialyzer/dialyzer.plt"}
]
end
#######
# Hex #
#######
def description do
"An opinionated way of dealing with behaviours."
end
@extras Path.wildcard("pages/**/*.md")
def docs do
[
main: "Knigge",
source_ref: "v#{version()}",
source_url: "https://github.com/sascha-wolf/knigge",
extras: @extras,
groups_for_modules: [
"Overview & Configuration": [
Knigge,
Knigge.Options
],
"Code Generation": [
Knigge.Behaviour,
Knigge.Code,
Knigge.Implementation
],
Verification: [
Knigge.Verification
]
]
]
end
def package do
[
files: ["lib", "mix.exs", "CHANGELOG*", "LICENSE*", "README*", "version"],
licenses: ["MIT"],
links: %{
"GitHub" => "https://github.com/sascha-wolf/knigge"
},
maintainers: ["Sascha Wolf <swolf.dev@gmail.com>"]
]
end
@version_file "version"
def version do
cond do
File.exists?(@version_file) ->
@version_file
|> File.read!()
|> String.trim()
System.get_env("REQUIRE_VERSION_FILE") == "true" ->
exit("Version file (`#{@version_file}`) doesn't exist but is required!")
true ->
"0.0.0-dev"
end
end
end