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

args: default negatable to false #26

Open
DartBot opened this issue Jun 5, 2015 · 9 comments
Open

args: default negatable to false #26

DartBot opened this issue Jun 5, 2015 · 9 comments
Labels
type-enhancement A request for a change that isn't a bug

Comments

@DartBot
Copy link

DartBot commented Jun 5, 2015

<img src="https://avatars.githubusercontent.com/u/444270?v=3" align="left" width="96" height="96"hspace="10"> Issue by seaneagan
Originally opened as dart-lang/sdk#16022


I can't prove this, but I feel like non-negatable is more common.

For example, --help, --verbose, --quiet, --version are all non-negatable. Also, since flags should generally default to false, specifying --no-foo is redundant. I would prefer to explicitly ask for this feature when I need it, but I'm not sure when that would be.

@DartBot
Copy link
Author

DartBot commented Jun 5, 2015

<img src="https://avatars.githubusercontent.com/u/5449880?v=3" align="left" width="48" height="48"hspace="10"> Comment by iposva-google


In my opinion why you want negatable boolean options is so that you can easily experiment on the command line without having to remove the flag by just adding the "no-" to form a --no-xyz. It is especially useful if you want to call out that a flag is off when comparing two outcomes.

Also the premise that the default is set to false in general is not entirely correct. An example: The --inline flag should probably default to true in a compiler, with the option to turn off inlining if needed. A false default would mean that you would have the awkwardly named flag --dont_inline and the even more strange use within the code.


Added Area-Pkg, Library-Args, Triaged labels.

@DartBot
Copy link
Author

DartBot commented Jun 5, 2015

<img src="https://avatars.githubusercontent.com/u/444270?v=3" align="left" width="48" height="48"hspace="10"> Comment by seaneagan


Thanks, I wasn't aware of the use case to quickly switch between --foo and
--no-foo. And I do see how explicitly specifying what is already the
default can be helpful.

My main gripe though is that since I get a negated version by default, it's
easy to introduce non-sensical negated options, like --no-quiet or
--no-version, but then to remove them later is a potentially breaking
change. For flags that default to true, you could have only the negated
version, e.g. --no-inline, which makes it much more obvious that inlining
is the default behavior.

@DartBot
Copy link
Author

DartBot commented Jun 5, 2015

<img src="https://avatars.githubusercontent.com/u/444270?v=3" align="left" width="48" height="48"hspace="10"> Comment by seaneagan


FWIW, I looked up chrome's command line flags (since it has a ton of them):

http://peter.sh/experiments/chromium-command-line-switches/

and they seem to follow the practice of only including --no-foo, instead of
both, e.g. --[no-]foo

@DartBot
Copy link
Author

DartBot commented Jun 5, 2015

<img src="https://avatars.githubusercontent.com/u/444270?v=3" align="left" width="48" height="48"hspace="10"> Comment by seaneagan


Also forgot to mention that multiple flags are also often used in an enum
type way, where only one of the flags should ever be specified at a time,
for example see:

https://github.com/dart-lang/spark/blob/master/ide/tool/test_runner.dart#L129

.. and these type of flags are never negatable.

@DartBot
Copy link
Author

DartBot commented Jun 5, 2015

<img src="https://avatars.githubusercontent.com/u/3276024?v=3" align="left" width="48" height="48"hspace="10"> Comment by anders-sandholm


Removed Library-Args label.
Added Pkg-Args label.

@DartBot DartBot added the type-bug Incorrect behavior (everything from a crash to more subtle misbehavior) label Jun 5, 2015
@DartBot
Copy link
Author

DartBot commented Jun 5, 2015

<img src="https://avatars.githubusercontent.com/u/46275?v=3" align="left" width="48" height="48"hspace="10"> Comment by munificent


Yeah, I agree with you Sean. I thought defaulting to allow negation would make things more flexible, but in practice it feels like the wrong default.

Alas, it would be a breaking change. I'll probably do it at some point, but I'm going to sit on it for a while.

@nex3 nex3 added type-enhancement A request for a change that isn't a bug and removed type-bug Incorrect behavior (everything from a crash to more subtle misbehavior) labels Jun 6, 2015
@Hixie
Copy link

Hixie commented Mar 19, 2016

Another reason to have negatable flags is if the tool supports saving defaults (e.g. in a .xxxrc file). If you save a positive value, you need a way to negate it on the command line.

For this reason, --verbose and --quiet should indeed be negatable.

I think the real solution here is to make addCommand support taking commands that start with --. --version is really a weird special case, in arg's convention it really should be a command. Similarly with --help, in a way.

Though if --version and --help are the only special cases, then having them require negatable:false seems fine to me.

@nex3
Copy link
Member

nex3 commented Mar 21, 2016

I think the real solution here is to make addCommand support taking commands that start with --.

Can you expand on this? I'm not 100% sure what you mean.

@Hixie
Copy link

Hixie commented Mar 21, 2016

When you say "foo --version", you're really saying "foo version", that is, you're trying to run the "version" subcommand of "foo".

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type-enhancement A request for a change that isn't a bug
Projects
None yet
Development

No branches or pull requests

3 participants