chore: REUSE compliance (#94)

jimsynz · web-flow · commit 3be0101f4189 · 2025-10-13T16:19:33.000+13:00
diff --git a/.check.exs b/.check.exs
@@ -1,15 +1,10 @@
-[
-  ## all available options with default values (see `mix check` docs for description)
-  # parallel: true,
-  # skipped: true,
+# SPDX-FileCopyrightText: 2020 Zach Daniel
+#
+# SPDX-License-Identifier: MIT
 
-  ## list of tools (see `mix check` docs for defaults)
+[
   tools: [
-    ## curated tools may be disabled (e.g. the check for compilation warnings)
-    # {:compiler, false},
-
-    ## ...or adjusted (e.g. use one-line formatter for more compact credo output)
-    # {:credo, "mix credo --format oneline"},
-    {:doctor, false}
+    {:doctor, false},
+    {:reuse, command: ["pipx", "run", "reuse", "lint", "-q"]}
   ]
 ]
diff --git a/.credo.exs b/.credo.exs
@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2020 Zach Daniel
+#
+# SPDX-License-Identifier: MIT
+
 # This file contains the configuration for Credo and you are probably reading
 # this after creating it with `mix credo.gen.config`.
 #
diff --git a/.doctor.exs b/.doctor.exs
@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2020 Zach Daniel
+#
+# SPDX-License-Identifier: MIT
+
 %Doctor.Config{
   ignore_modules: [ ],
   ignore_paths: [],
diff --git a/.formatter.exs b/.formatter.exs
@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2020 Zach Daniel
+#
+# SPDX-License-Identifier: MIT
+
 # Used by "mix format"
 [
   inputs: ["{mix,.formatter}.exs", "{config,lib,test}/**/*.{ex,exs}"]
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2020 Zach Daniel
+#
+# SPDX-License-Identifier: MIT
+
 ---
 updates:
   - directory: /
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2020 Zach Daniel
+#
+# SPDX-License-Identifier: MIT
+
 name: Ash CI
 on:
   push:
@@ -12,5 +16,6 @@ jobs:
     with:
       spark-formatter: false
       spark-cheat-sheets: false
+      reuse: true
     secrets:
       HEX_API_KEY: ${{ secrets.HEX_API_KEY }}
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2020 Zach Daniel
+#
+# SPDX-License-Identifier: MIT
+
 # The directory Mix will write compiled artifacts to.
 /_build/
 
diff --git a/.tool-versions b/.tool-versions
@@ -1,2 +1,3 @@
 erlang 26.0.2
 elixir 1.18.4
+pipx 1.8.0
diff --git a/.tool-versions.license b/.tool-versions.license
@@ -0,0 +1,3 @@
+SPDX-FileCopyrightText: 2020 Zach Daniel
+
+SPDX-License-Identifier: MIT
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,9 @@
+<!--
+SPDX-FileCopyrightText: 2020 Zach Daniel
+
+SPDX-License-Identifier: MIT
+-->
+
 # Change Log
 
 All notable changes to this project will be documented in this file.
diff --git a/LICENSE b/LICENSE
diff --git a/LICENSES/MIT.txt b/LICENSES/MIT.txt
@@ -0,0 +1,18 @@
+MIT License
+
+Copyright (c) <year> <copyright holders>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
+associated documentation files (the "Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the
+following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial
+portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
+LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO
+EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
+USE OR OTHER DEALINGS IN THE SOFTWARE.
diff --git a/README.md b/README.md
@@ -1,3 +1,13 @@
+<!--
+SPDX-FileCopyrightText: 2020 Zach Daniel
+
+SPDX-License-Identifier: MIT
+-->
+[![Elixir CI](https://github.com/ash-project/splode/actions/workflows/ci.yml/badge.svg)](https://github.com/ash-project/splode/actions/workflows/ci.yml)[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Hex version badge](https://img.shields.io/hexpm/v/splode.svg)](https://hex.pm/packages/splode)
+[![Hexdocs badge](https://img.shields.io/badge/docs-hexdocs-purple)](https://hexdocs.pm/splode)
+[![REUSE status](https://api.reuse.software/badge/github.com/ash-project/splode)](https://api.reuse.software/info/github.com/ash-project/splode)
+
 # Splode
 
 Splode helps you deal with errors and exceptions in your application that are aggregatable and consistent. The general pattern is that you use the `Splode` module as a top level aggregator of error classes, and whenever you return errors, you return one of your `Splode.Error` structs, or a string, or a keyword list. Then, if you want to group errors together, you can use your `Splode` module to do so. You can also use that module to turn any arbitrary value into a splode error.
diff --git a/config/config.exs b/config/config.exs
@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2020 Zach Daniel
+#
+# SPDX-License-Identifier: MIT
+
 import Config
 
 if Mix.env() == :dev do
diff --git a/documentation/tutorials/get-started-with-splode.md b/documentation/tutorials/get-started-with-splode.md
@@ -1,3 +1,9 @@
+<!--
+SPDX-FileCopyrightText: 2020 Zach Daniel
+
+SPDX-License-Identifier: MIT
+-->
+
 # Get Started with Splode
 
 Splode helps you deal with errors and exceptions in your application that are aggregatable and consistent. The general pattern is that you use the `Splode` module as a top level aggregator of error classes, and whenever you return errors, you return one of your `Splode.Error` structs, or a string, or a keyword list. Then, if you want to group errors together, you can use your `Splode` module to do so. You can also use that module to turn any arbitrary value into a splode error.
diff --git a/lib/splode.ex b/lib/splode.ex
@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2020 Zach Daniel
+#
+# SPDX-License-Identifier: MIT
+
 defmodule Splode do
   @moduledoc """
   Use this module to create your error aggregator and handler.
diff --git a/lib/splode/error.ex b/lib/splode/error.ex
@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2020 Zach Daniel
+#
+# SPDX-License-Identifier: MIT
+
 defmodule Splode.Error do
   @moduledoc """
   Use this module to create an aggregatable error.
diff --git a/lib/splode/error_class.ex b/lib/splode/error_class.ex
@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2020 Zach Daniel
+#
+# SPDX-License-Identifier: MIT
+
 defmodule Splode.ErrorClass do
   @moduledoc "Tools for working with error classes"
 
diff --git a/lib/splode/stacktrace.ex b/lib/splode/stacktrace.ex
@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2020 Zach Daniel
+#
+# SPDX-License-Identifier: MIT
+
 defmodule Splode.Stacktrace do
   @moduledoc "A placeholder for a stacktrace so that we can avoid printing it everywhere"
   defstruct [:stacktrace]
diff --git a/lib/splode/unknown.ex b/lib/splode/unknown.ex
@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2020 Zach Daniel
+#
+# SPDX-License-Identifier: MIT
+
 defmodule Splode.Error.Unknown do
   @moduledoc "The default top level unknown error container"
   use Splode.ErrorClass, class: :unknown
diff --git a/mix.exs b/mix.exs
@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2020 Zach Daniel
+#
+# SPDX-License-Identifier: MIT
+
 defmodule Splode.MixProject do
   use Mix.Project
 
@@ -32,15 +36,19 @@ defmodule Splode.MixProject do
 
   defp package do
     [
-      name: :splode,
+      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/splode",
-        Discord: "https://discord.gg/HTHRaaVPUc",
-        Website: "https://ash-hq.org",
-        Forum: "https://elixirforum.com/c/elixir-framework-forums/ash-framework-forum"
+        "GitHub" => "https://github.com/ash-project/splode",
+        "Changelog" => "https://github.com/ash-project/splode/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/splode"
       }
     ]
   end
diff --git a/mix.lock.license b/mix.lock.license
@@ -0,0 +1,3 @@
+SPDX-FileCopyrightText: 2020 Zach Daniel
+
+SPDX-License-Identifier: MIT
diff --git a/test/splode/error_test.exs b/test/splode/error_test.exs
@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2020 Zach Daniel
+#
+# SPDX-License-Identifier: MIT
+
 defmodule Splode.ErrorTest do
   alias Splode.Stacktrace
   use ExUnit.Case
diff --git a/test/splode_test.exs b/test/splode_test.exs
@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2020 Zach Daniel
+#
+# SPDX-License-Identifier: MIT
+
 defmodule SplodeTest do
   use ExUnit.Case
 
diff --git a/test/test_helper.exs b/test/test_helper.exs
@@ -1 +1,5 @@
+# SPDX-FileCopyrightText: 2020 Zach Daniel
+#
+# SPDX-License-Identifier: MIT
+
 ExUnit.start()

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,7 @@`
	`1`	`+# SPDX-FileCopyrightText: 2020 Zach Daniel`
	`2`	`+#`
	`3`	`+# SPDX-License-Identifier: MIT`
	`4`	`+`
`1`	`5`	`# This file contains the configuration for Credo and you are probably reading`
`2`	`6`	# this after creating it with `mix credo.gen.config`.
`3`	`7`	`#`
Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,3 @@`
`1`	`1`	`erlang 26.0.2`
`2`	`2`	`elixir 1.18.4`
	`3`	`+pipx 1.8.0`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+SPDX-FileCopyrightText: 2020 Zach Daniel`
	`2`	`+`
	`3`	`+SPDX-License-Identifier: MIT`