Merge pull request #66 from input-output-hk/coot/sublibraries

Use sublibraries

Author: coot

.github/workflows/github-page.yml

@@ -31,6 +31,9 @@ jobs:
       url: ${{ steps.deployment.outputs.page_url }}
 
     steps:
+    - name: Install pandoc
+      run: sudo apt install pandoc
+
     - name: Checkout ouroboros-network repository
       uses: actions/checkout@v4
 
@@ -54,9 +57,12 @@ jobs:
     - name: Build plan
       run: cabal build --dry-run --enable-tests all
 
+    - name: Run pandoc
+      run: pandoc --from=gfm --to=haddock --output=README.haddock README.md
+
     - name: Build Haddock documentation 🔧
       run: |
-        cabal haddock-project --hackage all
+        cabal haddock-project --prologue=README.haddock --hackage all
 
     - name: Upload artifacts
       uses: actions/upload-pages-artifact@v3

.github/workflows/haskell.yml

@@ -11,7 +11,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ghc: ["8.10", "9.2", "9.4", "9.6", "9.8", "9.10"]
+        ghc: ["9.6", "9.8", "9.10", "9.12"]
         os: [ubuntu-latest, macos-latest, windows-latest]
 
     env:
@@ -90,8 +90,8 @@ jobs:
     - name: Build projects [build]
       run: cabal build all
 
-    - name: typed-protocols-examples [test]
-      run: cabal run typed-protocols-examples:test
+    - name: typed-protocols:test
+      run: cabal run typed-protocols:test
 
     # - name: typed-protocols-doc [test]
     #   run: cabal test typed-protocols-doc

.gitignore

@@ -1 +1,2 @@
 dist-newstyle/
+README.haddock

.stylish-haskell.yaml

@@ -191,6 +191,25 @@ steps:
       # Default: false
       space_surround: false
 
+      # Post qualify option moves any qualifies found in import declarations
+      # to the end of the declaration. This also adjust padding for any
+      # unqualified import declarations.
+      #
+      # - true: Qualified as <module name> is moved to the end of the
+      #   declaration.
+      #
+      #   > import Data.Bar
+      #   > import Data.Foo qualified as F
+      #
+      # - false: Qualified remains in the default location and unqualified
+      #   imports are padded to align with qualified imports.
+      #
+      #   > import           Data.Bar
+      #   > import qualified Data.Foo as F
+      #
+      # Default: false
+      post_qualify: true
+
   # Language pragmas
   - language_pragmas:
       # We can generate different styles of language pragma lists.

README.md

@@ -8,20 +8,22 @@ typed-protocols
 
 A robust session type framework which supports [protocol pipelining][protocol-pipelining].
 
+Haddocks are published [here][haddocks].
+
 
 Public content
 --------------
 
-Duncan Coutts (@dcoutts) Haskell eXchange 2019 [talk][haskell-eXchange].
+[Duncan Coutts][dcoutts] Haskell eXchange 2019 [talk][haskell-eXchange].
 
-Monadic party workshop by Marcin Szamotulski (@coot):
+Monadic party workshop by Marcin Szamotulski ([coot]):
 * [part 1][monadic-party-part-1]
 * [part 2][monadic-party-part-2]
 * [part 2][monadic-party-part-3]
 
-Talk at [Haskell Love 2021][haskell-love] by Marcin Szamotulski (@coot), [slides][haskell-love-slides].
+Talk at [Haskell Love 2021][haskell-love] by Marcin Szamotulski ([coot]), [slides][haskell-love-slides].
 
-An [Agda][typed-protocols-agda] implementation by Marcin Szamotulski (@coot).
+An [Agda][typed-protocols-agda] implementation by Marcin Szamotulski ([coot]).
 
 
 [protocol-pipelining]: https://www.wikiwand.com/en/Protocol_pipelining
@@ -32,3 +34,6 @@ An [Agda][typed-protocols-agda] implementation by Marcin Szamotulski (@coot).
 [haskell-love-slides]: https://coot.me/posts/typed-protocols-at-haskell-love.html
 [haskell-love]: https://www.youtube.com/watch?v=EbK6VAqYh3g
 [typed-protocols-agda]: https://coot.me/agda/posts.agda.typed-protocols.html
+[coot]: https://github.com/coot
+[dcoutts]: https://github.com/dcoutts
+[haddocks]: https://input-output-hk.github.io/typed-protocols

cabal.project

@@ -1,10 +1,6 @@
 index-state:  2025-05-05T00:00:00Z
 
 packages: ./typed-protocols
-          ./typed-protocols-cborg
-          ./typed-protocols-stateful
-          ./typed-protocols-stateful-cborg
-          ./typed-protocols-examples
           ./typed-protocols-doc
 
 test-show-details: direct
@@ -17,3 +13,11 @@ if impl(ghc >= 9.12)
 if os(windows)
   package text
     flags: -simdutf
+
+source-repository-package
+  type: git
+  location: https://github.com/input-output-hk/io-sim
+  tag: aef112549bf85d51a03919008b6091af8933e9e2
+  --sha256: sha256-yfhBeAYwWktqBAkvXUVdrgBzNvTwAqMKglcjwflMtM4=
+  subdir: io-classes
+          io-sim

scripts/check-stylish.sh

@@ -5,6 +5,4 @@ export LC_ALL=C.UTF-8
 
 [[ -x '/usr/bin/fd' ]] && FD="fd" ||  FD="fdfind"
 
-$FD . './typed-protocols' -e hs -E Setup.hs -E Core.hs -X stylish-haskell -c .stylish-haskell.yaml -i
-$FD . './typed-protocols-cborg' -e hs -E Setup.hs -X stylish-haskell -c .stylish-haskell.yaml -i
-$FD . './typed-protocols-examples' -e hs -E Setup.hs -E Channel.hs -X stylish-haskell -c .stylish-haskell.yaml -i
+$FD . './typed-protocols' -e hs -E Setup.hs -E Core.hs -E Channel.hs -X stylish-haskell -c .stylish-haskell.yaml -i

typed-protocols-cborg/CHANGELOG.md

@@ -1,5 +1,3 @@
-{-# LANGUAGE FlexibleContexts #-}
-
 module Network.TypedProtocol.Documentation.DefaultMain
 where