WIP: Migrate from argparse to Typer

[DarkaMaul]

Description

This PR replaces #2220

1. Replace argparse with typer

Modify Slither CLI from argparse to Typer.

With this migration we gain :

• Argument validation using Python type hints
• A nicely formatted help message
• Auto completion support ( type slither c<TAB>)

I kept the crytic-compile module as if, and created a backward compatibility layer with it.

Notable points :

• Arguments are either associated to the main command (slither) or with one of its subcommand (detect). For instance, the formatting or the output file.
• A backward compatibility layer to keep the slither . has been added, converting it to the new format : slither detect ..
• A new SlitherState object is accessible. It contains every parsed argument on the upper command to be accessed by the sub commands if needed. For instance, this is where are stored the crytic-compile arguments.

2. Update tools to use sub-commands

Each slither tool now has its own subcommand.
Use like slither mutate <>

Screenshots

Remaining TODO

• make sure flags are under the right subcommand
• determine if we want to gate dependencies e.g. pip install slither[read-storage] to use slither read-storage
• EXTENSIVE TESTING
  While I tried to test the changes I made, it is touching almost every part of the code. Moreover, it contains breaking changes. So we should try to test a bit more (and on more than a single computer) before merging.
• review where each flags is used and if not, simplify the CLI

[coderabbitai]

Important

Auto Review Skipped

Auto reviews are disabled on base/target branches other than the default branch. Please add the base/target branch pattern to the list of additional branches to be reviewed in the settings.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[0xalpharush]

• add something like --long-help from Feat/subcommands #2220 to show the crytic-compile flags that can be used
• --no-fail only applies to the echidna printer and does not need to be apart of the top level command line options
• --wiki-detectors should remain suppressed as it is not user facing
• It looks like slither mutate is missing from the list? We can probably not show demo and delete check-kpsec
• add description to format
• for slither-read-storage, we can isolate the dependencies as outlined in break functionality up into subcommands #1928
• make thinks like --detect and --print suggest available options

[0xalpharush]

It'd be great to put together better testing infra for our CLI so we can feel confident about this and also changes like #2428 (and quickly iterate on them in the future)