Sync with the latest Flaky template

.config/mustache.yaml

@@ -3,6 +3,6 @@
   "name":"yaya",
   "repo":"sellout/yaya",
   "summary":"Yet another … yet another recursion scheme library for Haskell",
-  "version":"0.1.0"},
+  "version":"0.1.0.0"},
   "type":{"name":"haskell"}
   }

.config/project/default.nix

@@ -1,4 +1,11 @@
-{config, flaky, lib, pkgs, self, ...}: {
+{
+  config,
+  flaky,
+  lib,
+  pkgs,
+  self,
+  ...
+}: {
   project = {
     name = "yaya";
     summary = "Yet another … yet another recursion scheme library for Haskell";
@@ -75,30 +82,56 @@
   ## CI
   services.garnix = {
     enable = true;
-    builds.exclude = [
-      # TODO: Remove once garnix-io/garnix#285 is fixed.
-      "homeConfigurations.x86_64-darwin-${config.project.name}-example"
-    ];
+    builds = {
+      exclude = [
+        # TODO: Remove once garnix-io/garnix#285 is fixed.
+        "homeConfigurations.x86_64-darwin-${config.project.name}-example"
+      ];
+      include = lib.mkForce (
+        [
+          "homeConfigurations.*"
+          "nixosConfigurations.*"
+        ]
+        ++ lib.concatLists (
+          flaky.lib.garnixChecks
+          (
+            sys:
+              [
+                "checks.${sys}.*"
+                "packages.${sys}.default"
+              ]
+              ++ lib.concatMap (ghc: [
+                "devShells.${sys}.${ghc}"
+                "packages.${sys}.${ghc}_all"
+              ])
+              (self.lib.testedGhcVersions sys)
+          )
+        )
+      );
+    };
   };
   ## FIXME: Shouldn’t need `mkForce` here (or to duplicate the base contexts).
   ##        Need to improve module merging.
   services.github.settings.branches.main.protection.required_status_checks.contexts =
     lib.mkForce
-      (map (ghc: "CI / build (${ghc}) (pull_request)") self.lib.nonNixTestedGhcVersions
-       ++ lib.concatLists (lib.concatMap flaky.lib.garnixChecks [
-          (sys: lib.concatMap (ghc: [
+    (map (ghc: "CI / build (${ghc}) (pull_request)") self.lib.nonNixTestedGhcVersions
+      ++ lib.concatLists (lib.concatMap flaky.lib.garnixChecks [
+        (sys:
+          lib.concatMap (ghc: [
             "devShell ${ghc} [${sys}]"
             "package ${ghc}_all [${sys}]"
           ])
-            (self.lib.testedGhcVersions sys))
-          (sys: [
-            "homeConfig ${sys}-${config.project.name}-example"
-            "package default [${sys}]"
-            ## FIXME: These are duplicated from the base config
-            "check formatter [${sys}]"
-            "devShell default [${sys}]"
-          ])
-       ]));
+          (self.lib.testedGhcVersions sys))
+        (sys: [
+          "homeConfig ${sys}-${config.project.name}-example"
+          "package default [${sys}]"
+          ## FIXME: These are duplicated from the base config
+          "check formatter [${sys}]"
+          "check project-manager-files [${sys}]"
+          "check vale [${sys}]"
+          "devShell default [${sys}]"
+        ])
+      ]));
 
   ## publishing
   services.flakehub.enable = true;

.config/project/github-ci.nix

@@ -1,4 +1,4 @@
-{lib, self, ...}: {
+{lib, pkgs, self, ...}: {
   services.github.workflow."build.yml".text = lib.generators.toYAML {} {
     name = "CI";
     on = {
@@ -11,10 +11,12 @@
     jobs.build = {
       strategy = {
         fail-fast = false;
-        matrix.os = ["macos-13" "ubuntu-22.04" "windows-2022"];
-        ## TODO: Populate this as the difference between supported versions and
-        ##       available nix package sets.
-        matrix.ghc = self.lib.nonNixTestedGhcVersions;
+        matrix = {
+          ## TODO: Populate this as the difference between supported versions
+          ##       and available nix package sets.
+          ghc = self.lib.nonNixTestedGhcVersions;
+          os = ["macos-13" "ubuntu-22.04" "windows-2022"];
+        };
       };
       runs-on = "\${{ matrix.os }}";
       env.CONFIG = "--enable-tests --enable-benchmarks";
@@ -25,7 +27,7 @@
           id = "setup-haskell-cabal";
           "with" = {
             ghc-version = "\${{ matrix.ghc }}";
-            cabal-version = "3.10";
+            cabal-version = pkgs.cabal-install.version;
           };
         }
         {run = "cabal v2-update";}
@@ -40,6 +42,9 @@
             key = "\${{ runner.os }}-\${{ matrix.ghc }}-\${{ hashFiles('cabal.project.freeze') }}";
           };
         }
+        ## NB: The `doctests` suites don’t seem to get built without explicitly
+        ##     doing so before running the tests.
+        {run = "cabal v2-build all $CONFIG";}
         {run = "cabal v2-test all $CONFIG";}
       ];
     };

README.md

@@ -2,7 +2,7 @@
 
 [![built with garnix](https://img.shields.io/endpoint?url=https%3A%2F%2Fgarnix.io%2Fapi%2Fbadges%2Fsellout%2Fyaya)](https://garnix.io)
 [![Packaging status](https://repology.org/badge/tiny-repos/haskell:yaya.svg)](https://repology.org/project/haskell:yaya/versions)
-[![latest packaged version(s)](https://repology.org/badge/latest-versions/haskell:yaya.svg)](https://repology.org/project/haskell:yaya/versions)
+[![latest packaged versions](https://repology.org/badge/latest-versions/haskell:yaya.svg)](https://repology.org/project/haskell:yaya/versions)
 
 Yet another … yet another recursion scheme library for Haskell
 
@@ -33,7 +33,7 @@ To mitigate some of those issues for versioning, we assume the following usage:
 
 - modules should be imported using `PackageImports`, so that adding modules is a _minor_ change;
 - modules should be imported qualified, so that adding definitions is a _minor_ change;
-- adding instances can't be mitigated in the same way, and it's not uncommon for downstream libraries to add orphans instances when they're omitted from upstream libraries. However, since these conflicts can only happen via direct dependencies, and represent an explicit downstream workaround, it's reasonable to expect a quick downstream update to remove or conditionalize the workaround. So, this is considered a _minor major_ change;
+- adding instances can't be mitigated in the same way, and it's not uncommon for downstream libraries to add orphans instances when they're omitted from upstream libraries. However, since these conflicts can only happen via direct dependencies, and represent an explicit downstream workaround, it’s reasonable to expect a quick downstream update to remove or conditionalize the workaround. So, this is considered a _minor major_ change;
 - deprecation is considered a _revision_ change, however it will often be paired with _minor_ changes. `-Werror` can cause this to fail, but published libraries shouldn't be compiled with `-Werror`.
 
 ## building & development

cabal.project

@@ -1,5 +1,6 @@
 program-options
-  ghc-options: -Werror
+  ghc-options:
+    -Werror
 
 tests: True
 

containers/Setup.hs

@@ -0,0 +1,14 @@
+-- __NB__: `custom-setup` doesn’t have any way to specify extensions, so any we
+--         want need to be specified here.
+{-# LANGUAGE PackageImports #-}
+{-# LANGUAGE Unsafe #-}
+{-# LANGUAGE NoImplicitPrelude #-}
+{-# OPTIONS_GHC -Wall #-}
+
+module Main (main) where
+
+import safe "base" System.IO (IO)
+import "cabal-doctest" Distribution.Extra.Doctest (defaultMainWithDoctests)
+
+main :: IO ()
+main = defaultMainWithDoctests "doctests"

containers/src/Yaya/Containers/Pattern/IntMap.hs

@@ -1,3 +1,4 @@
+{-# LANGUAGE Safe #-}
 {-# OPTIONS_GHC -Wno-orphans #-}
 
 module Yaya.Containers.Pattern.IntMap

containers/src/Yaya/Containers/Pattern/IntSet.hs

@@ -1,3 +1,4 @@
+{-# LANGUAGE Safe #-}
 {-# OPTIONS_GHC -Wno-orphans #-}
 
 module Yaya.Containers.Pattern.IntSet

containers/src/Yaya/Containers/Pattern/Map.hs

@@ -1,3 +1,4 @@
+{-# LANGUAGE Safe #-}
 {-# OPTIONS_GHC -Wno-orphans #-}
 
 module Yaya.Containers.Pattern.Map

containers/src/Yaya/Containers/Pattern/Set.hs

@@ -1,3 +1,4 @@
+{-# LANGUAGE Safe #-}
 {-# OPTIONS_GHC -Wno-orphans #-}
 
 module Yaya.Containers.Pattern.Set

containers/tests/doctests.hs

@@ -0,0 +1,10 @@
+module Main (main) where
+
+import "base" Data.Function (($))
+import "base" Data.Semigroup (Semigroup ((<>)))
+import "base" System.IO (IO)
+import "doctest" Test.DocTest (doctest)
+import "this" Build_doctests (flags, module_sources, pkgs)
+
+main :: IO ()
+main = doctest $ flags <> pkgs <> module_sources