spinframework / spinframework/spin

Deprecate intermixed spin up and trigger args in favor of `spin up [args] -- [trigger args]`

Open
#1,214 6 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

area/CLI enhancement open for comment
Dominant language
Rust
Stars
6.5k
Forks
310
Avg merge
1d 20h
Merged PRs (30d)
24

Description

As means to unblock #1198 + taking inspiration from #1155 and #1207

Since the trigger args in spin up aren't known ahead of time, and actually meant to be forwarded to a spin trigger [...] command, allowing them to be intermixed with spin up args is not conventional. It appears the expected pattern is "cmd [args] -- [next args]"

Compare with cargo run which is analogous:

NAME
       cargo-run — Run the current package

SYNOPSIS
       cargo run [options] [-- args]

DESCRIPTION
       Run a binary or example of the local package.

       All the arguments following the two dashes (--) are passed 
to the
       binary to run. If you’re passing arguments to both Cargo an
d the
       binary, the ones after -- go to the binary, the ones before
 go to
       Cargo.

This avoids any kind of ambiquity with future spin up args and makes parsing easier possible in clap 4.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start at the spin up command's argument parsing and review how trigger arguments are forwarded to spin trigger, with the clap 4 parsing limitation in mind. Compare the intended syntax with the cargo run example; done means spin up arguments precede --, trigger arguments follow it, and the previous intermixed form is deprecated.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
cli
Issue type
Feature
Difficulty
3/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.