Convert Doc v1 transcripts to v2

.github/workflows/bundle-ucm.yaml

@@ -39,6 +39,8 @@ jobs:
 
       - name: install stack
         uses: unisonweb/actions/stack/install@main
+        with:
+          stack-version: 2.15.5
 
       - name: build
         run: |

.github/workflows/ci.md

@@ -6,23 +6,8 @@ At a high level, the CI process is:
 3. On all platforms, build the `unison-runtime` Racket program save the resulting binaries as build artifacts.
 
 ### `env` vars at the top of `CI.yaml`:
-Some version numbers that are used during CI:
-- `ormolu_version: "0.5.0.1"`
-- `racket_version: "8.7"`
-- `jit_version: "@unison/internal/releases/0.0.17"`
-
-Some cached directories:
-  - `ucm_local_bin` a temp path for caching a built `ucm`
-  - `jit_src_scheme` a temp path for caching generated jit sources
-  - `unison-jit-dist`
-  - `base-codebase` a codebase path for caching a codebase generated by `unison-src/builtin-tests/base.md`
-  - `unison_src_test_results` a temp path for caching the result of passing tests that depend on `unison-src/`, which includes:
-    - `round-trip-tests`
-    - `transcripts`
-    - `unison-src/builtin-tests/interpreter-tests.md`
 
-`jit_generator_os: ubuntu-20.04`
-  - afaik, the jit sources are generated in a platform-independent way, so we just choose one platform to generate them on.
+These variables pin some dependency versions, set up some directories to cache, etc. Please see the `env` section in [ci.yaml](./ci.yaml) for specifics.
 
 ### Cached directories:
 

.github/workflows/ci.yaml

@@ -12,19 +12,26 @@ on:
   workflow_dispatch:
 
 env:
-  ormolu_version: 0.5.2.0
+  ## Some version numbers that are used during CI
+  ormolu_version: 0.7.2.0
+  jit_version: "@unison/internal/releases/0.0.18"
+  runtime_tests_version: "@unison/runtime-tests/main"
+
+  ## Some cached directories
+  # a temp path for caching a built `ucm`
   ucm_local_bin: ucm-local-bin
-  jit_version: "@unison/internal/releases/0.0.17"
+  # a temp path for caching generated jit sources
   jit_src_scheme: unison-jit-src/scheme-libs/racket
   jit_dist: unison-jit-dist
-  jit_generator_os: ubuntu-20.04
-  runtime_tests_version: "@unison/runtime-tests/main"
+  # a codebase path for caching a codebase generated by `unison-src/builtin-tests/interpreter-tests.md`
   runtime_tests_codebase: "~/.cache/unisonlanguage/runtime-tests.unison"
-
   # locations of some files that will indicate whether we need to re-run certain steps
   transcript_test_results: transcript-test-results
   interpreter_test_results: interpreter-test-results
 
+  ## afaik, the jit sources are generated in a platform-independent way, so we choose one platform to generate them on.
+  jit_generator_os: ubuntu-20.04
+
 jobs:
   ormolu:
     runs-on: ubuntu-20.04
@@ -102,6 +109,8 @@ jobs:
       - name: install stack
         if: steps.cache-ucm-binaries.outputs.cache-hit != 'true'
         uses: unisonweb/actions/stack/install@main
+        with:
+          stack-version: 2.15.5
 
       # Build deps, then build local code. Splitting it into two steps just allows us to see how much time each step
       # takes.
@@ -264,6 +273,14 @@ jobs:
           ${{env.transcripts}}
           # Fail if any transcripts cause git diffs.
           git diff --ignore-cr-at-eol --exit-code unison-src/transcripts
+      - name: docs.to-html
+        if: steps.cache-transcript-test-results.outputs.cache-hit != 'true'
+        run: |
+          ${{env.ucm}} transcript unison-src/transcripts-manual/docs.to-html.md
+          # Fail if the output or generated docs differ.
+          git diff --ignore-cr-at-eol --exit-code \
+            unison-src/transcripts-manual/docs.to-html.output.md \
+            unison-src/transcripts-manual/docs.to-html
       - name: mark transcripts as passing
         if: steps.cache-transcript-test-results.outputs.cache-hit != 'true'
         run: |
@@ -411,7 +428,7 @@ jobs:
   build-jit-binary:
     name: build jit binary
     needs: generate-jit-source
-    uses: ./.github/workflows/ci-build-jit-binary.yaml    
+    uses: ./.github/workflows/ci-build-jit-binary.yaml
 
   test-jit:
     name: test jit

.github/workflows/haddocks.yaml

@@ -27,6 +27,8 @@ jobs:
 
       - name: install stack
         uses: unisonweb/actions/stack/install@main
+        with:
+          stack-version: 2.15.5
 
       - name: build with haddocks
         working-directory: unison

.github/workflows/nix-dev-cache.yaml

@@ -37,4 +37,4 @@ jobs:
         name: unison
         authToken: '${{ secrets.CACHIX_AUTH_TOKEN }}'
     - name: build all packages and development shells
-      run: nix -L build --accept-flake-config --no-link --keep-going '.#build-tools'
+      run: nix -L build --accept-flake-config --no-link --keep-going '.#all'

.github/workflows/update-transcripts.yaml

@@ -22,6 +22,8 @@ jobs:
 
       - name: install stack
         uses: unisonweb/actions/stack/install@main
+        with:
+          stack-version: 2.15.5
 
       # One of the transcripts fails if the user's git name hasn't been set.
       - name: set git user info
@@ -36,6 +38,9 @@ jobs:
           stack exec unison transcript unison-src/transcripts-manual/rewrites.md
       - name: transcripts
         run: stack exec transcripts
+      - name: docs.to-html
+        run: |
+          stack exec unison transcript unison-src/transcripts-manual/docs.to-html.md
       - name: save transcript changes
         uses: stefanzweifel/git-auto-commit-action@v5
         with:

.gitignore

@@ -1,9 +1,14 @@
 # Unison
 .unison*
 test-output
-transcript-*
-scratch.u
 unisonLocal.zip
+*.uc
+# Ignore all scratch files...
+*.u
+# Except those in unison-src
+!unison-src/**/*.u
+# And integration tests
+!unison-cli-integration/integration-tests/IntegrationTests/**/*.u
 
 # Auto-generated
 jit-tests.md
@@ -19,6 +24,7 @@ dist-newstyle
 # GHC
 *.hie
 *.prof
+*.prof.html
 /.direnv/
 /.envrc
 

.ormolu

@@ -0,0 +1,4 @@
+infixl 8 ^?
+infixr 4 %%~, %~
+infixl 3 <|>
+infixl 1 &, <&>

.vscode/settings.json

@@ -0,0 +1,7 @@
+{
+  "haskell.toolchain": {
+    "cabal": "3.10.3.0",
+    "hls": "2.8.0.0",
+    "stack": "2.15.7"
+  }
+}

codebase2/codebase-sqlite-hashing-v2/src/U/Codebase/Branch/Hashing.hs

@@ -10,7 +10,7 @@ import U.Codebase.HashTags
 import Unison.Hashing.V2 qualified as Hashing
 import Unison.Hashing.V2.Convert2 (convertBranchV3, v2ToH2Branch)
 
-hashBranch :: forall m. Monad m => Branch m -> m BranchHash
+hashBranch :: forall m. (Monad m) => Branch m -> m BranchHash
 hashBranch branch =
   BranchHash . Hashing.contentHash <$> v2ToH2Branch branch
 

codebase2/codebase-sqlite-hashing-v2/src/Unison/Hashing/V2/Convert2.hs

@@ -100,7 +100,7 @@ v2ToH2Referent = \case
   V2Referent.Ref r -> H2.ReferentRef (v2ToH2Reference r)
   V2Referent.Con r cid -> H2.ReferentCon (v2ToH2Reference r) cid
 
-v2ToH2Branch :: Monad m => V2.Branch m -> m H2.Branch
+v2ToH2Branch :: (Monad m) => V2.Branch m -> m H2.Branch
 v2ToH2Branch V2.Branch {terms, types, patches, children} = do
   hterms <-
     traverse sequenceA terms
@@ -166,7 +166,7 @@ hashPatchFormatToH2Patch Memory.PatchFull.Patch {termEdits, typeEdits} =
       V2Referent.Con typeRef conId -> do
         (H2.ReferentCon (v2ToH2Reference $ second unComponentHash typeRef) conId)
 
-v2ToH2Term :: forall v. Ord v => V2.Term.HashableTerm v -> H2.Term v ()
+v2ToH2Term :: forall v. (Ord v) => V2.Term.HashableTerm v -> H2.Term v ()
 v2ToH2Term = ABT.transform convertF
   where
     convertF :: V2.Term.F' Text V2.Term.HashableTermRef V2.Term.TypeRef V2.Term.HashableTermLink V2.Term.TypeLink v a1 -> H2.TermF v () () a1

codebase2/codebase-sqlite/U/Codebase/Sqlite/Decode.hs

@@ -173,7 +173,7 @@ decodeWatchResultFormat =
 ------------------------------------------------------------------------------------------------------------------------
 -- unsyncs
 
-unsyncTermComponent :: HasCallStack => TermFormat.SyncLocallyIndexedComponent' t d -> Either DecodeError (TermFormat.LocallyIndexedComponent' t d)
+unsyncTermComponent :: (HasCallStack) => TermFormat.SyncLocallyIndexedComponent' t d -> Either DecodeError (TermFormat.LocallyIndexedComponent' t d)
 unsyncTermComponent (TermFormat.SyncLocallyIndexedComponent terms) = do
   let phi (localIds, bs) = do
         (a, b) <- decodeSyncTermAndType bs

codebase2/codebase-sqlite/U/Codebase/Sqlite/HashHandle.hs

@@ -39,7 +39,7 @@ data HashHandle = HashHandle
     toReferenceDecl :: Hash -> C.Type.TypeD Symbol -> C.Reference,
     -- | Hash decl's mentions
     toReferenceDeclMentions :: Hash -> C.Type.TypeD Symbol -> Set C.Reference,
-    hashBranch :: forall m. Monad m => Branch m -> m BranchHash,
+    hashBranch :: forall m. (Monad m) => Branch m -> m BranchHash,
     hashBranchV3 :: forall m. BranchV3 m -> BranchHash,
     hashCausal ::
       -- The causal's namespace hash

codebase2/codebase-sqlite/U/Codebase/Sqlite/LocalIds.hs

@@ -15,7 +15,7 @@ data LocalIds' t h = LocalIds
   { textLookup :: Vector t,
     defnLookup :: Vector h
   }
-  deriving (Show)
+  deriving (Functor, Show)
 
 type LocalIds = LocalIds' TextId ObjectId
 

codebase2/codebase-sqlite/U/Codebase/Sqlite/LocalizeObject.hs

@@ -109,23 +109,23 @@ localizePatchG (Patch termEdits typeEdits) =
 -- General-purpose localization
 
 -- Contains references to branch objects.
-class Ord c => ContainsBranches c s where
+class (Ord c) => ContainsBranches c s where
   branches_ :: Lens' s (Map c LocalBranchChildId)
 
 -- Contains references to definition objects i.e. term/decl component objects.
-class Ord d => ContainsDefns d s where
+class (Ord d) => ContainsDefns d s where
   defns_ :: Lens' s (Map d LocalDefnId)
 
 -- Contains references to objects by their hash.
-class Ord h => ContainsHashes h s where
+class (Ord h) => ContainsHashes h s where
   hashes_ :: Lens' s (Map h LocalHashId)
 
 -- Contains references to patch objects.
-class Ord p => ContainsPatches p s where
+class (Ord p) => ContainsPatches p s where
   patches_ :: Lens' s (Map p LocalPatchObjectId)
 
 -- Contains text.
-class Ord t => ContainsText t s where
+class (Ord t) => ContainsText t s where
   texts_ :: Lens' s (Map t LocalTextId)
 
 -- The inner state of the localization of a branch object.
@@ -137,16 +137,16 @@ data LocalizeBranchState t d p c = LocalizeBranchState
   }
   deriving (Show, Generic)
 
-instance Ord t => ContainsText t (LocalizeBranchState t d p c) where
+instance (Ord t) => ContainsText t (LocalizeBranchState t d p c) where
   texts_ = field @"texts"
 
-instance Ord d => ContainsDefns d (LocalizeBranchState t d p c) where
+instance (Ord d) => ContainsDefns d (LocalizeBranchState t d p c) where
   defns_ = field @"defns"
 
-instance Ord p => ContainsPatches p (LocalizeBranchState t d p c) where
+instance (Ord p) => ContainsPatches p (LocalizeBranchState t d p c) where
   patches_ = field @"patches"
 
-instance Ord c => ContainsBranches c (LocalizeBranchState t d p c) where
+instance (Ord c) => ContainsBranches c (LocalizeBranchState t d p c) where
   branches_ = field @"branches"
 
 -- | Run a computation that localizes a branch object, returning the local ids recorded within.
@@ -171,13 +171,13 @@ data LocalizePatchState t h d = LocalizePatchState
   }
   deriving (Show, Generic)
 
-instance Ord t => ContainsText t (LocalizePatchState t h d) where
+instance (Ord t) => ContainsText t (LocalizePatchState t h d) where
   texts_ = field @"texts"
 
-instance Ord h => ContainsHashes h (LocalizePatchState t h d) where
+instance (Ord h) => ContainsHashes h (LocalizePatchState t h d) where
   hashes_ = field @"hashes"
 
-instance Ord d => ContainsDefns d (LocalizePatchState t h d) where
+instance (Ord d) => ContainsDefns d (LocalizePatchState t h d) where
   defns_ = field @"defns"
 
 -- Run a computation that localizes a patch object, returning the local ids recorded within.

codebase2/codebase-sqlite/U/Codebase/Sqlite/NamedRef.hs

@@ -58,7 +58,7 @@ instance (FromRow ref) => FromRow (NamedRef ref) where
 newtype ScopedRow ref
   = ScopedRow (NamedRef ref)
 
-instance ToRow ref => ToRow (ScopedRow ref) where
+instance (ToRow ref) => ToRow (ScopedRow ref) where
   toRow (ScopedRow (NamedRef {reversedSegments = revSegments, ref})) =
     SQLText reversedName : SQLText namespace : SQLText lastNameSegment : toRow ref
     where