chore: make the repo REUSE-compliant

ejpcmac · ejpcmac · commit 2531bcd9501a · 2025-10-28T09:11:35.000+01:00
Refs: #50
diff --git a/.check.exs b/.check.exs
@@ -1,10 +1,13 @@
+# SPDX-FileCopyrightText: 2025 Jean-Philippe Cugnet <jean-philippe@cugnet.eu>
+# SPDX-License-Identifier: MIT
+
 eclint_excluded_files = [
   "**.ex",
   "**.exs",
   "**.js",
   "**.lock",
   "**.toml",
-  "LICENSE"
+  "LICENSES/*"
 ]
 
 enabled? = fn ci_job ->
diff --git a/.credo.exs b/.credo.exs
@@ -1,3 +1,6 @@
+# SPDX-FileCopyrightText: NONE
+# SPDX-License-Identifier: CC0-1.0
+
 # This file contains the configuration for Credo and you are probably reading
 # this after creating it with `mix credo.gen.config`.
 #
diff --git a/.editorconfig b/.editorconfig
@@ -1,3 +1,6 @@
+# SPDX-FileCopyrightText: NONE
+# SPDX-License-Identifier: CC0-1.0
+
 # EditorConfig is awesome: http://EditorConfig.org
 
 root = true
@@ -29,3 +32,11 @@ max_line_length = 140
 # NOTE: The README.md contains some URLs being too long to fit on 80-character
 # lines.
 max_line_length = 100
+
+[flake.nix]
+# NOTE: The copyright line is 82-character-long and cannot be split.
+max_line_length = 82
+
+[ci.yml]
+# NOTE: The copyright line is 88-character-long and cannot be split.
+max_line_length = 88
diff --git a/.envrc b/.envrc
@@ -1 +1,4 @@
+# SPDX-FileCopyrightText: NONE
+# SPDX-License-Identifier: CC0-1.0
+
 use flake . --print-build-logs
diff --git a/.formatter.exs b/.formatter.exs
@@ -1,3 +1,6 @@
+# SPDX-FileCopyrightText: NONE
+# SPDX-License-Identifier: CC0-1.0
+
 locals_without_parens = [field: 2, field: 3, plugin: 1, plugin: 2]
 
 [
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -1,3 +1,6 @@
+# SPDX-FileCopyrightText: 2022, 2024-2025 Jean-Philippe Cugnet <jean-philippe@cugnet.eu>
+# SPDX-License-Identifier: CC0-1.0
+
 name: CI
 
 on:
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,6 @@
+# SPDX-FileCopyrightText: NONE
+# SPDX-License-Identifier: CC0-1.0
+
 ##
 ## Application artifacts
 ##
diff --git a/.gitsetup b/.gitsetup
@@ -1,5 +1,8 @@
 #!/bin/sh
 
+# SPDX-FileCopyrightText: NONE
+# SPDX-License-Identifier: CC0-1.0
+
 set -e
 set -x
 
diff --git a/.prettierignore b/.prettierignore
@@ -1,2 +1,5 @@
+# SPDX-FileCopyrightText: NONE
+# SPDX-License-Identifier: CC0-1.0
+
 *.lock
 *.md
diff --git a/.vscode/extensions.json.license b/.vscode/extensions.json.license
@@ -0,0 +1,2 @@
+SPDX-FileCopyrightText: NONE
+SPDX-License-Identifier: CC0-1.0
diff --git a/.vscode/settings.json.license b/.vscode/settings.json.license
@@ -0,0 +1,2 @@
+SPDX-FileCopyrightText: NONE
+SPDX-License-Identifier: CC0-1.0
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,8 @@
+<!--
+SPDX-FileCopyrightText: 2018, 2020, 2022 Jean-Philippe Cugnet <jean-philippe@cugnet.eu>
+SPDX-License-Identifier: CC-BY-SA-4.0
+-->
+
 # Changelog
 
 All notable changes to this project will be documented in this file.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,3 +1,8 @@
+<!--
+SPDX-FileCopyrightText: 2018-2025 Jean-Philippe Cugnet <jean-philippe@cugnet.eu>
+SPDX-License-Identifier: CC-BY-SA-4.0
+-->
+
 # Contributing to TypedStruct
 
 TypedStruct is written in [Elixir](https://elixir-lang.org).
@@ -170,3 +175,29 @@ Please name your commits using [Conventional
 Commits](https://www.conventionalcommits.org/en/v1.0.0/) and using the types and
 scopes defined in `git-z.toml`. You can use `git z commit` to help you prepare
 the commit message.
+
+## Licensing and REUSE compliance
+
+By contributing to `typed_struct`, you agree that, unless stated otherwise (e.g.
+by a different `SPDX-License-Identifier` header in the contributed file), your
+contributions will be licensed under the [MIT license](./LICENSES/MIT.txt) for
+code and the [Creative Commons Attribution Share Alike 4.0
+International](./LICENSES/CC-BY-SA-4.0.txt) license for documentation.
+
+This project follows the [REUSE](https://reuse.software/) specification to keep
+track of copyright and license information. Each file must contain SPDX license
+headers, like:
+
+<!-- REUSE-IgnoreStart -->
+```elixir
+# SPDX-FileCopyrightText: 1970 Your Name <your.name@email.provider>
+# SPDX-License-Identifier: MIT
+```
+<!-- REUSE-IgnoreEND -->
+
+When this is not possible, a `.license` file should be created instead, as
+described [here](https://reuse.software/faq/#uncommentable-file).
+
+You can use the `reuse` tool to help you annotate a file:
+
+    reuse annotate -l MIT -c "Your Name <your.name@email.provider>" <file>
diff --git a/LICENSES/CC-BY-SA-4.0.txt b/LICENSES/CC-BY-SA-4.0.txt
diff --git a/LICENSES/CC0-1.0.txt b/LICENSES/CC0-1.0.txt
@@ -0,0 +1,121 @@
+Creative Commons Legal Code
+
+CC0 1.0 Universal
+
+    CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE
+    LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN
+    ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS
+    INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES
+    REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS
+    PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM
+    THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED
+    HEREUNDER.
+
+Statement of Purpose
+
+The laws of most jurisdictions throughout the world automatically confer
+exclusive Copyright and Related Rights (defined below) upon the creator
+and subsequent owner(s) (each and all, an "owner") of an original work of
+authorship and/or a database (each, a "Work").
+
+Certain owners wish to permanently relinquish those rights to a Work for
+the purpose of contributing to a commons of creative, cultural and
+scientific works ("Commons") that the public can reliably and without fear
+of later claims of infringement build upon, modify, incorporate in other
+works, reuse and redistribute as freely as possible in any form whatsoever
+and for any purposes, including without limitation commercial purposes.
+These owners may contribute to the Commons to promote the ideal of a free
+culture and the further production of creative, cultural and scientific
+works, or to gain reputation or greater distribution for their Work in
+part through the use and efforts of others.
+
+For these and/or other purposes and motivations, and without any
+expectation of additional consideration or compensation, the person
+associating CC0 with a Work (the "Affirmer"), to the extent that he or she
+is an owner of Copyright and Related Rights in the Work, voluntarily
+elects to apply CC0 to the Work and publicly distribute the Work under its
+terms, with knowledge of his or her Copyright and Related Rights in the
+Work and the meaning and intended legal effect of CC0 on those rights.
+
+1. Copyright and Related Rights. A Work made available under CC0 may be
+protected by copyright and related or neighboring rights ("Copyright and
+Related Rights"). Copyright and Related Rights include, but are not
+limited to, the following:
+
+  i. the right to reproduce, adapt, distribute, perform, display,
+     communicate, and translate a Work;
+ ii. moral rights retained by the original author(s) and/or performer(s);
+iii. publicity and privacy rights pertaining to a person's image or
+     likeness depicted in a Work;
+ iv. rights protecting against unfair competition in regards to a Work,
+     subject to the limitations in paragraph 4(a), below;
+  v. rights protecting the extraction, dissemination, use and reuse of data
+     in a Work;
+ vi. database rights (such as those arising under Directive 96/9/EC of the
+     European Parliament and of the Council of 11 March 1996 on the legal
+     protection of databases, and under any national implementation
+     thereof, including any amended or successor version of such
+     directive); and
+vii. other similar, equivalent or corresponding rights throughout the
+     world based on applicable law or treaty, and any national
+     implementations thereof.
+
+2. Waiver. To the greatest extent permitted by, but not in contravention
+of, applicable law, Affirmer hereby overtly, fully, permanently,
+irrevocably and unconditionally waives, abandons, and surrenders all of
+Affirmer's Copyright and Related Rights and associated claims and causes
+of action, whether now known or unknown (including existing as well as
+future claims and causes of action), in the Work (i) in all territories
+worldwide, (ii) for the maximum duration provided by applicable law or
+treaty (including future time extensions), (iii) in any current or future
+medium and for any number of copies, and (iv) for any purpose whatsoever,
+including without limitation commercial, advertising or promotional
+purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each
+member of the public at large and to the detriment of Affirmer's heirs and
+successors, fully intending that such Waiver shall not be subject to
+revocation, rescission, cancellation, termination, or any other legal or
+equitable action to disrupt the quiet enjoyment of the Work by the public
+as contemplated by Affirmer's express Statement of Purpose.
+
+3. Public License Fallback. Should any part of the Waiver for any reason
+be judged legally invalid or ineffective under applicable law, then the
+Waiver shall be preserved to the maximum extent permitted taking into
+account Affirmer's express Statement of Purpose. In addition, to the
+extent the Waiver is so judged Affirmer hereby grants to each affected
+person a royalty-free, non transferable, non sublicensable, non exclusive,
+irrevocable and unconditional license to exercise Affirmer's Copyright and
+Related Rights in the Work (i) in all territories worldwide, (ii) for the
+maximum duration provided by applicable law or treaty (including future
+time extensions), (iii) in any current or future medium and for any number
+of copies, and (iv) for any purpose whatsoever, including without
+limitation commercial, advertising or promotional purposes (the
+"License"). The License shall be deemed effective as of the date CC0 was
+applied by Affirmer to the Work. Should any part of the License for any
+reason be judged legally invalid or ineffective under applicable law, such
+partial invalidity or ineffectiveness shall not invalidate the remainder
+of the License, and in such case Affirmer hereby affirms that he or she
+will not (i) exercise any of his or her remaining Copyright and Related
+Rights in the Work or (ii) assert any associated claims and causes of
+action with respect to the Work, in either case contrary to Affirmer's
+express Statement of Purpose.
+
+4. Limitations and Disclaimers.
+
+ a. No trademark or patent rights held by Affirmer are waived, abandoned,
+    surrendered, licensed or otherwise affected by this document.
+ b. Affirmer offers the Work as-is and makes no representations or
+    warranties of any kind concerning the Work, express, implied,
+    statutory or otherwise, including without limitation warranties of
+    title, merchantability, fitness for a particular purpose, non
+    infringement, or the absence of latent or other defects, accuracy, or
+    the present or absence of errors, whether or not discoverable, all to
+    the greatest extent permissible under applicable law.
+ c. Affirmer disclaims responsibility for clearing rights of other persons
+    that may apply to the Work or any use thereof, including without
+    limitation any person's Copyright and Related Rights in the Work.
+    Further, Affirmer disclaims responsibility for obtaining any necessary
+    consents, permissions or other rights required for any use of the
+    Work.
+ d. Affirmer understands and acknowledges that Creative Commons is not a
+    party to this document and has no duty or obligation with respect to
+    this CC0 or use of the Work.
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,9 +1,14 @@
+<!--
+SPDX-FileCopyrightText: 2018-2022, 2025 Jean-Philippe Cugnet <jean-philippe@cugnet.eu>
+SPDX-License-Identifier: CC-BY-SA-4.0
+-->
+
 # TypedStruct
 
 [![hex.pm version](https://img.shields.io/hexpm/v/typed_struct.svg)](https://hex.pm/packages/typed_struct)
 [![Hex Docs](https://img.shields.io/badge/hex-docs-lightgreen.svg)](https://hexdocs.pm/typed_struct/)
 [![Total Download](https://img.shields.io/hexpm/dt/typed_struct.svg)](https://hex.pm/packages/typed_struct)
-[![License](https://img.shields.io/hexpm/l/typed_struct.svg)](https://github.com/ejpcmac/typed_struct/blob/master/LICENSE.md)  
+[![License](https://img.shields.io/hexpm/l/typed_struct.svg)](https://github.com/ejpcmac/typed_struct/blob/main/LICENSES/MIT.txt)  
 [![codecov](https://codecov.io/gh/ejpcmac/typed_struct/graph/badge.svg?token=riJ8O4G501)](https://codecov.io/gh/ejpcmac/typed_struct)
 [![Test Status](https://github.com/ejpcmac/typed_struct/actions/workflows/ci.yml/badge.svg)
 ](https://github.com/ejpcmac/typed_struct/actions/workflows/ci.yml)
@@ -415,6 +420,11 @@ Before contributing to this project, please read the
 
 ## License
 
-Copyright © 2018-2022 Jean-Philippe Cugnet and Contributors
+Copyright © 2018-2022, 2025 Jean-Philippe Cugnet and Contributors
+
+This project is licensed under the [MIT license](./LICENSES/MIT.txt). Its
+documentation is licensed under the [Creative Commons Attribution Share Alike
+4.0 International](./LICENSES/CC-BY-SA-4.0.txt) license.
 
-This project is licensed under the [MIT license](./LICENSE.md).
+The copyright and license information is embedded in each file, following the
+[REUSE](https://reuse.software/) specification.
diff --git a/codecov.yml b/codecov.yml
@@ -1,3 +1,6 @@
+# SPDX-FileCopyrightText: NONE
+# SPDX-License-Identifier: CC0-1.0
+
 codecov:
   branch: develop
 
diff --git a/committed.toml b/committed.toml
@@ -1,3 +1,6 @@
+# SPDX-FileCopyrightText: NONE
+# SPDX-License-Identifier: CC0-1.0
+
 line_length = 80
 style = "conventional"
 subject_capitalized = false
diff --git a/flake.lock.license b/flake.lock.license
@@ -0,0 +1,2 @@
+SPDX-FileCopyrightText: NONE
+SPDX-License-Identifier: CC0-1.0
diff --git a/flake.nix b/flake.nix
@@ -1,3 +1,6 @@
+# SPDX-FileCopyrightText: 2023-2025 Jean-Philippe Cugnet <jean-philippe@cugnet.eu>
+# SPDX-License-Identifier: MIT
+
 {
   description = "Typed Elixir structs without boilerplate code.";
 
diff --git a/git-z.toml b/git-z.toml
@@ -1,3 +1,6 @@
+# SPDX-FileCopyrightText: 2023-2025 Jean-Philippe Cugnet <jean-philippe@cugnet.eu>
+# SPDX-License-Identifier: CC0-1.0
+
 version = "0.2"
 
 # The available types of commits and their description.
diff --git a/lib/typed_struct.ex b/lib/typed_struct.ex
@@ -1,3 +1,9 @@
+# SPDX-FileCopyrightText: 2018-2022, 2025 Jean-Philippe Cugnet <jean-philippe@cugnet.eu>
+# SPDX-FileCopyrightText: 2018 Marcin Górnik <marcin.gornik@gmail.com>
+# SPDX-FileCopyrightText: 2022 Jonathan Chukinas <chukinas@gmail.com>
+#
+# SPDX-License-Identifier: MIT
+
 defmodule TypedStruct do
   @external_resource "README.md"
   @moduledoc "README.md"
diff --git a/lib/typed_struct/plugin.ex b/lib/typed_struct/plugin.ex
@@ -1,3 +1,8 @@
+# SPDX-FileCopyrightText: 2019-2022 Jean-Philippe Cugnet <jean-philippe@cugnet.eu>
+# SPDX-FileCopyrightText: 2022 Jonathan Chukinas <chukinas@gmail.com>
+#
+# SPDX-License-Identifier: MIT
+
 defmodule TypedStruct.Plugin do
   @moduledoc """
   This module defines the plugin interface for TypedStruct.
diff --git a/mix.exs b/mix.exs
@@ -1,3 +1,6 @@
+# SPDX-FileCopyrightText: 2018-2022, 2025 Jean-Philippe Cugnet <jean-philippe@cugnet.eu>
+# SPDX-License-Identifier: MIT
+
 defmodule TypedStruct.MixProject do
   use Mix.Project
 
@@ -25,7 +28,8 @@ defmodule TypedStruct.MixProject do
           "README.md": [title: "Overview"],
           "CHANGELOG.md": [title: "Changelog"],
           "CONTRIBUTING.md": [title: "Contributing"],
-          "LICENSE.md": [title: "License"]
+          "LICENSES/MIT.txt": [title: "MIT License"],
+          "LICENSES/CC-BY-SA-4.0.txt": [title: "CC-BY-SA 4.0 License"]
         ],
         main: "readme",
         source_url: @repo_url,
diff --git a/mix.lock.license b/mix.lock.license
@@ -0,0 +1,2 @@
+SPDX-FileCopyrightText: NONE
+SPDX-License-Identifier: CC0-1.0
diff --git a/scripts/check_commits.exs b/scripts/check_commits.exs
@@ -1,5 +1,8 @@
 #!/usr/bin/env elixir
 
+# SPDX-FileCopyrightText: 2025 Jean-Philippe Cugnet <jean-philippe@cugnet.eu>
+# SPDX-License-Identifier: MIT
+
 defmodule CheckCommits do
   def run do
     commits = commits_to_check()
diff --git a/taplo.toml b/taplo.toml
@@ -1,3 +1,6 @@
+# SPDX-FileCopyrightText: NONE
+# SPDX-License-Identifier: CC0-1.0
+
 include = ["*.toml"]
 
 [formatting]
diff --git a/test/support/test_struct.ex b/test/support/test_struct.ex
diff --git a/test/test_helper.exs b/test/test_helper.exs
diff --git a/test/typed_struct/plugin_test.exs b/test/typed_struct/plugin_test.exs
diff --git a/test/typed_struct/plugin_type_test.exs b/test/typed_struct/plugin_type_test.exs
diff --git a/test/typed_struct_test.exs b/test/typed_struct_test.exs

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,6 @@`
	`1`	`+# SPDX-FileCopyrightText: NONE`
	`2`	`+# SPDX-License-Identifier: CC0-1.0`
	`3`	`+`
`1`	`4`	`# This file contains the configuration for Credo and you are probably reading`
`2`	`5`	# this after creating it with `mix credo.gen.config`.
`3`	`6`	`#`
-Original file line number
+Diff line change
@@ @@ -1,2 +1,5 @@ @@
 +# SPDX-FileCopyrightText: NONE
 +# SPDX-License-Identifier: CC0-1.0
++
 *.lock
 *.md
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+SPDX-FileCopyrightText: NONE`
	`2`	`+SPDX-License-Identifier: CC0-1.0`