crytic/slither

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

Open

#1.155 geöffnet am 3. Apr. 2022

Auf GitHub ansehen
 (2 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Python (886 Forks)batch import
documentationenhancementgood first issuehelp wanted

Repository-Metriken

Stars
 (4.769 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 54T 9h) (2 gemergte PRs in 30 T)

Beschreibung

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-Richtung
Überprüfe die Wiki Seite unter https://github.com/crytic/slither/wiki/Usage#configuration file und vergleiche sie mit den unterstützten Optionen in https://github.com/crytic/slither/blob/8344524cd35a1edf37c1cc791eb08c8ffff645a8/slither/utils/command line.py#L26 L51. Füge die fehlenden Optionen wie 'exclude dependencies', 'exclude optimization' und 'sarif' zum Wiki hinzu. Stelle sicher, dass alle anderen Optionen korrekt aufgeführt sind.
Tech Stack
python
Domain
documentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
1
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Unter 1 Stunde
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Frisch
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Git
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
90