crytic/slither

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

Open

#1,155 opened on 2022年4月3日

GitHub で見る
 (2 comments) (0 reactions) (0 assignees)Python (4,769 stars) (886 forks)batch import
documentationenhancementgood first issuehelp wanted

説明

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

コントリビューターガイド

技術スタック
python
領域
documentation
Issue 種別
documentation
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
under 1 hour
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
stale
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
clear
前提条件
basic slither knowledge
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
90
調査方針
Review the Wiki page at https://github.com/crytic/slither/wiki/Usage#configuration file and compare with the supported options in https://github.com/crytic/slither/blob/8344524cd35a1edf37c1cc791eb08c8ffff645a8/slither/utils/command line.py#L26 L51. Add the missing options such as 'exclude dependencies', 'exclude optimization', and 'sarif' to the wiki. Ensure all other options are correctly listed.
[Bug-Candidate]: Wiki "Configuration File" section missing supported flags · crytic/slither#1155 | Good First Issue