Add SPDX-License-Identifier to all modules

app/Main.hs

@@ -2,6 +2,8 @@
 {-# LANGUAGE OverloadedStrings #-}
 {-# LANGUAGE TemplateHaskell #-}
 
+-- |
+-- SPDX-License-Identifier: BSD-3-Clause
 module Main where
 
 import Data.Foldable qualified

bench/Benchmark.hs

@@ -1,6 +1,8 @@
 {-# LANGUAGE OverloadedStrings #-}
 {-# LANGUAGE QuasiQuotes #-}
 
+-- |
+-- SPDX-License-Identifier: BSD-3-Clause
 module Main where
 
 import Control.Lens ((&), (.~))

src/Data/BoolExpr.hs

@@ -43,6 +43,7 @@ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 -- Module    : Data.BoolExpr
 -- Copyright : (c) Nicolas Pouillard 2008,2009
 -- License   : BSD3
+-- SPDX-License-Identifier: BSD3
 --
 -- Maintainer: Nicolas Pouillard <nicolas.pouillard@gmail.com>
 -- Stability : provisional

src/Data/BoolExpr/Simplify.hs

@@ -1,4 +1,7 @@
--- | Simplification logic for boolean expressions that is not
+-- |
+-- SPDX-License-Identifier: BSD-3-Clause
+--
+-- Simplification logic for boolean expressions that is not
 -- provided in the 'boolexpr' package.
 module Data.BoolExpr.Simplify (
   cannotBeTrue,

src/Swarm/App.hs

@@ -1,6 +1,8 @@
 {-# LANGUAGE OverloadedStrings #-}
 
 -- |
+-- SPDX-License-Identifier: BSD-3-Clause
+--
 -- Main entry point for the Swarm application.
 module Swarm.App where
 

src/Swarm/DocGen.hs

@@ -1,6 +1,8 @@
 {-# LANGUAGE OverloadedStrings #-}
 {-# LANGUAGE RecordWildCards #-}
 
+-- |
+-- SPDX-License-Identifier: BSD-3-Clause
 module Swarm.DocGen (
   generateDocs,
   GenerateDocs (..),

src/Swarm/Game/Achievement/Attainment.hs

@@ -1,5 +1,9 @@
 {-# LANGUAGE TemplateHaskell #-}
 
+-- |
+-- SPDX-License-Identifier: BSD-3-Clause
+--
+-- Metadata about achievements that the player has obtained
 module Swarm.Game.Achievement.Attainment where
 
 import Control.Lens hiding (from, (<.>))

src/Swarm/Game/Achievement/Definitions.hs

@@ -1,3 +1,7 @@
+-- |
+-- SPDX-License-Identifier: BSD-3-Clause
+--
+-- Definitions of all possible achievements.
 module Swarm.Game.Achievement.Definitions where
 
 import Data.Aeson

src/Swarm/Game/Achievement/Description.hs

@@ -1,5 +1,9 @@
 {-# LANGUAGE OverloadedStrings #-}
 
+-- |
+-- SPDX-License-Identifier: BSD-3-Clause
+--
+-- Flavor text about all defined achievements.
 module Swarm.Game.Achievement.Description where
 
 import Swarm.Game.Achievement.Definitions

src/Swarm/Game/Achievement/Persistence.hs

@@ -1,5 +1,9 @@
 {-# LANGUAGE OverloadedStrings #-}
 
+-- |
+-- SPDX-License-Identifier: BSD-3-Clause
+--
+-- Load/save logic for achievements.
 module Swarm.Game.Achievement.Persistence where
 
 import Control.Arrow (left)

src/Swarm/Game/CESK.hs

@@ -3,6 +3,8 @@
 {-# LANGUAGE PatternSynonyms #-}
 
 -- |
+-- SPDX-License-Identifier: BSD-3-Clause
+--
 -- The Swarm interpreter uses a technique known as a
 -- <https://matt.might.net/articles/cesk-machines/ CESK machine> (if
 -- you want to read up on them, you may want to start by reading about

src/Swarm/Game/Display.hs

@@ -5,6 +5,8 @@
 -- Orphan Hashable instances needed to derive Hashable Display
 
 -- |
+-- SPDX-License-Identifier: BSD-3-Clause
+--
 -- Utilities for describing how to display in-game entities in the TUI.
 module Swarm.Game.Display (
   -- * The display record

src/Swarm/Game/Entity.hs

@@ -2,6 +2,8 @@
 {-# LANGUAGE TypeFamilies #-}
 
 -- |
+-- SPDX-License-Identifier: BSD-3-Clause
+--
 -- An 'Entity' represents an object that exists in the world.  Each
 -- entity has a way to be displayed, some metadata such as a name and
 -- description, some properties, and possibly an inventory of other

src/Swarm/Game/Exception.hs

@@ -2,6 +2,8 @@
 {-# LANGUAGE OverloadedStrings #-}
 
 -- |
+-- SPDX-License-Identifier: BSD-3-Clause
+--
 -- Runtime exceptions for the Swarm language interpreter.
 module Swarm.Game.Exception (
   Exn (..),

src/Swarm/Game/Failure.hs

@@ -1,4 +1,6 @@
 -- |
+-- SPDX-License-Identifier: BSD-3-Clause
+--
 -- A data type to represent system failures.
 --
 -- These failures are often not fatal and serve

src/Swarm/Game/Failure/Render.hs

@@ -1,5 +1,9 @@
 {-# LANGUAGE OverloadedStrings #-}
 
+-- |
+-- SPDX-License-Identifier: BSD-3-Clause
+--
+-- Pretty-printing failure messages
 module Swarm.Game.Failure.Render where
 
 import Data.Char (toLower)

src/Swarm/Game/Location.hs

@@ -4,6 +4,8 @@
 -- Orphan JSON instances for Location and Heading
 
 -- |
+-- SPDX-License-Identifier: BSD-3-Clause
+--
 -- Locations and headings.
 module Swarm.Game.Location (
   Location,

src/Swarm/Game/Log.hs

@@ -2,6 +2,8 @@
 {-# LANGUAGE TemplateHaskell #-}
 
 -- |
+-- SPDX-License-Identifier: BSD-3-Clause
+--
 -- A data type to represent in-game logs by robots.
 --
 -- Because of the use of system robots, we sometimes

src/Swarm/Game/Recipe.hs

@@ -2,6 +2,8 @@
 {-# LANGUAGE TemplateHaskell #-}
 
 -- |
+-- SPDX-License-Identifier: BSD-3-Clause
+--
 -- A recipe represents some kind of process for transforming
 -- some input entities into some output entities.
 module Swarm.Game.Recipe (

src/Swarm/Game/ResourceLoading.hs

@@ -1,5 +1,8 @@
 {-# LANGUAGE OverloadedStrings #-}
 
+-- |
+-- SPDX-License-Identifier: BSD-3-Clause
+--
 -- Various utilities related to loading game data files.
 module Swarm.Game.ResourceLoading where
 

src/Swarm/Game/Robot.hs

@@ -7,6 +7,8 @@
 {-# LANGUAGE ViewPatterns #-}
 
 -- |
+-- SPDX-License-Identifier: BSD-3-Clause
+--
 -- A data type to represent robots.
 module Swarm.Game.Robot (
   -- * Robots data

src/Swarm/Game/Scenario.hs

@@ -6,6 +6,8 @@
 {-# LANGUAGE TemplateHaskell #-}
 
 -- |
+-- SPDX-License-Identifier: BSD-3-Clause
+--
 -- Scenarios are standalone worlds with specific starting and winning
 -- conditions, which can be used both for building interactive
 -- tutorials and for standalone puzzles and scenarios.

src/Swarm/Game/Scenario/Cell.hs

@@ -1,6 +1,8 @@
 {-# LANGUAGE DerivingVia #-}
 {-# LANGUAGE OverloadedStrings #-}
 
+-- |
+-- SPDX-License-Identifier: BSD-3-Clause
 module Swarm.Game.Scenario.Cell (
   PCell (..),
   Cell,

src/Swarm/Game/Scenario/Objective.hs

@@ -2,6 +2,8 @@
 {-# LANGUAGE TemplateHaskell #-}
 {-# OPTIONS_GHC -fno-warn-orphans #-}
 
+-- |
+-- SPDX-License-Identifier: BSD-3-Clause
 module Swarm.Game.Scenario.Objective where
 
 import Control.Applicative ((<|>))

src/Swarm/Game/Scenario/Objective/Graph.hs

@@ -1,6 +1,9 @@
 {-# OPTIONS_GHC -fno-warn-orphans #-}
 
--- | Utilities for performing graph analysis on Objective prerequisites
+-- |
+-- SPDX-License-Identifier: BSD-3-Clause
+--
+-- Utilities for performing graph analysis on Objective prerequisites
 module Swarm.Game.Scenario.Objective.Graph where
 
 import Control.Arrow ((&&&))

src/Swarm/Game/Scenario/Objective/Logic.hs

@@ -1,4 +1,7 @@
--- | A model for defining boolean expressions for Objective prerequisites.
+-- |
+-- SPDX-License-Identifier: BSD-3-Clause
+--
+-- A model for defining boolean expressions for Objective prerequisites.
 --
 -- This model is intended to be user-facing in the .yaml files, and is
 -- distinct from that in 'Data.BoolExpr'.

src/Swarm/Game/Scenario/Objective/Validation.hs

@@ -1,6 +1,9 @@
 {-# LANGUAGE OverloadedStrings #-}
 
--- | Validity checking for Objective prerequisites
+-- |
+-- SPDX-License-Identifier: BSD-3-Clause
+--
+-- Validity checking for Objective prerequisites
 module Swarm.Game.Scenario.Objective.Validation where
 
 import Control.Monad (unless)

src/Swarm/Game/Scenario/Objective/WinCheck.hs

@@ -1,4 +1,7 @@
--- | Utilities to check whether conditions are met for a game win/loss.
+-- |
+-- SPDX-License-Identifier: BSD-3-Clause
+--
+-- Utilities to check whether conditions are met for a game win/loss.
 module Swarm.Game.Scenario.Objective.WinCheck where
 
 import Data.Aeson

src/Swarm/Game/Scenario/RobotLookup.hs

@@ -1,6 +1,8 @@
 {-# LANGUAGE DerivingVia #-}
 {-# LANGUAGE OverloadedStrings #-}
 
+-- |
+-- SPDX-License-Identifier: BSD-3-Clause
 module Swarm.Game.Scenario.RobotLookup where
 
 import Control.Lens hiding (from, (<.>))

src/Swarm/Game/Scenario/Style.hs

@@ -1,3 +1,5 @@
+-- |
+-- SPDX-License-Identifier: BSD-3-Clause
 module Swarm.Game.Scenario.Style where
 
 import Data.Aeson

src/Swarm/Game/Scenario/WorldDescription.hs

@@ -1,6 +1,8 @@
 {-# LANGUAGE DerivingVia #-}
 {-# LANGUAGE OverloadedStrings #-}
 
+-- |
+-- SPDX-License-Identifier: BSD-3-Clause
 module Swarm.Game.Scenario.WorldDescription where
 
 import Data.Aeson.Key qualified as Key

src/Swarm/Game/ScenarioInfo.hs

@@ -5,6 +5,8 @@
 -- -Wno-orphans is for the Eq/Ord Time instances
 
 -- |
+-- SPDX-License-Identifier: BSD-3-Clause
+--
 -- Saving and loading info about scenarios (status, path, etc.) as
 -- well as loading recursive scenario collections.
 module Swarm.Game.ScenarioInfo (

src/Swarm/Game/State.hs

@@ -7,6 +7,8 @@
 {-# LANGUAGE ViewPatterns #-}
 
 -- |
+-- SPDX-License-Identifier: BSD-3-Clause
+--
 -- Definition of the record holding all the game-related state, and various related
 -- utility functions.
 module Swarm.Game.State (

src/Swarm/Game/Step.hs

@@ -7,6 +7,8 @@
 {-# LANGUAGE ViewPatterns #-}
 
 -- |
+-- SPDX-License-Identifier: BSD-3-Clause
+--
 -- Facilities for stepping the robot CESK machines, /i.e./ the actual
 -- interpreter for the Swarm language.
 --

src/Swarm/Game/Terrain.hs

@@ -1,6 +1,8 @@
 {-# LANGUAGE OverloadedStrings #-}
 
 -- |
+-- SPDX-License-Identifier: BSD-3-Clause
+--
 -- Terrain types and properties.
 module Swarm.Game.Terrain (
   -- * Terrain

src/Swarm/Game/World.hs

@@ -2,6 +2,8 @@
 {-# LANGUAGE TypeFamilies #-}
 
 -- |
+-- SPDX-License-Identifier: BSD-3-Clause
+--
 -- A /world/ refers to the grid on which the game takes place, and the
 -- things in it (besides robots). A world has a base, immutable
 -- /terrain/ layer, where each cell contains a terrain type, and a

src/Swarm/Game/WorldGen.hs

@@ -2,6 +2,8 @@
 {-# LANGUAGE TypeApplications #-}
 
 -- |
+-- SPDX-License-Identifier: BSD-3-Clause
+--
 -- Procedural world generation via coherent noise.
 module Swarm.Game.WorldGen where
 

src/Swarm/Language/Capability.hs

@@ -1,4 +1,6 @@
 -- |
+-- SPDX-License-Identifier: BSD-3-Clause
+--
 -- Capabilities needed to evaluate and execute programs.  Language
 -- constructs or commands require certain capabilities, and in turn
 -- capabilities are provided by various devices.  A robot must have an

src/Swarm/Language/Context.hs

@@ -1,6 +1,8 @@
 {-# LANGUAGE DeriveDataTypeable #-}
 
 -- |
+-- SPDX-License-Identifier: BSD-3-Clause
+--
 -- Generic contexts (mappings from variables to other things, such as
 -- types, values, or capability sets) used throughout the codebase.
 module Swarm.Language.Context where

src/Swarm/Language/Elaborate.hs

@@ -1,6 +1,8 @@
 {-# LANGUAGE OverloadedStrings #-}
 
 -- |
+-- SPDX-License-Identifier: BSD-3-Clause
+--
 -- Term elaboration which happens after type checking.
 module Swarm.Language.Elaborate where
 

src/Swarm/Language/LSP.hs

@@ -1,6 +1,8 @@
 {-# LANGUAGE OverloadedStrings #-}
 
 -- |
+-- SPDX-License-Identifier: BSD-3-Clause
+--
 -- Language Server Protocol (LSP) server for the Swarm language.
 -- See the docs/EDITORS.md to learn how to use it.
 module Swarm.Language.LSP where

src/Swarm/Language/LSP/VarUsage.hs

@@ -1,5 +1,7 @@
 {-# LANGUAGE OverloadedStrings #-}
 
+-- |
+-- SPDX-License-Identifier: BSD-3-Clause
 module Swarm.Language.LSP.VarUsage where
 
 import Control.Monad (guard)

src/Swarm/Language/Module.hs

@@ -1,4 +1,6 @@
 -- |
+-- SPDX-License-Identifier: BSD-3-Clause
+--
 -- A 'Module' packages together a type-annotated syntax tree along
 -- with a context of top-level definitions.
 module Swarm.Language.Module (

src/Swarm/Language/Parse.hs

@@ -2,6 +2,8 @@
 {-# LANGUAGE TypeFamilies #-}
 
 -- |
+-- SPDX-License-Identifier: BSD-3-Clause
+--
 -- Parser for the Swarm language.  Note, you probably don't want to
 -- use this directly, unless there is a good reason to parse a term
 -- without also type checking it; use

src/Swarm/Language/Parse/QQ.hs

@@ -1,4 +1,6 @@
 -- |
+-- SPDX-License-Identifier: BSD-3-Clause
+--
 -- A quasiquoter for Swarm polytypes.
 module Swarm.Language.Parse.QQ (tyQ) where