spinframework / spinframework/spin
Trigger options really aren't, mostly
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 6.5k
- Forks
- 310
- Avg merge
- 1d 20h
- Merged PRs (30d)
- 24
Description
We recently added spin up --key-value and will soon add spin up --sqlite. Because these have to be processed by host components, and because host components are loaded in the trigger process, these have to be declared on the trigger command, rather than directly on up. This means they appear in the TRIGGER OPTIONS part of spin up --help.
And yet they are clearly not, conceptually, trigger options. --listen is a trigger option. --tls-cert is a trigger option. But nobody trying to remember if it's --keyvalue or --key-value is going to look in the TRIGGER OPTIONS section. It's an implementation artifact.
It would be great to find a sustainable, maintainable way to present command options that are not specifically trigger-related in the main section of spin up --help, and have only truly trigger-related ones in the subsection.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the spin up --help implementation and the definitions for --key-value, --sqlite, --listen, and --tls-cert. Determine how options are assigned to the main and TRIGGER OPTIONS sections, then define a maintainable presentation that keeps only truly trigger-related options in the subsection and verify the resulting help output.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- cli, developer-experience
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100