remove copyright boilerplate (#1134)

closes #1120
swarm-game · Feb 27, 2023 · affc866 · affc866
1 parent 049e1fc
commit affc866
Show file tree

Hide file tree

Showing 89 changed files with 140 additions and 183 deletions.
diff --git a/app/Main.hs b/app/Main.hs
@@ -2,6 +2,8 @@
 {-# LANGUAGE OverloadedStrings #-}
 {-# LANGUAGE TemplateHaskell #-}
 
+-- |
+-- SPDX-License-Identifier: BSD-3-Clause
 module Main where
 
 import Data.Foldable qualified

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

diff --git a/src/Data/BoolExpr.hs b/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: BSD-3-Clause
 --
 -- Maintainer: Nicolas Pouillard <nicolas.pouillard@gmail.com>
 -- Stability : provisional

diff --git a/src/Data/BoolExpr/Simplify.hs b/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,

diff --git a/src/Swarm/App.hs b/src/Swarm/App.hs
@@ -1,10 +1,6 @@
 {-# LANGUAGE OverloadedStrings #-}
 
 -- |
--- Module      :  Swarm.App
--- Copyright   :  Brent Yorgey
--- Maintainer  :  byorgey@gmail.com
---
 -- SPDX-License-Identifier: BSD-3-Clause
 --
 -- Main entry point for the Swarm application.

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

diff --git a/src/Swarm/Game/Achievement/Attainment.hs b/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, (<.>))

diff --git a/src/Swarm/Game/Achievement/Definitions.hs b/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

diff --git a/src/Swarm/Game/Achievement/Description.hs b/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

diff --git a/src/Swarm/Game/Achievement/Persistence.hs b/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)

diff --git a/src/Swarm/Game/CESK.hs b/src/Swarm/Game/CESK.hs
@@ -3,10 +3,6 @@
 {-# LANGUAGE PatternSynonyms #-}
 
 -- |
--- Module      :  Swarm.Game.CESK
--- Copyright   :  Brent Yorgey
--- Maintainer  :  byorgey@gmail.com
---
 -- SPDX-License-Identifier: BSD-3-Clause
 --
 -- The Swarm interpreter uses a technique known as a

diff --git a/src/Swarm/Game/Display.hs b/src/Swarm/Game/Display.hs
@@ -5,10 +5,6 @@
 -- Orphan Hashable instances needed to derive Hashable Display
 
 -- |
--- Module      :  Swarm.Game.Display
--- Copyright   :  Brent Yorgey
--- Maintainer  :  byorgey@gmail.com
---
 -- SPDX-License-Identifier: BSD-3-Clause
 --
 -- Utilities for describing how to display in-game entities in the TUI.

diff --git a/src/Swarm/Game/Entity.hs b/src/Swarm/Game/Entity.hs
@@ -2,10 +2,6 @@
 {-# LANGUAGE TypeFamilies #-}
 
 -- |
--- Module      :  Swarm.Game.Entity
--- Copyright   :  Brent Yorgey
--- Maintainer  :  byorgey@gmail.com
---
 -- SPDX-License-Identifier: BSD-3-Clause
 --
 -- An 'Entity' represents an object that exists in the world.  Each

diff --git a/src/Swarm/Game/Exception.hs b/src/Swarm/Game/Exception.hs
@@ -2,10 +2,6 @@
 {-# LANGUAGE OverloadedStrings #-}
 
 -- |
--- Module      :  Swarm.Game.Exception
--- Copyright   :  Brent Yorgey
--- Maintainer  :  byorgey@gmail.com
---
 -- SPDX-License-Identifier: BSD-3-Clause
 --
 -- Runtime exceptions for the Swarm language interpreter.

diff --git a/src/Swarm/Game/Failure.hs b/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

diff --git a/src/Swarm/Game/Failure/Render.hs b/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)

diff --git a/src/Swarm/Game/Location.hs b/src/Swarm/Game/Location.hs
@@ -4,10 +4,6 @@
 -- Orphan JSON instances for Location and Heading
 
 -- |
--- Module      :  Swarm.Game.Location
--- Copyright   :  Brent Yorgey
--- Maintainer  :  byorgey@gmail.com
---
 -- SPDX-License-Identifier: BSD-3-Clause
 --
 -- Locations and headings.

diff --git a/src/Swarm/Game/Log.hs b/src/Swarm/Game/Log.hs
@@ -2,10 +2,6 @@
 {-# LANGUAGE TemplateHaskell #-}
 
 -- |
--- Module      :  Swarm.Game.Log
--- Copyright   :  Ondřej Šebek
--- Maintainer  :  ondras98@icloud.com
---
 -- SPDX-License-Identifier: BSD-3-Clause
 --
 -- A data type to represent in-game logs by robots.

diff --git a/src/Swarm/Game/Recipe.hs b/src/Swarm/Game/Recipe.hs
@@ -2,10 +2,6 @@
 {-# LANGUAGE TemplateHaskell #-}
 
 -- |
--- Module      :  Swarm.Game.Recipe
--- Copyright   :  Brent Yorgey
--- Maintainer  :  byorgey@gmail.com
---
 -- SPDX-License-Identifier: BSD-3-Clause
 --
 -- A recipe represents some kind of process for transforming

diff --git a/src/Swarm/Game/ResourceLoading.hs b/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
 

diff --git a/src/Swarm/Game/Robot.hs b/src/Swarm/Game/Robot.hs
@@ -7,10 +7,6 @@
 {-# LANGUAGE ViewPatterns #-}
 
 -- |
--- Module      :  Swarm.Game.Robot
--- Copyright   :  Brent Yorgey
--- Maintainer  :  byorgey@gmail.com
---
 -- SPDX-License-Identifier: BSD-3-Clause
 --
 -- A data type to represent robots.

diff --git a/src/Swarm/Game/Scenario.hs b/src/Swarm/Game/Scenario.hs
@@ -6,10 +6,6 @@
 {-# LANGUAGE TemplateHaskell #-}
 
 -- |
--- Module      :  Swarm.Game.Scenario
--- Copyright   :  Brent Yorgey
--- Maintainer  :  byorgey@gmail.com
---
 -- SPDX-License-Identifier: BSD-3-Clause
 --
 -- Scenarios are standalone worlds with specific starting and winning

diff --git a/src/Swarm/Game/Scenario/Cell.hs b/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,

diff --git a/src/Swarm/Game/Scenario/Objective.hs b/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 ((<|>))

diff --git a/src/Swarm/Game/Scenario/Objective/Graph.hs b/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 ((&&&))

diff --git a/src/Swarm/Game/Scenario/Objective/Logic.hs b/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'.

diff --git a/src/Swarm/Game/Scenario/Objective/Validation.hs b/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)

diff --git a/src/Swarm/Game/Scenario/Objective/WinCheck.hs b/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

diff --git a/src/Swarm/Game/Scenario/RobotLookup.hs b/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, (<.>))

diff --git a/src/Swarm/Game/Scenario/Style.hs b/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

diff --git a/src/Swarm/Game/Scenario/WorldDescription.hs b/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

diff --git a/src/Swarm/Game/ScenarioInfo.hs b/src/Swarm/Game/ScenarioInfo.hs
@@ -5,10 +5,6 @@
 -- -Wno-orphans is for the Eq/Ord Time instances
 
 -- |
--- Module      :  Swarm.Game.ScenarioStatus
--- Copyright   :  Brent Yorgey
--- Maintainer  :  byorgey@gmail.com
---
 -- SPDX-License-Identifier: BSD-3-Clause
 --
 -- Saving and loading info about scenarios (status, path, etc.) as

diff --git a/src/Swarm/Game/State.hs b/src/Swarm/Game/State.hs
@@ -7,10 +7,6 @@
 {-# LANGUAGE ViewPatterns #-}
 
 -- |
--- Module      :  Swarm.Game.State
--- Copyright   :  Brent Yorgey
--- Maintainer  :  byorgey@gmail.com
---
 -- SPDX-License-Identifier: BSD-3-Clause
 --
 -- Definition of the record holding all the game-related state, and various related

diff --git a/src/Swarm/Game/Step.hs b/src/Swarm/Game/Step.hs
@@ -7,10 +7,6 @@
 {-# LANGUAGE ViewPatterns #-}
 
 -- |
--- Module      :  Swarm.Game.Step
--- Copyright   :  Brent Yorgey
--- Maintainer  :  byorgey@gmail.com
---
 -- SPDX-License-Identifier: BSD-3-Clause
 --
 -- Facilities for stepping the robot CESK machines, /i.e./ the actual

diff --git a/src/Swarm/Game/Terrain.hs b/src/Swarm/Game/Terrain.hs
@@ -1,10 +1,6 @@
 {-# LANGUAGE OverloadedStrings #-}
 
 -- |
--- Module      :  Swarm.Game.Terrain
--- Copyright   :  Brent Yorgey
--- Maintainer  :  byorgey@gmail.com
---
 -- SPDX-License-Identifier: BSD-3-Clause
 --
 -- Terrain types and properties.

diff --git a/src/Swarm/Game/World.hs b/src/Swarm/Game/World.hs
@@ -2,10 +2,6 @@
 {-# LANGUAGE TypeFamilies #-}
 
 -- |
--- Module      :  Swarm.Game.World
--- Copyright   :  Brent Yorgey
--- Maintainer  :  byorgey@gmail.com
---
 -- SPDX-License-Identifier: BSD-3-Clause
 --
 -- A /world/ refers to the grid on which the game takes place, and the

diff --git a/src/Swarm/Game/WorldGen.hs b/src/Swarm/Game/WorldGen.hs
@@ -2,10 +2,6 @@
 {-# LANGUAGE TypeApplications #-}
 
 -- |
--- Module      :  Swarm.Game.WorldGen
--- Copyright   :  Brent Yorgey
--- Maintainer  :  byorgey@gmail.com
---
 -- SPDX-License-Identifier: BSD-3-Clause
 --
 -- Procedural world generation via coherent noise.

diff --git a/src/Swarm/Language/Capability.hs b/src/Swarm/Language/Capability.hs
@@ -1,8 +1,4 @@
 -- |
--- Module      :  Swarm.Language.Capability
--- Copyright   :  Brent Yorgey
--- Maintainer  :  byorgey@gmail.com
---
 -- SPDX-License-Identifier: BSD-3-Clause
 --
 -- Capabilities needed to evaluate and execute programs.  Language

diff --git a/src/Swarm/Language/Context.hs b/src/Swarm/Language/Context.hs
@@ -1,10 +1,6 @@
 {-# LANGUAGE DeriveDataTypeable #-}
 
 -- |
--- Module      :  Swarm.Language.Context
--- Copyright   :  Brent Yorgey
--- Maintainer  :  byorgey@gmail.com
---
 -- SPDX-License-Identifier: BSD-3-Clause
 --
 -- Generic contexts (mappings from variables to other things, such as

diff --git a/src/Swarm/Language/Elaborate.hs b/src/Swarm/Language/Elaborate.hs
@@ -1,10 +1,6 @@
 {-# LANGUAGE OverloadedStrings #-}
 
 -- |
--- Module      :  Swarm.Language.Elaborate
--- Copyright   :  Brent Yorgey
--- Maintainer  :  byorgey@gmail.com
---
 -- SPDX-License-Identifier: BSD-3-Clause
 --
 -- Term elaboration which happens after type checking.