Refactor: move pretty-printing and failure code to swarm-util
#2155
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
Generic pretty-printing infrastructure (`PrettyPrec` class, various utility functions, etc.) can move to `-util` so we can use it anywhere, for pretty-printing anything. All the specific instances are to be distributed so they live right next to the definitions of the associated data types.
Co-authored-by: Restyled.io <commits@restyled.io>
byorgey
force-pushed
the
refactor/move-failure
branch
from
0cff520
to
7e1c67b
Compare
Co-authored-by: Restyled.io <commits@restyled.io>
xsebek
approved these changes
Sep 28, 2024
That reminds me, I haven't looked at the Haddocks in a long time, probably worth a pass at some point to make sure things are still well-explained, and putting more prominent links to the built Haddock documentation in our materials about "how to contribute". |
byorgey
added a commit
that referenced
this pull request
Sep 30, 2024
Now that failure stuff has been moved into `swarm-util` as of #2155.
mergify bot
pushed a commit
that referenced
this pull request
Sep 30, 2024
Now that `Failure` is moved to `swarm-util` (#2155), that was the last remaining dependency of `Swarm.Game.ResourceLoading` which prevented it from moving as well. The `ResourceLoading` code is not specific to Swarm scenarios; this PR moves it to `swarm-util` to make it more generally applicable. In fact, the `ResourceLoading` code is already being used to load `.sw` files when executing the `Run` command; in order to implement #495 we will need to do that loading in order to resolve `import` expressions, but that code will live in `swarm-lang`, which cannot import `swarm-scenario`.
byorgey
added a commit
that referenced
this pull request
Sep 30, 2024
Now that failure stuff has been moved into `swarm-util` as of #2155.
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.
Swarm.Language.Pretty(in theswarm-langpackage) had a bunch of generic pretty-printing infrastructure along with a bunch of specific instances for terms and related things. However, the generic pretty-printing code infrastructure is not specific to swarm-lang. This PR:Swarm.Prettyinswarm-utilto make it more generally applicable.PrettyPrecinstances to live next to the declarations of the corresponding data types.In addition,
Swarm.Game.Failure(in theswarm-scenariopackage) also had no dependencies on anything else inswarm-scenario, so this PR also moves it toSwarm.Failureinswarm-util, to make it more generally applicable.Along the way I also removed
DelayTypeandPrecsince they are no longer being used.