FuelLabs/sway

`forc`: Add a manual `clap` `--help` implementation that also lists plugin-provided commands

Open

#3,831 opened on Jan 19, 2023

View on GitHub
 (4 comments) (0 reactions) (0 assignees)Rust (5,421 forks)batch import
ODHack13forcgood first issuemay be rewarded

Repository metrics

Stars
 (61,702 stars)
PR merge metrics
 (Avg merge 22h 6m) (16 merged PRs in 30d)

Description

It's nice that we can support new commands via plugins, but the fact that they don't show up in the default --help output is probably confusing for users who 1. don't realise those plugin-commands don't show up in the default help or 2. that some commands are even provided by plugins.

We should consider a manual implementation of --help that includes the plugin-provided commands too.

Contributor guide

Research direction
Examine how forc currently generates help output and how plugins are discovered. Investigate the clap crate's help formatting to design a custom help that includes plugin commands.
Tech stack
rust
Domain
cli
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
RustCLI design
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60