Refactor parsing for readability and future expansion, and tighten short option group parsing #68

shadowspawn · 2022-02-26T00:52:14Z

Refactor parsing:

improve readability
reduce logic nesting and simplify context for readability
make it easier to add further functionality

Refactor heavily influenced by comments and code from @aaronccasanova in #64.

There is one functional change. A dubious option group with an option in the middle taking a value now returns the argument as a positional for BYO handling, and in strict mode this would throw. (The previous code was blindly expanding anything after a single -.) This behaviour influenced by comments from @ljharb, and narrower implementation of the Open Group Utility Conventions.
Separate out and extend tests for single - and for short option groups.

Apologies for the noise moving the tests, but something I badly wanted to do, and felt in scope for a big refactor!

First draft: no changes to unit tests. It works as before, as far as the tests went!
Second draft: separate out and extend - unit tests
Third draft: separate out and extend short option group tests

aaronccasanova · 2022-02-26T02:20:11Z

These updates are great @shadowspawn!! I'm honestly tempted to close out my PR in favor of this implementation. My goal was simply to swap out the conditionals with named utilities while introducing the smallest number of changes. That being said, I very much prefer the approach you took where each arg is assessed sequentially and the utility functions can stand on their own 👌

shadowspawn · 2022-02-26T04:04:06Z

Ready for review.

index.js

ljharb · 2022-02-26T05:13:00Z

index.js

+ * Determines if the option is expecting a value.
+ */
+function isExpectingValue(optionKey, options) {
+  return options && options.withValue &&


Suggested change

return options && options.withValue &&

return options && ArrayIsArray(options.withValue) &&

otherwise a truthy non-array could cause problems

We call validateArray on withValue as soon as the options are received, so don't need to be paranoid about that. (Good advice in just local scope. The validation is outside the diff.)

if we're sure it's an array when present, why would options be falsy?

Could be missing with current validation:

parseargs/index.js

Line 87 in 2ab5af3

if (ObjectHasOwn(options, key)) {

(We currently validate, but not modify. Might be revamping configuration: #63)

test/dash.js

aaronccasanova · 2022-02-26T01:45:56Z

index.js

+  * @example
+  * isLongOption('-a) // returns false
+  * isLongOption('--foo) // returns true
+  * isLongOption('--foo=bar) // returns true
+  */
+function isLongOption(arg) {
+  return arg.length > 2 && StringPrototypeStartsWith(arg, '--');


isLongOption('---') would also return true. Should we update this to test with regex?
e.g. /^--?\w+/.test(arg)

Or simply add && StringPrototypeCharAt(arg, 2) !== '-'

isLongOption('---') would also return true.

Yes, this is an edge case but is as intended. See discussion in #7.

Roger roger, thanks for the resource! Skimming the issue I'm in agreement it makes sense we limit the assumption here 👍

aaronccasanova · 2022-02-26T01:52:33Z

index.js

+  const onlyFlags = arg.slice(1, -1);
+  for (let index = 0; index < onlyFlags.length; index++) {
+    const optionKey = getOptionKey(StringPrototypeCharAt(onlyFlags, index));


suggestion (non-blocking): This appears to be the only place in the parsing implementation referring to options as flags (outside of the results object). Perhaps we should update the name for consistency e.g. optionKeys, onlyOptionKeys, shortOptions, onlyShortOptions, etc.

Ha! I knew that when I wrote it, but didn't try and think of something better! Fair call, will do. 😄

Reworked wording and code:

const leadingShorts = StringPrototypeSlice(arg, 1, -1); const allLeadingAreBoolean = ArrayPrototypeEvery(leadingShorts, (short) => {

index.js

Co-authored-by: Jordan Harband <ljharb@gmail.com>

ljharb · 2022-02-26T07:44:32Z

index.js

@@ -53,7 +54,7 @@ function getMainArgs() {
  return ArrayPrototypeSlice(process.argv, 2);
 }

-function storeOptionValue(parseOptions, option, value, result) {
+function storeOptionValue(option, value, parseOptions, result) {
  const multiple = parseOptions.multiples &&


It seems like if we’re validating such that we know this is an array, why isn’t it always an array? Meaning, have it be an empty array here, rather than falsy/missing.

(We currently validate, but not modify. Might be revamping configuration: #63)

bcoe · 2022-02-27T14:44:14Z

@aaronccasanova, if you prefer this over #64, let's go with it?

Same comment stands as in #64, which is that I'd advocate that we keep these helpers private.

aaronccasanova · 2022-02-27T16:51:22Z

Yes, I prefer this implementation and agree the helpers should be private 👍 Wen't ahead and closed PR #64

shadowspawn · 2022-03-02T00:08:50Z

I am working on rewrite for after #63 lands, so changed this to draft.

shadowspawn · 2022-03-03T08:33:37Z

Working on redo of this with new configuration bag of options.

shadowspawn · 2022-03-04T01:03:45Z

Redid work in #75 after #63 landed.

Refactor parsing for improved clarity, robustness, and future expansion.

2065a95

shadowspawn added 4 commits February 26, 2022 16:24

Support multiple test files, and extend dash tests

bdd8530

Clarify test title context

0cfbe0f

Move and extend short option group tests. Fix bug uncovered by new test.

6b918bf

Add explicit strict for case that may fail in future

91646b9

shadowspawn marked this pull request as ready for review February 26, 2022 04:03

Update comments for current calling signature

52507d3

ljharb reviewed Feb 26, 2022

View reviewed changes

aaronccasanova reviewed Feb 26, 2022

View reviewed changes

shadowspawn and others added 2 commits February 26, 2022 19:14

Prefer map to loop for style and lines of code

3aa6ddb

Use primordial slice

b0e0e92

Co-authored-by: Jordan Harband <ljharb@gmail.com>

ljharb reviewed Feb 26, 2022

View reviewed changes

shadowspawn added 4 commits February 26, 2022 21:17

Address two review suggestions

42103c6

Replace splice and spread with concat and slice

381e356

Add a paranoid tests since short groups "expand" into shorts

9fd16fe

Fix bug with alias due to missing parameter

80eae79

This was referenced Feb 26, 2022

feat: short with value in same arg #69

Closed

Multiple test files? #66

Closed

bcoe approved these changes Feb 27, 2022

View reviewed changes

aaronccasanova mentioned this pull request Feb 27, 2022

feat: Add arg and option parsing utils #64

Closed

Merge branch 'main' into feature/more-shorts

75b2fbe

aaronccasanova mentioned this pull request Feb 28, 2022

refactor!: restructure configuration to take options bag #63

Merged

1 task

shadowspawn mentioned this pull request Mar 1, 2022

Is strict actually a goal? #11

Closed

shadowspawn marked this pull request as draft March 2, 2022 00:06

shadowspawn mentioned this pull request Mar 4, 2022

refactor!: parsing, revisit short option groups, add support for combined short and value #75

Merged

shadowspawn closed this Mar 4, 2022

shadowspawn deleted the feature/more-shorts branch June 5, 2022 03:17

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Refactor parsing for readability and future expansion, and tighten short option group parsing #68

Refactor parsing for readability and future expansion, and tighten short option group parsing #68

shadowspawn commented Feb 26, 2022 •

edited

Loading

aaronccasanova commented Feb 26, 2022

shadowspawn commented Feb 26, 2022

ljharb Feb 26, 2022

shadowspawn Feb 26, 2022

ljharb Feb 26, 2022

shadowspawn Feb 26, 2022

aaronccasanova Feb 26, 2022

shadowspawn Feb 26, 2022

aaronccasanova Feb 26, 2022

aaronccasanova Feb 26, 2022

shadowspawn Feb 26, 2022

shadowspawn Feb 26, 2022

ljharb Feb 26, 2022

shadowspawn Feb 26, 2022

bcoe commented Feb 27, 2022

aaronccasanova commented Feb 27, 2022

shadowspawn commented Mar 2, 2022

shadowspawn commented Mar 3, 2022

shadowspawn commented Mar 4, 2022

	return options && options.withValue &&
	return options && ArrayIsArray(options.withValue) &&

Refactor parsing for readability and future expansion, and tighten short option group parsing #68

Refactor parsing for readability and future expansion, and tighten short option group parsing #68

Conversation

shadowspawn commented Feb 26, 2022 • edited Loading

aaronccasanova commented Feb 26, 2022

shadowspawn commented Feb 26, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bcoe commented Feb 27, 2022

aaronccasanova commented Feb 27, 2022

shadowspawn commented Mar 2, 2022

shadowspawn commented Mar 3, 2022

shadowspawn commented Mar 4, 2022

shadowspawn commented Feb 26, 2022 •

edited

Loading