docs: document segment matching and the declared-scope override for bugpocer - #30
Open
Tennis-Ball wants to merge 4 commits into
Open
Tennis-Ball wants to merge 4 commits into
Tennis-Ball wants to merge 4 commits into
Conversation
…ugpocer Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01UoyuskDHEjWMk1FmiX7A8o
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.
Why
The "Default ignore list" section already promised segment matching — "a whole
/-delimited path segment must match, not an arbitrary substring". Until now that was only true of the server-side dependency list; the CLI matched substrings, soAttestation.solandPermit2Lib.solwere silently dropped from scope. olympix/olympix-dotnet#1757 makes the documented behavior real.Three things were also missing or wrong on the page:
test/mock/example/script/certoraentirely — they were documented for Rust and Cairo only, even though Solidity has always excluded them.chainlink,curve,aave-v3,uniswap-v3,v4-core,permit2,openzeppelin) matched at any depth. That was accurate, and it was the bug: a directory with one of those names is just as likely to be your own integration code. The engines now anchor dependency matching by location, so the page has to say where a dependency lives rather than list names.Changes
script/scripts/certora) and vendored dependencies, and documented the Foundry*.t.sol/*.s.solconventions andfoundry.toml-declaredtest/scriptdirectories.lib/,node_modules/,dependencies/, plus eleven names that can only ever be vendored — and stated explicitly that protocol-named directories likesrc/oracles/chainlink/andpackages/v4-core/are scanned.Attestation.sol,ContestToken.sol,LatestAnswer.sol,Permit2Lib.sol).Verification
Every row of the override table is pinned by an executable test against the production ranker (
DeclaredScopeDocsContractTestsin olympix/olympix-bugpocer#39), so the page cannot drift from the code without a test failing.npm run buildcompletes clean (19 pages); confirmed the new table and notes render intodist/cli/bugpocer/index.html.Merge order
Ship after olympix/olympix-dotnet#1757 and olympix/olympix-bugpocer#39, since this documents their behavior.