Skip to content

Commit 169a690

Browse files
authored
Deprecate stellar --list in favor of stellar plugin ls. (#2250)
1 parent 5b04057 commit 169a690

4 files changed

Lines changed: 7 additions & 4 deletions

File tree

FULL_HELP_DOCS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ Anything after the `--` double dash (the "slop") is parsed as arguments to the c
6868
- `-q`, `--quiet` — Do not write logs to stderr including `INFO`
6969
- `-v`, `--verbose` — Log DEBUG events
7070
- `--very-verbose` [alias: `vv`] — Log DEBUG and TRACE events
71-
- `--list` — List installed plugins. E.g. `stellar-hello`
71+
- `--list`⚠️ Deprecated, use `stellar plugin ls`. List installed plugins. E.g. `stellar-hello`
7272
- `--no-cache` — Do not cache your simulations and transactions
7373

7474
## `stellar contract`

cmd/crates/soroban-test/tests/it/plugin.rs

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,10 +34,11 @@ fn stellar_bye() {
3434

3535
#[test]
3636
fn list() {
37-
// Call `soroban --list` with the PATH variable set to include the target/bin directory
37+
// Call `stellar plugin ls` with the PATH variable set to include the target/bin directory
3838
assert_cmd::Command::cargo_bin("stellar")
3939
.unwrap_or_else(|_| assert_cmd::Command::new("stellar"))
40-
.arg("--list")
40+
.arg("plugin")
41+
.arg("ls")
4142
.env("PATH", get_paths())
4243
.assert()
4344
.stdout(predicates::str::contains("hello"))

cmd/soroban-cli/src/commands/global.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ pub struct Args {
3939
#[arg(long, visible_alias = "vv", global = true, help_heading = HEADING_GLOBAL)]
4040
pub very_verbose: bool,
4141

42-
/// List installed plugins. E.g. `stellar-hello`
42+
/// ⚠️ Deprecated, use `stellar plugin ls`. List installed plugins. E.g. `stellar-hello`
4343
#[arg(long)]
4444
pub list: bool,
4545

cmd/soroban-cli/src/commands/mod.rs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,8 @@ impl Root {
8787
pub fn new() -> Result<Self, Error> {
8888
Self::try_parse().map_err(|e| {
8989
if std::env::args().any(|s| s == "--list") {
90+
let print = Print::new(std::env::args().any(|s| s == "--quiet" || s == "-q"));
91+
deprecate_message(print, "--list", "Use `stellar plugin ls` instead.");
9092
let _ = plugin::ls::Cmd.run();
9193
std::process::exit(0);
9294
}

0 commit comments

Comments
 (0)