Convert Doc v1 transcripts to v2 #5253

…-force feat: add debug.alias.type.force

…force

….force

…force

…erm.force

…ranscripts Use projects in transcripts

This `only-tools-nixpkgs` devShell generally paralleled the `cabal-only-tools` devShell, but avoiding haskell.nix. While I’m not a huge fan of haskell.nix, this just created duplication and gave us a shell with a somewhat different environment than the one used by `nix build`, etc. It also didn’t work for everyone. In removing that shell, it also sets the default devShell to be `cabal-only-tools`, which some people were already using to work around issues with the previous default.

There are various benefits to using a Nixpkgs release - more likely that things are cached - easier to update the input without breaking everything This also renames a lot of things in the flake: - `nixpkgs-unstable` to `nixpkgs-release` – partially because it’s not unstable any more, but also because both it and the nixpkgs from haskell.nix unstable, so it didn’t really clarify anything - `nixpkgs` to `nixpkgs-haskellNix` – to make it clear where it comes from - `unstable` to `release-pkgs` – the convention is to use `pkgs` for derivation attrsets, and the source switched from unstable to release - `nixpkgs-packages` to `tool-pkgs` – this holds our build tools, so that seemed clearer than “nixpkgs”

Overlays are for derivations, and this isn’t one. Putting it in an overlay also just gives us more levels of indirection to dig through to figure out where things are coming from.

`cabal-local` no longer triggers rebuilds of GHC, so now we can use the devShell that provides the same environment as our build.

This means those environments will also be cached in CI.

Bumped some versions around, but they’re negotiable. - ormolu 0.5.2.0 → 0.7.2.0 - hls 2.9.0.0 → 2.8.0.0 - stack 2.15.5 → 2.15.7

…rge-transcripts

…s" use case

…scripts

Maybe some duplication/conflicts here unintentionally. The big transcript is just a WIP, we could make it prettier.

to avoid a potential cycle between CommandLine.hs and InputPatterns.hs that otherwise came up on another branch. InputPatterns.hs also has formatting helpers that could be used in CommandLine.hs. Maybe they should be moved too, but I haven't thought about it.

- don’t add an extra indent level to the entire output - do add a `warnCallout` to the message - don’t re-wrap formatted error output - remove the accidentally-included entire `help <command>` output

- remove `warnCallout` and `warn` from individual messages - make sure no error messages return their `help` content - add some documentation about how to write failure messages

It was leaving out spaces between literal text and generated text.

…essages

This silpped by in the merge.

Another one missed in the merge.

…pers

…etion

…pers

…etection

…etection Unused binding detection cleanup

`numerals` doesn't seem to be maintained anymore, however

also adds a debug.synhash.term command for debugging

Co-authored-by: Greg Pfeil <[email protected]>

This also has the flake get its version pins (when possible) from the VS Code settings. And we pin Cabal now, too.

Use `SyntaxText.Unit` as style for `foo()`

…precondition-violations

We don’t need a very rich parser for transcripts, but we _do_ need to reliably identify fenced code blocks, and that implies a number of subtle cases. Using a polished CommonMark parser/printer handles those subtleties for us. I chose `cmark` for a few reasons: - it’s a wrapper around `libcmark`, which is the reference implementation of CommonMark, so it should be correct; - it provides both a parser and a printer (unlike MMark); and - it is extremely fast (about 20x faster than MMark), so the fact that our home-rolled parser got to skip over everything that’s not a block isn’t an issue.). This only _partially_ uses the `cmark` printer. I think it should use it entirely, but for the cases where we do streaming output (processing UCM commands, etc.) it’s a more involved change. So I think it should be handled separately.

`cmark`’s pretty-printer matches our output pretty well, with a few differences: - it puts a space between the fence and the info string for in code blocks; - it prefers `-` over `*` for bulleted lists (as do I) and it indents them; - it `\`-escapes certain chars very conservatively; - it prefers indented/unfenced code blocks if there is no info string; and - it prefers `*` over `_` (unlike any sane person). This also shows how the change fixes a number of issues: - fix2158-1.output.md also illustrates how this change fixes unisonweb#1809; - alias-many.output.md and input-parse-errors.output.md show how fenced code blocks without an info string would use the beginning of the content as the info string; - transcripts-round-trip/main.output.md shows how output blocks for generated `unison` stanzas (which could contain nested fenced blocks) might not have long-enough fences; and - error-messages.output.md and generic-parse-errors.output.md show how Unison errors were reported on the wrong line number (and thus the printed error lines were also incorrect).

This is for consistency with the `cmark` style. Now the blocks we still pretty-print ourselves will match the bulk of them that `cmark` produces.

These weren’t errors in any way, but the `cmark`-produced outputs made it clear that some of our transcripts weren’t formatted the way we intended.

This shows that this change fixes unisonweb#1421, unisonweb#2826, unisonweb#5141, and unisonweb#5168.

They were missing trailing newlines, so as you can see in the diff, some transcripts had invalid output.

These aren‘t run as part of ./scripts/check.sh, so they got missed in the initial pass.

# Conflicts: # unison-cli-integration/integration-tests/IntegrationTests/transcript.output.md # unison-src/transcripts-round-trip/main.output.md # unison-src/transcripts/add-run.output.md # unison-src/transcripts/bug-strange-closure.output.md # unison-src/transcripts/cycle-update-5.output.md # unison-src/transcripts/delete.output.md # unison-src/transcripts/diff-namespace.output.md # unison-src/transcripts/move-namespace.output.md # unison-src/transcripts/name-selection.output.md # unison-src/transcripts/names.output.md # unison-src/transcripts/namespace-dependencies.output.md # unison-src/transcripts/propagate.output.md # unison-src/transcripts/reflog.output.md # unison-src/transcripts/reset.output.md # unison-src/transcripts/tab-completion.output.md # unison-src/transcripts/transcript-parser-commands.output.md

Project Roots

E.G. print <Promise> instead of <Foreign>

Use builtin reference names in foreign decompiling

…ng-locs

…ry-2

…tion

Reviewing the last merge into unisonweb#5142, I noticed some duplicated and out- of-date information. This brings things up-to-date and slightly reduces the duplication. - bumped Ormolu used by ci.yaml from 0.5.2.0 to 0.7.2.0, to match flake.nix - removed Markdown that claimed ci.yaml was using Ormolu 0.5.0.1 - moved description from `base-codebase` in Markdown to comment on `runtime_tests_codebase` in ci.yaml (and updated it to refer to builtin-tests/interpreter-tests.md instead of builtin-tests/base.md) - removed `unison_src_test_results` as it’s no longer managed as a single variable - moved other comments from Markdown to ci.yaml - added Markdown recommending to look in ci.yaml for specifics - rearranges the order of vars in ci.yaml to match the order they were presented in Markdown One thing I wasn’t sure how to map over: Markdown claims Racket 8.7 is used in CI, but ci.yaml doesn’t mention any Racket version.

We use a specific version of Stack, we don’t want Stack complaining to contributors that it doesn’t happen to be the latest.

We intentionally disable Stack’s Nix integration when it’s run from a Nix shell. We don’t want Stack complaining that we should enable it since it found `nix` on the path.

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.

…rser

Remove reset-root, fix docs for reset

…d-doc-support

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.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Convert Doc v1 transcripts to v2 #5253

Convert Doc v1 transcripts to v2 #5253

Commits on Jun 27, 2024

Commits on Jun 28, 2024

Commits on Jul 1, 2024

Commits on Jul 2, 2024

Commits on Jul 3, 2024

Commits on Jul 5, 2024

Commits on Jul 6, 2024

Commits on Jul 8, 2024

Commits on Jul 9, 2024

Commits on Jul 10, 2024

Commits on Jul 11, 2024

Commits on Jul 12, 2024

Commits on Jul 13, 2024

Commits on Jul 15, 2024

Commits on Jul 16, 2024

Commits on Jul 17, 2024

Commits on Jul 18, 2024

Commits on Jul 19, 2024

Commits on Jul 22, 2024

Commits on Jul 24, 2024

Convert Doc v1 transcripts to v2 #5253

Are you sure you want to change the base?

Convert Doc v1 transcripts to v2 #5253

Commits on Jun 27, 2024

Commits on Jun 28, 2024

Commits on Jul 1, 2024

Commits on Jul 2, 2024

Commits on Jul 3, 2024

Commits on Jul 5, 2024

Commits on Jul 6, 2024

Commits on Jul 8, 2024

Commits on Jul 9, 2024

Commits on Jul 10, 2024

Commits on Jul 11, 2024

Commits on Jul 12, 2024

Commits on Jul 13, 2024

Commits on Jul 15, 2024

Commits on Jul 16, 2024

Commits on Jul 17, 2024

Commits on Jul 18, 2024

Commits on Jul 19, 2024

Commits on Jul 22, 2024

Commits on Jul 24, 2024