Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature request: add stability to commands and options #1638

Open
bitliner opened this issue May 2, 2020 · 4 comments
Open

Feature request: add stability to commands and options #1638

bitliner opened this issue May 2, 2020 · 4 comments

Comments

@bitliner
Copy link

bitliner commented May 2, 2020

Context

Sometimes a command could be not stable yet (while it's on a stable release, however still could break, and needs more testing).

Same for command options.

A similar scenario is NodeJS standard API. Node JS manages 3 levels of stability (see here )

  • stability 0 - Deprecated
  • stability 1 - Experimental (eg Use of the feature is not recommended in production environments)
  • stability 2 - Stable

Problem

Yargs does not provide a way to set which options/commands are experimental or stable.

Question

Do you plan to add support for it?

@mleguen
Copy link
Member

mleguen commented May 6, 2020

@bcoe Couldn't that be an evolution of the recently added deprecated feature?

@bcoe
Copy link
Member

bcoe commented May 6, 2020

@mleguen yeah, I think that's a good idea. @laggingreflex thoughts on this one?

@laggingreflex
Copy link
Contributor

Yep, I like this too. This does seem to be a direct evolution.

We can change deprecated:bool|string API to stability:string?

@jgoux
Copy link
Contributor

jgoux commented Jul 13, 2022

This feature would be great, I'm writing a tool to automatically generate documentation out of a yargs CLI program and we have experimental commands (I have to edit the doc afterward manually currently).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

5 participants