Skip to content

Add generated config defaults output#3023

Open
Julz19 wants to merge 1 commit into
crytic:masterfrom
Julz19:codex/print-config-defaults
Open

Add generated config defaults output#3023
Julz19 wants to merge 1 commit into
crytic:masterfrom
Julz19:codex/print-config-defaults

Conversation

@Julz19

@Julz19 Julz19 commented May 16, 2026

Copy link
Copy Markdown

Fixes #1155.

Summary

  • Add slither --print-config to print supported config-file keys and defaults from defaults_flag_in_config.
  • Convert enum defaults, such as fail_on, to JSON-compatible values in that generated output.
  • Update docs/src/Usage.md so the configuration section is generated from the runtime defaults instead of a stale hand-maintained list.
  • Add focused unit coverage for the config default formatter and markdown output.

Validation

  • uv run --python /Users/juju/.local/bin/python3.11 python -m pytest tests/unit/utils/test_command_line.py
  • uv run --python /Users/juju/.local/bin/python3.11 ruff check slither/__main__.py slither/utils/command_line.py tests/unit/utils/test_command_line.py
  • uv run --python /Users/juju/.local/bin/python3.11 python -m slither --print-config

If this accepted PR is considered eligible for a PayPal bounty, payout can go to https://paypal.me/JulianAcero897.

@Julz19 Julz19 requested a review from smonicas as a code owner May 16, 2026 08:43
@CLAassistant

CLAassistant commented May 16, 2026

Copy link
Copy Markdown

CLA assistant check
All committers have signed the CLA.

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