es-check icon indicating copy to clipboard operation
es-check copied to clipboard

Command-line options should be available in kebab case

Open p3k opened this issue 1 year ago • 3 comments

Requested Update

At the moment of writing this, there are two options available in camel and kebab case, and two available in camel case only (via es-check --help):

  1. --allow-hash-bang and --allowHashBang
  2. --no-color and --noColor
  3. --looseGlobMatching
  4. --checkFeatures

Either all options should be available exclusively in one case or the other, or all options should be available in both cases.

Why Is This Update Needed?

For consistency reasons.

Are There Examples Of This Requested Update Elsewhere?

Read about references issues here. Provide paragraph text responses to each header.

p3k avatar Jan 13 '25 13:01 p3k

Hey @p3k ! Thanks again for the thoughtful issue.

Kabob case is supported in command line options for backwards compatibility. I don't initially feel it's worth actual breakking changes, though. Perhaps I could try to see if we could hide the options from the --help command to avoid people using kabob case moving forward...?

yowainwright avatar Jan 13 '25 19:01 yowainwright

@yowainwright Of course, backwards compatibility is a good thing. However, the help output suggests that --looseGlobMatching and --checkFeatures are in the maintained format, and that --loose-glob-matching or --check-features are not even provided (are they?)

Hiding the (deprecated) options from help and documentation sounds like a good idea to me.

p3k avatar Jan 14 '25 08:01 p3k

Thanks! I'll put in a little effort to fix the --help output (but low priority from my perspective). I'll definitely correct the kabob case references in the readme.

yowainwright avatar Jan 14 '25 10:01 yowainwright

This has been updated! Please continue to provide this good feedback. 🙏

yowainwright avatar Mar 26 '25 07:03 yowainwright