Link TODOs to Issues (#514)

- replace `XXX` with `TODO: #<issue number>`

TODO has simply better editor support. The GitHub plugin will suggest creating an issue for TODO that does not have the issue number after it and some editors may even ask for confirmation when committing code with TODO.

.github/workflows/check_todos.yml

@@ -0,0 +1,24 @@
+name: Look for TODOs
+on:
+  push:
+    paths:
+      - '**.hs'
+    branches:
+      - main
+  pull_request:
+    paths:
+      - '**.hs'
+    branches:
+      - main
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - run: |
+          if grep --include \*.hs -riP '(TODO|FIXME|XXX):?\s' src 2>&1 | grep -vP '#\d+'; then
+              echo "Please add a link to Issue, for example: TODO: #123"
+              exit 1
+          else
+              echo "No TODOs without links found, all good!"
+          fi

src/Swarm/Game/Log.hs

@@ -14,7 +14,7 @@
 -- want to use special kinds of logs that will be
 -- shown to the player.
 --
--- TODO: Currently we abuse this system for system
+-- TODO: #1039 Currently we abuse this system for system
 -- logs, which is fun, but we should eventually make
 -- a dedicated `SystemLogEntry` type for 'RuntimeState'
 -- message queue.

src/Swarm/Language/Capability.hs

@@ -248,7 +248,7 @@ constCaps = \case
   Case -> Just CSum
   Fst -> Just CProd
   Snd -> Just CProd
-  -- XXX pair syntax should require CProd too
+  -- TODO: #563 pair syntax (1,2,3...) should require CProd too
 
   -- ----------------------------------------------------------------
   -- Some additional straightforward ones, which however currently
@@ -259,6 +259,6 @@ constCaps = \case
   Random -> Just CRandom -- randomness device (with bitcoins)?
   -- ----------------------------------------------------------------
   -- Some more constants which *ought* to have their own capability but
-  -- currently don't. TODO: #26
-  View -> Nothing -- XXX this should also require something.
+  -- currently don't.
+  View -> Nothing -- TODO: #17 should require equipping an antenna
   Knows -> Nothing

src/Swarm/Language/LSP.hs

@@ -70,7 +70,7 @@ validateSwarmCode :: J.NormalizedUri -> J.TextDocumentVersion -> Text -> LspM ()
 validateSwarmCode doc version content = do
   -- debug $ "Validating: " <> from (show doc) <> " ( " <> content <> ")"
 
-  -- FIXME With this call to flushDiagnosticsBySource in place, the warnings
+  -- FIXME: #1040 With this call to flushDiagnosticsBySource in place, the warnings
   -- in other buffers (editor tabs) end up getting cleared when switching between
   -- (focusing on) other buffers in VS Code.
   -- However, getting rid of this seems to break error highlighting.

src/Swarm/TUI/Controller.hs

@@ -582,8 +582,7 @@ updateAchievements = do
   -- Don't save to disk unless there was a change in the attainment list.
   let incrementalAchievements = wrappedGameAchievements `M.difference` oldMasterAchievementsList
   unless (null incrementalAchievements) $ do
-    -- TODO: This is where new achievements would be displayed in
-    -- a popup (see #916)
+    -- TODO: #916 This is where new achievements would be displayed in a popup
     newAchievements <- use $ uiState . uiAchievements
     liftIO $ saveAchievementsInfo $ M.elems newAchievements
 

src/Swarm/TUI/Model/StateUpdate.hs

@@ -94,7 +94,7 @@ startGameWithSeed userSeed siPair@(_scene, si) toRun = do
   gameState . scenarios . scenarioItemByPath p . _SISingle . _2 . scenarioStatus .= InProgress t 0 0
   scenarioToAppState siPair userSeed toRun
 
--- XXX do we need to keep an old entity map around???
+-- TODO: #516 do we need to keep an old entity map around???
 
 -- | Modify the 'AppState' appropriately when starting a new scenario.
 scenarioToAppState :: (MonadIO m, MonadState AppState m) => ScenarioInfoPair -> Maybe Seed -> Maybe CodeToRun -> m ()