Skip to content

Commit

Permalink
reshuffle pandoc dependency
Browse files Browse the repository at this point in the history
  • Loading branch information
kostmo committed Jul 29, 2024
1 parent 73bf4a9 commit df300ee
Show file tree
Hide file tree
Showing 9 changed files with 4,208 additions and 8 deletions.
1 change: 1 addition & 0 deletions app/doc/Main.hs
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ cliParser =
, command "editors" (info (EditorKeywords <$> editor <**> helper) $ progDesc "Output editor keywords")
, command "keys" (info (pure SpecialKeyNames) $ progDesc "Output list of recognized special key names")
, command "cheatsheet" (info (CheatSheet <$> address <*> cheatsheet <**> helper) $ progDesc "Output nice Wiki tables")
, command "commands" (info (pure CommandsData <**> helper) $ progDesc "Output JSON data for commands matrix")
, command "pedagogy" (info (pure TutorialCoverage) $ progDesc "Output tutorial coverage")
]
where
Expand Down
6 changes: 6 additions & 0 deletions scripts/gen/commands-matrix-data.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
#!/bin/bash -e

SCRIPT_DIR=$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )
cd $SCRIPT_DIR/../..

cabal run -j -O0 -- swarm-docs commands | jq . > web/data/commands.json
6 changes: 6 additions & 0 deletions src/swarm-doc/Swarm/Doc/Gen.hs
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ module Swarm.Doc.Gen (

import Control.Lens (view, (^.))
import Control.Monad (zipWithM, zipWithM_)
import Data.Aeson.Text (encodeToLazyText)
import Data.Containers.ListUtils (nubOrd)
import Data.Foldable (toList)
import Data.List qualified as List
Expand All @@ -36,7 +37,9 @@ import Data.Set qualified as Set
import Data.Text (Text, unpack)
import Data.Text qualified as T
import Data.Text.IO qualified as T
import Data.Text.Lazy.IO qualified as TL
import Data.Tuple (swap)
import Swarm.Doc.Command (getCatalog)
import Swarm.Doc.Keyword
import Swarm.Doc.Pedagogy
import Swarm.Doc.Util
Expand Down Expand Up @@ -73,6 +76,8 @@ data GenerateDocs where
SpecialKeyNames :: GenerateDocs
-- | Cheat sheets for inclusion on the Swarm wiki.
CheatSheet :: PageAddress -> SheetType -> GenerateDocs
-- | JSON representation of commands metadata matrix
CommandsData :: GenerateDocs
-- | List command introductions by tutorial
TutorialCoverage :: GenerateDocs
deriving (Eq, Show)
Expand All @@ -94,6 +99,7 @@ generateDocs = \case
mapM_ editorGen enumerate
SpecialKeyNames -> generateSpecialKeyNames
CheatSheet address s -> makeWikiPage address s
CommandsData -> TL.putStrLn $ encodeToLazyText getCatalog
TutorialCoverage -> renderTutorialProgression >>= putStrLn . T.unpack

-- ----------------------------------------------------------------------------
Expand Down
6 changes: 0 additions & 6 deletions src/swarm-web/Swarm/Web.hs
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,6 @@ import Servant
import Servant.Docs (ToCapture)
import Servant.Docs qualified as SD
import Servant.Docs.Internal qualified as SD (renderCurlBasePath)
import Swarm.Doc.Command
import Swarm.Game.Entity (EntityName, entityName)
import Swarm.Game.Robot
import Swarm.Game.Scenario.Objective
Expand Down Expand Up @@ -110,7 +109,6 @@ type SwarmAPI =
:<|> "code" :> "render" :> ReqBody '[PlainText] T.Text :> Post '[PlainText] T.Text
:<|> "code" :> "run" :> ReqBody '[PlainText] T.Text :> Post '[PlainText] T.Text
:<|> "paths" :> "log" :> Get '[JSON] (RingBuffer CacheLogEntry)
:<|> "commands" :> Get '[JSON] CommandCatalog
:<|> "repl" :> "history" :> "full" :> Get '[JSON] [REPLHistItem]
:<|> "map" :> Capture "size" AreaDimensions :> Get '[JSON] GridResponse

Expand Down Expand Up @@ -166,7 +164,6 @@ mkApp state events =
:<|> codeRenderHandler
:<|> codeRunHandler events
:<|> pathsLogHandler state
:<|> cmdMatrixHandler state
:<|> replHistHandler state
:<|> mapViewHandler state

Expand Down Expand Up @@ -246,9 +243,6 @@ pathsLogHandler appStateRef = do
appState <- liftIO (readIORef appStateRef)
pure $ appState ^. gameState . pathCaching . pathCachingLog

cmdMatrixHandler :: ReadableIORef AppState -> Handler CommandCatalog
cmdMatrixHandler _ = pure getCatalog

replHistHandler :: ReadableIORef AppState -> Handler [REPLHistItem]
replHistHandler appStateRef = do
appState <- liftIO (readIORef appStateRef)
Expand Down
1 change: 0 additions & 1 deletion swarm.cabal
Original file line number Diff line number Diff line change
Expand Up @@ -499,7 +499,6 @@ library swarm-web
witch,

build-depends:
swarm:swarm-doc,
swarm:swarm-engine,
swarm:swarm-lang,
swarm:swarm-scenario,
Expand Down
4 changes: 4 additions & 0 deletions web/data/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
Regenerate this data with:
```
scripts/gen/commands-matrix-data.sh
```
Loading

0 comments on commit df300ee

Please sign in to comment.