Skip to content

Add generated config option listing#3036

Open
keilogic wants to merge 1 commit into
crytic:masterfrom
keilogic:list-config-options
Open

Add generated config option listing#3036
keilogic wants to merge 1 commit into
crytic:masterfrom
keilogic:list-config-options

Conversation

@keilogic

Copy link
Copy Markdown

Summary

  • add slither --list-config to print supported config-file keys and defaults from defaults_flag_in_config
  • serialize enum defaults to JSON-friendly values for generated docs/config starters
  • allow config-file keys with hyphens, such as json-types, to map onto argparse underscore attributes while preserving CLI precedence
  • update docs/src/Usage.md with the generated Slither + crytic-compile config list

Fixes #1155.

Tests

  • python -m pytest tests\unit\utils\test_command_line.py -q
  • python -m slither --list-config
  • python -m ruff check slither\utils\command_line.py slither\__main__.py tests\unit\utils\test_command_line.py
  • git diff --check

If this accepted contribution is eligible for a Trail of Bits PayPal bounty, payout can be sent to: https://www.paypal.com/paypalme/aogkft

@keilogic keilogic requested a review from smonicas as a code owner May 29, 2026 06:04
@CLAassistant

Copy link
Copy Markdown

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

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.

[Bug-Candidate]: Wiki "Configuration File" section missing supported flags

2 participants