Skip to content

docs: document segment matching and the declared-scope override for bugpocer - #30

Open
Tennis-Ball wants to merge 3 commits into
mainfrom
docs/scope-path-segment-matching
Open

docs: document segment matching and the declared-scope override for bugpocer#30
Tennis-Ball wants to merge 3 commits into
mainfrom
docs/scope-path-segment-matching

Conversation

@Tennis-Ball

Copy link
Copy Markdown
Contributor

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, so Attestation.sol and Permit2Lib.sol were silently dropped from scope. olympix/olympix-dotnet#1757 makes the documented behavior real.

Two things were also missing from the page:

  • The Solidity list omitted test/mock/example/script/certora entirely — they were documented for Rust and Cairo only, even though Solidity has always excluded them.
  • There was no mention that excluded files are still uploaded and readable as context, so "excluded" read as "invisible to the engine".

Changes

  • Split the list into non-production code (shared across languages, now including script/scripts/certora) and vendored dependencies, and documented the Foundry *.t.sol / *.s.sol conventions and foundry.toml-declared test/script directories.
  • Added a concrete note that segment matching means a contract is never excluded for its name — with the real examples (Attestation.sol, ContestToken.sol, LatestAnswer.sol, Permit2Lib.sol).
  • New "Scanning an excluded path anyway" section documenting the declared-scope override from olympix/olympix-bugpocer#39, with a table of the exact semantics. This replaces the previous workaround, which was to rename the directory in your working copy.
  • Note clarifying that excluded files are still uploaded, parsed and readable for context.

Verification

npm run build completes clean (19 pages); confirmed the new table and notes render into dist/cli/bugpocer/index.html.

Merge order

Ship after olympix/olympix-dotnet#1757 and olympix/olympix-bugpocer#39, since this documents their behavior.

🤖 Generated with Claude Code

https://claude.ai/code/session_01UoyuskDHEjWMk1FmiX7A8o

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant