fix: stale libs/ paths and misleading FFI comment#284
Merged
Conversation
- examples/external-libs/README.md: fix 5 broken `libs/` paths → `examples/external-libs/` (matching actual directory structure) - getting-started.mdx: fix misleading "Property tests (no FFI needed)" comment — all Property*.t.sol files use vm.ffi() to invoke solc and require FOUNDRY_PROFILE=difftest Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
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
2 participants
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.
Summary
libs/paths →examples/external-libs/(the actual directory where library files live)Property*.t.solfiles inheritYulTestBasewhich usesvm.ffi()to invokesolc, so they all requireFOUNDRY_PROFILE=difftestContext
The
libs/directory doesn't exist in the repo. External libraries live inexamples/external-libs/. Previous PRs (#280, #283) fixedlibs/paths inREADME.md,linking-libraries.mdx, and other docs, but theexamples/external-libs/README.mdquickstart guide was missed — this is the first file a developer opens when trying to use the linker feature.Test plan
check_doc_counts.pypasseslibs/paths inexamples/external-libs/README.mdupdated to match actual directory🤖 Generated with Claude Code
Note
Low Risk
Docs-only updates: adjusts test commands/comments around
vm.ffi()requirements and fixes broken example--linkpaths. Low risk since no runtime or compiler behavior changes.Overview
Updates the docs to remove misleading guidance about running tests without FFI: the getting started guide now treats
FOUNDRY_PROFILE=difftest forge testas the default for all tests, and provides a separate command to run unit tests only without FFI.Fixes stale
libs/references inexamples/external-libs/README.md, updating the quickstart and troubleshooting snippets to use the correctexamples/external-libs/*.yulpaths for--link.Written by Cursor Bugbot for commit 3dfa7d7. This will update automatically on new commits. Configure here.