crytic/slither

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

Open

#1,155 opened on Apr 3, 2022

View on GitHub
 (2 comments) (0 reactions) (0 assignees)Python (886 forks)batch import
documentationenhancementgood first issuehelp wanted

Repository metrics

Stars
 (4,769 stars)
PR merge metrics
 (Avg merge 54d 9h) (2 merged PRs in 30d)

Description

Describe the issue:

The list of configuration file options is incomplete

Code example to reproduce the issue:

The config file options in the wiki are here: https://github.com/crytic/slither/wiki/Usage#configuration-file

The supported options in the code are here: https://github.com/crytic/slither/blob/8344524cd35a1edf37c1cc791eb08c8ffff645a8/slither/utils/command_line.py#L26-L51

Some examples of supported config options not in the wiki are "exclude_dependencies", "exclude_optimization", and "sarif".

Version:

0.8.2

Relevant log output:

No response

Contributor guide

Research direction
Compare the config options listed in the code at slither/utils/command line.py with the wiki page and add all missing flags like exclude dependencies, exclude optimization, and sarif.
Tech stack
python
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90