mirror of
https://github.com/ash-project/ash.git
synced 2024-09-20 05:23:03 +12:00
436 lines
15 KiB
Elixir
436 lines
15 KiB
Elixir
defmodule Ash.MixProject do
|
|
@moduledoc false
|
|
use Mix.Project
|
|
|
|
@description """
|
|
A resource declaration and interaction library. Built with pluggable data layers, and
|
|
designed to be used by multiple front ends.
|
|
"""
|
|
|
|
@version "3.0.0-rc.15"
|
|
|
|
def project do
|
|
[
|
|
app: :ash,
|
|
version: @version,
|
|
elixir: "~> 1.11",
|
|
consolidate_protocols: Mix.env() == :prod,
|
|
start_permanent: Mix.env() == :prod,
|
|
elixirc_paths: elixirc_paths(Mix.env()),
|
|
package: package(),
|
|
deps: deps(),
|
|
dialyzer: [plt_add_apps: [:mix, :mnesia, :plug, :ex_unit]],
|
|
docs: docs(),
|
|
aliases: aliases(),
|
|
description: @description,
|
|
source_url: "https://github.com/ash-project/ash",
|
|
homepage_url: "https://github.com/ash-project/ash"
|
|
]
|
|
end
|
|
|
|
def application do
|
|
[
|
|
extra_applications: [:mnesia]
|
|
]
|
|
end
|
|
|
|
defp docs do
|
|
[
|
|
main: "home",
|
|
source_ref: "v#{@version}",
|
|
logo: "logos/small-logo.png",
|
|
extra_section: "GUIDES",
|
|
extras: [
|
|
{"documentation/home.md", title: "Home"},
|
|
"documentation/tutorials/get-started.md",
|
|
"documentation/topics/about_ash/what-is-ash.md",
|
|
"documentation/topics/about_ash/design-principles.md",
|
|
"documentation/topics/about_ash/contributing-to-ash.md",
|
|
"documentation/topics/resources/attributes.md",
|
|
"documentation/topics/resources/embedded-resources.md",
|
|
"documentation/topics/resources/code-interfaces.md",
|
|
"documentation/topics/resources/identities.md",
|
|
"documentation/topics/actions/actions.md",
|
|
"documentation/topics/actions/read-actions.md",
|
|
"documentation/topics/actions/create-actions.md",
|
|
"documentation/topics/actions/update-actions.md",
|
|
"documentation/topics/actions/destroy-actions.md",
|
|
"documentation/topics/actions/generic-actions.md",
|
|
"documentation/topics/actions/manual-actions.md",
|
|
"documentation/topics/development/development-utilities.md",
|
|
"documentation/topics/development/upgrading-to-3.0.md",
|
|
"documentation/topics/security/actors-and-authorization.md",
|
|
"documentation/topics/security/sensitive-data.md",
|
|
"CHANGELOG.md",
|
|
# below this line under review
|
|
"documentation/how_to/defining-manual-relationships.md",
|
|
"documentation/how_to/handle-errors.md",
|
|
"documentation/how_to/structure-your-project.md",
|
|
"documentation/how_to/use-without-data-layers.md",
|
|
"documentation/how_to/validate-changes.md",
|
|
"documentation/topics/resources/aggregates.md",
|
|
"documentation/topics/resources/calculations.md",
|
|
"documentation/topics/extending-resources.md",
|
|
"documentation/topics/expressions.md",
|
|
"documentation/topics/reference/glossary.md",
|
|
"documentation/topics/managing-relationships.md",
|
|
"documentation/topics/monitoring.md",
|
|
"documentation/topics/multitenancy.md",
|
|
"documentation/topics/notifiers.md",
|
|
"documentation/topics/security/policies.md",
|
|
"documentation/topics/pub_sub.md",
|
|
"documentation/topics/reactor.md",
|
|
"documentation/topics/relationships.md",
|
|
"documentation/topics/testing.md",
|
|
"documentation/topics/timeouts.md",
|
|
"documentation/topics/validations.md",
|
|
"documentation/dsls/DSL:-Ash.Resource.md",
|
|
"documentation/dsls/DSL:-Ash.Domain.md",
|
|
"documentation/dsls/DSL:-Ash.Notifier.PubSub.md",
|
|
"documentation/dsls/DSL:-Ash.Policy.Authorizer.md",
|
|
"documentation/dsls/DSL:-Ash.DataLayer.Ets.md",
|
|
"documentation/dsls/DSL:-Ash.DataLayer.Mnesia.md",
|
|
"documentation/dsls/DSL:-Ash.Reactor.md",
|
|
"documentation/dsls/DSL:-Ash.DataLayer.Mnesia.md"
|
|
],
|
|
groups_for_extras: [
|
|
"Start Here": [
|
|
"documentation/home.md",
|
|
"documentation/tutorials/get-started.md"
|
|
],
|
|
Tutorials: [],
|
|
Resources: [
|
|
"documentation/topics/resources/attributes.md",
|
|
"documentation/topics/resources/calculations.md",
|
|
"documentation/topics/resources/aggregates.md",
|
|
"documentation/topics/resources/embedded-resources.md",
|
|
"documentation/topics/resources/code-interfaces.md",
|
|
"documentation/topics/resources/identities.md"
|
|
],
|
|
Actions: [
|
|
"documentation/topics/actions/actions.md",
|
|
"documentation/topics/actions/read-actions.md",
|
|
"documentation/topics/actions/create-actions.md",
|
|
"documentation/topics/actions/update-actions.md",
|
|
"documentation/topics/actions/destroy-actions.md",
|
|
"documentation/topics/actions/generic-actions.md",
|
|
"documentation/topics/actions/manual-actions.md",
|
|
],
|
|
Security: [
|
|
"documentation/topics/security/actors-and-authorization.md",
|
|
"documentation/topics/security/policies.md",
|
|
"documentation/topics/security/sensitive-data.md"
|
|
],
|
|
Development: [
|
|
"documentation/topics/development/development-utilities.md",
|
|
"documentation/topics/development/upgrading-to-3.0.md"
|
|
],
|
|
"About Ash": [
|
|
"documentation/topics/about_ash/what-is-ash.md",
|
|
"documentation/topics/about_ash/design-principles.md",
|
|
"documentation/topics/about_ash/contributing-to-ash.md",
|
|
"CHANGELOG.md"
|
|
],
|
|
"How To": [],
|
|
Reference: [
|
|
"documentation/topics/reference/glossary.md",
|
|
"documentation/dsls/DSL:-Ash.Resource.md",
|
|
"documentation/dsls/DSL:-Ash.Domain.md",
|
|
"documentation/dsls/DSL:-Ash.Notifier.PubSub.md",
|
|
"documentation/dsls/DSL:-Ash.Policy.Authorizer.md",
|
|
"documentation/dsls/DSL:-Ash.DataLayer.Ets.md",
|
|
"documentation/dsls/DSL:-Ash.DataLayer.Mnesia.md",
|
|
"documentation/dsls/DSL:-Ash.Reactor.md",
|
|
"documentation/dsls/DSL:-Ash.DataLayer.Mnesia.md"
|
|
],
|
|
"Under Review": [
|
|
# Documentation below this line is pending review
|
|
"documentation/topics/domains.md",
|
|
"documentation/how_to/defining-manual-relationships.md",
|
|
"documentation/how_to/handle-errors.md",
|
|
"documentation/how_to/structure-your-project.md",
|
|
"documentation/how_to/use-without-data-layers.md",
|
|
"documentation/how_to/validate-changes.md",
|
|
"documentation/topics/code-interface.md",
|
|
"documentation/topics/extending-resources.md",
|
|
"documentation/topics/expressions.md",
|
|
"documentation/topics/managing-relationships.md",
|
|
"documentation/topics/monitoring.md",
|
|
"documentation/topics/multitenancy.md",
|
|
"documentation/topics/notifiers.md",
|
|
"documentation/topics/pub_sub.md",
|
|
"documentation/topics/reactor.md",
|
|
"documentation/topics/relationships.md",
|
|
"documentation/topics/testing.md",
|
|
"documentation/topics/timeouts.md",
|
|
"documentation/topics/validations.md"
|
|
]
|
|
],
|
|
skip_undefined_reference_warnings_on: [
|
|
"CHANGELOG.md",
|
|
"documentation/topics/reference/glossary.md",
|
|
"documentation/topics/development/upgrading-to-3.0.md"
|
|
],
|
|
nest_modules_by_prefix: [
|
|
Ash.Error,
|
|
Ash.Policy.Authorizer,
|
|
Ash.Domain.Transformers,
|
|
Ash.Domain.Verifiers,
|
|
Ash.Resource.Transformers,
|
|
Ash.Resource.Verifiers,
|
|
Ash.Query.Function,
|
|
Ash.Query.Operator,
|
|
Ash.Resource.Change,
|
|
Ash.Resource.Validation,
|
|
Ash.Policy.Check
|
|
],
|
|
before_closing_head_tag: fn type ->
|
|
if type == :html do
|
|
"""
|
|
<script>
|
|
if (location.hostname === "hexdocs.pm") {
|
|
var script = document.createElement("script");
|
|
script.src = "https://plausible.io/js/script.js";
|
|
script.setAttribute("defer", "defer")
|
|
script.setAttribute("data-domain", "ashhexdocs")
|
|
document.head.appendChild(script);
|
|
}
|
|
</script>
|
|
"""
|
|
end
|
|
end,
|
|
groups_for_modules: [
|
|
Resources: [
|
|
Ash.Resource.Calculation,
|
|
Ash.Resource.Calculation.Builtins,
|
|
Ash.CodeInterface,
|
|
Ash.DataLayer,
|
|
Ash.Notifier,
|
|
Ash.Notifier.Notification,
|
|
Ash.Resource.ManualRead,
|
|
Ash.Resource.ManualCreate,
|
|
Ash.Resource.ManualUpdate,
|
|
Ash.Resource.ManualDestroy,
|
|
Ash.Resource.ManualRelationship,
|
|
Ash.Resource.Attribute.Helpers
|
|
],
|
|
"Action Input & Interface": [
|
|
Ash,
|
|
Ash.Domain,
|
|
Ash.Query,
|
|
Ash.Changeset,
|
|
Ash.ActionInput,
|
|
Ash.BulkResult
|
|
],
|
|
Queries: [
|
|
Ash.Query,
|
|
Ash.Resource.Preparation,
|
|
Ash.Resource.Preparation.Builtins,
|
|
Ash.Query.Calculation,
|
|
Ash.Query.Aggregate
|
|
],
|
|
Changesets: [
|
|
Ash.Changeset,
|
|
Ash.Resource.Change,
|
|
Ash.Resource.Change.Builtins,
|
|
Ash.Resource.Validation,
|
|
Ash.Resource.Validation.Builtins
|
|
],
|
|
Authorization: [
|
|
Ash.Authorizer,
|
|
Ash.Policy.Check,
|
|
Ash.Policy.Check.Builtins,
|
|
Ash.Policy.FilterCheck,
|
|
Ash.Policy.SimpleCheck
|
|
],
|
|
Extensions: [
|
|
Ash.Resource,
|
|
Ash.DataLayer.Ets,
|
|
Ash.DataLayer.Mnesia,
|
|
Ash.DataLayer.Simple,
|
|
Ash.Notifier.PubSub,
|
|
Ash.Policy.Authorizer,
|
|
Ash.Reactor
|
|
],
|
|
Introspection: [
|
|
Ash.Domain.Info,
|
|
Ash.Resource.Info,
|
|
Ash.Policy.Info,
|
|
Ash.DataLayer.Ets.Info,
|
|
Ash.DataLayer.Mnesia.Info,
|
|
Ash.Notifier.PubSub.Info,
|
|
~r/Ash.Domain.Dsl.*/
|
|
],
|
|
Utilities: [
|
|
Ash.Expr,
|
|
Ash.Page,
|
|
Ash.Page.Keyset,
|
|
Ash.Page.Offset,
|
|
Ash.Filter,
|
|
Ash.Filter.Runtime,
|
|
Ash.Sort,
|
|
Ash.CiString,
|
|
Ash.Vector,
|
|
Ash.Union,
|
|
Ash.UUID,
|
|
Ash.NotLoaded,
|
|
Ash.ForbiddenField,
|
|
Ash.Changeset.ManagedRelationshipHelpers,
|
|
Ash.DataLayer.Simple,
|
|
Ash.Filter.Simple,
|
|
Ash.Filter.Simple.Not,
|
|
Ash.OptionsHelpers,
|
|
Ash.Resource.Builder,
|
|
Ash.ProcessHelpers,
|
|
Ash.Mix.Tasks.Helpers,
|
|
Ash.PlugHelpers,
|
|
Ash.SatSolver
|
|
],
|
|
Visualizations: [
|
|
Ash.Domain.Info.Diagram,
|
|
Ash.Domain.Info.Livebook,
|
|
Ash.Policy.Chart.Mermaid
|
|
],
|
|
Testing: [
|
|
Ash.Generator,
|
|
Ash.Seed,
|
|
Ash.Test
|
|
],
|
|
Tracing: [
|
|
Ash.Tracer,
|
|
Ash.Tracer.Simple,
|
|
Ash.Tracer.Simple.Span
|
|
],
|
|
Types: [
|
|
"Ash.Type",
|
|
~r/Ash.Type\./
|
|
],
|
|
Errors: [
|
|
Ash.Error,
|
|
~r/Ash.Error\./
|
|
],
|
|
"DSL Transformers": [
|
|
~r/\.Transformers\./,
|
|
~r/\.Verifiers\./
|
|
],
|
|
Expressions: [
|
|
Ash.Filter.Predicate,
|
|
Ash.Filter.Simple,
|
|
Ash.Filter.Simple.Not,
|
|
~r/Ash.Query.Operator/,
|
|
~r/Ash.Query.Function/,
|
|
~r/Ash.Query.Ref/,
|
|
Ash.Query.Not,
|
|
Ash.Query.Call,
|
|
Ash.Query.BooleanExpression,
|
|
Ash.Query.Exists,
|
|
Ash.Query.Parent
|
|
],
|
|
Builtins: [
|
|
~r/Ash.Resource.Validation/,
|
|
~r/Ash.Resource.Change/,
|
|
~r/Ash.Policy.Check/
|
|
],
|
|
Introspection: [
|
|
~r/Ash.Resource.Relationships/,
|
|
~r/Ash.Resource.Calculation/,
|
|
~r/Ash.Resource.Interface/,
|
|
~r/Ash.Resource.Identity/,
|
|
~r/Ash.Resource.Attribute/,
|
|
~r/Ash.Resource.Attribute/,
|
|
~r/Ash.Resource.Aggregate/,
|
|
~r/Ash.Resource.Actions/,
|
|
Ash.Mix.Tasks.Helpers,
|
|
Ash.Policy.FieldPolicy,
|
|
Ash.Policy.Policy,
|
|
Ash.Notifier.PubSub.Publication
|
|
],
|
|
Internals: ~r/.*/
|
|
]
|
|
]
|
|
end
|
|
|
|
defp package do
|
|
[
|
|
name: :ash,
|
|
licenses: ["MIT"],
|
|
files: ~w(lib .formatter.exs mix.exs README* LICENSE*
|
|
CHANGELOG* documentation),
|
|
links: %{
|
|
GitHub: "https://github.com/ash-project/ash",
|
|
Discord: "https://discord.gg/HTHRaaVPUc",
|
|
Website: "https://ash-hq.org",
|
|
Forum: "https://elixirforum.com/c/elixir-framework-forums/ash-framework-forum"
|
|
}
|
|
]
|
|
end
|
|
|
|
defp elixirc_paths(:test) do
|
|
["lib", "test/support"]
|
|
end
|
|
|
|
defp elixirc_paths(_), do: ["lib"]
|
|
|
|
# Run "mix help deps" to learn about dependencies.
|
|
defp deps do
|
|
[
|
|
# DSLs
|
|
{:spark, "~> 2.1 and >= 2.1.7"},
|
|
# Ash resources are backed by ecto scheams
|
|
{:ecto, "~> 3.7"},
|
|
# Used by the ETS data layer
|
|
{:ets, "~> 0.8"},
|
|
# Data & types
|
|
{:decimal, "~> 2.0"},
|
|
{:comparable, "~> 1.0"},
|
|
{:jason, ">= 1.0.0"},
|
|
# Observability
|
|
{:telemetry, "~> 1.1"},
|
|
# Used for providing Ash.Reactor, will be used more in the future
|
|
{:reactor, "~> 0.8"},
|
|
# Used for Ash.PlugHelpers
|
|
{:plug, ">= 0.0.0", optional: true},
|
|
# Used for aggregatable and standardized exceptions
|
|
{:splode, "~> 0.2"},
|
|
# Testing Utilities
|
|
{:stream_data, "~> 0.6"},
|
|
|
|
# SAT Solvers
|
|
{:picosat_elixir, "~> 0.2", optional: true},
|
|
{:simple_sat, "~> 0.1 and >= 0.1.1", optional: true},
|
|
|
|
# Dev/Test dependencies
|
|
{:eflame, "~> 1.0", only: [:dev, :test]},
|
|
{:ex_doc, github: "elixir-lang/ex_doc", only: [:dev, :test], runtime: false},
|
|
{:ex_check, "~> 0.12", only: [:dev, :test]},
|
|
{:credo, ">= 0.0.0", only: [:dev, :test], runtime: false},
|
|
{:dialyxir, ">= 0.0.0", only: [:dev, :test], runtime: false},
|
|
{:mimic, "~> 1.7", only: [:test]},
|
|
{:sobelow, ">= 0.0.0", only: [:dev, :test], runtime: false},
|
|
{:git_ops, "~> 2.5", only: [:dev, :test]},
|
|
{:mix_audit, ">= 0.0.0", only: [:dev, :test], runtime: false},
|
|
{:mix_test_watch, "~> 1.0", only: [:dev, :test], runtime: false},
|
|
{:benchee, "~> 1.1", only: [:dev, :test]},
|
|
{:doctor, "~> 0.21", only: [:dev, :test]}
|
|
]
|
|
end
|
|
|
|
defp aliases do
|
|
[
|
|
sobelow: "sobelow --skip",
|
|
credo: "credo --strict",
|
|
docs: [
|
|
"spark.cheat_sheets",
|
|
"docs",
|
|
"spark.replace_doc_links",
|
|
"spark.cheat_sheets_in_search"
|
|
],
|
|
"spark.cheat_sheets_in_search":
|
|
"spark.cheat_sheets_in_search --extensions Ash.Resource.Dsl,Ash.Domain.Dsl,Ash.DataLayer.Ets,Ash.DataLayer.Mnesia,Ash.Notifier.PubSub,Ash.Policy.Authorizer,Ash.Reactor",
|
|
"spark.formatter":
|
|
"spark.formatter --extensions Ash.Resource.Dsl,Ash.Domain.Dsl,Ash.DataLayer.Ets,Ash.DataLayer.Mnesia,Ash.Notifier.PubSub,Ash.Policy.Authorizer,Ash.Reactor",
|
|
"spark.cheat_sheets":
|
|
"spark.cheat_sheets --extensions Ash.Resource.Dsl,Ash.Domain.Dsl,Ash.DataLayer.Ets,Ash.DataLayer.Mnesia,Ash.Notifier.PubSub,Ash.Policy.Authorizer,Ash.Reactor"
|
|
]
|
|
end
|
|
end
|