Skip to content

Add generated config wiki section#3029

Open
absalonCRC wants to merge 1 commit into
crytic:masterfrom
absalonCRC:codex/generate-config-wiki-section
Open

Add generated config wiki section#3029
absalonCRC wants to merge 1 commit into
crytic:masterfrom
absalonCRC:codex/generate-config-wiki-section

Conversation

@absalonCRC

Copy link
Copy Markdown

Summary

  • add a hidden --wiki-configuration / --wiki-config flag that emits the Configuration File wiki section from defaults_flag_in_config
  • serialize enum defaults to JSON-safe values so the generated code block is valid JSON
  • include the crytic-compile defaults that Slither already merges into its config defaults

Fixes #1155

Testing

  • uv run pytest tests/unit/utils/test_command_line.py
  • uv run ruff check slither/utils/command_line.py slither/__main__.py tests/unit/utils/test_command_line.py
  • uv run python -m slither --wiki-configuration

@absalonCRC absalonCRC requested a review from smonicas as a code owner May 24, 2026 10:18
@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

3 participants