Convert Doc v1 transcripts to v2 #5253
Draft
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Follow-up to unisonweb#5140.
…-force feat: add debug.alias.type.force
So my editor stops fixing things for me.
A bunch of small changes in TranscriptParser - remove dead code - don’t use `Show` for formatted output - put processed blocks in a separate sum type from unprocessed blocks - remove `Transcript` from identifiers (changed importers to use `qualified as Transcript`) - deduplicated some error reporting And one happy fix, IMO – got rid of the `Text.init` that plagued me in
- `Transcript` – the data model - `Transcript.Parser` – the parser and printer - `Transcript.Runner` – the runner There is unfortunately still some printing tightly coupled to the runner, but this makes it more obvious. Also, the runner is the only component tied to the CLI.
Mostly formatting, but also - removes Apple’s Cocoa from the dependencies, - moves some dependencies from `buildInputs` to `nativeBuildInputs`.
This tool manages the Unison cache, so it’s useful to provide in dev environments. Actually pushing to the cache requires a secret key.
required if compiling on systems that use eg libressl
this is more portable and ensures we can compile on systems without bash (eg *BSD)
…ix-systems Support native compilation on non-GNU Unix systems
With unisonweb#5142, Ormolu was upgraded from 0.5.2.0 to 0.7.2.0. This formats the codebase to avoid spurious formatting comingled in other commits. Almost all of the changes are simply wrapping single constraints in parens, like ```diff -hashBranch :: forall m. Monad m => Branch m -> m BranchHash +hashBranch :: forall m. (Monad m) => Branch m -> m BranchHash ``` There is also some reordering of language pragmas and imports, indentation correction (some of which gets precedence wrong), and switching some Haddock from `-- ^` to `-- |` .
Changing `(A x) => (B y) => x -> y` to `(A x, B y) => x -> y`.
This adds a .ormolu file to tell Ormolu what some operator precedences are, to improve indentation of multi-line operator sequences.
Remove reset-root, fix docs for reset
This does a very superficial conversion – it doesn’t correct all of the verbiage that describes how to do things in v1, just changes the actual syntax.
sellout
commented
Jul 24, 2024
|
|
||
| ```unison | ||
| escaping = [: Docs look [: like \@this \:] :] | ||
| escaping = {{ Docs look --doc open-- like --amphora--this --doc close-- }} |
There was a problem hiding this comment.
I wasn’t sure how to convert this bit – AFAICT, there’s no support for escaping characters in Doc v2?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This does a very superficial conversion – it doesn’t correct all of the verbiage that describes how to do things in v1, just changes the actual syntax.
It also merges in trunk, for the
ProjectPathchanges.