Repository navigation
docs: add a chapter on locking effects - #342
Merged
Merged
Conversation
magnus-madsen
force-pushed
the
docs/effect-locking
branch
9 times, most recently
from
October 12, 2026 18:22
9d5d688 to
aff9c04
Compare
Adds src/locking-effects.md on the eff-lock and eff-check commands and the effects.lock file, lists it in SUMMARY.md, and points to the chapter from Trusting Dependencies and Versions and Upgrades. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
magnus-madsen
force-pushed
the
docs/effect-locking
branch
from
October 12, 2026 18:23
aff9c04 to
6cc99ef
Compare
This file contains hidden or 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
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.
Adds
src/locking-effects.mdunder Projects and Packages, between Trusting Dependencies and Publishing a Package. The book did not mention theeff-lockandeff-checkcommands or theeffects.lockfile.The chapter
eff-lock: the command, theeffects.lockfile it writes, and what it covers (every installed package, not the bundled library or our own code; nothing is locked if the project does not type check).eff-check: the clean report, the changed-signature warning and what to do about it, and that the command exits with status1on a change.packages.lockandeffects.lockdiffer, and why only the latter survives an upgrade.Other changes
SUMMARY.mdlists the chapter.trusting-dependencies.mdpoints to the chapter after the paragraph on reading signatures.versions-and-upgrades.mdnotes the second lock file after the section onpackages.lock.Verification
flix/museum-giftshop2.0.2. Flix 0.78.0 prints the same output for every command, but writes the package id into eacheffects.lockkey, so the excerpt matches master rather than 0.78.0.Unit -> Unit \ IO, and museum 3.0.1 → 3.0.2 → 4.0.0 all check clean), so the warning transcript was produced by altering one hash in the lock file. The prose frames it as a hypothetical (locked pure, nowIO) so that the printeddef buyGift(): Unit \ IOis what the tool prints.eff-checkexits1on a change and0otherwise; both commands refuse to run withoutflix.toml.mdbook buildsucceeds and all links on the new page resolve.The
effects.lockexcerpt uses the key spelling introduced by flix/flix#13500, which is not in 0.78.0.🤖 Generated with Claude Code