noFurtherThan

Author: 75lb

dist/index.cjs

@@ -16,18 +16,32 @@
  * @returns string[]
  */
 function fromTo (arr, options = {}) {
-  const { from: fromFn, to: toFn, remove } = options;
+  const { from: fromFn, to: toFn, noFurtherThan, remove } = options;
   const fromIndex = arr.findIndex(fromFn);
   let toIndex;
   if (toFn) {
     toIndex = arr.findIndex((item, index, arr) => {
-      if ((index > fromIndex) && toFn) {
+      if (index > fromIndex) {
         const valueIndex = index - fromIndex;
         return toFn(valueIndex, item, index, arr)
       } else {
         return false
       }
     });
+  } else if (noFurtherThan) {
+    toIndex = arr.findIndex((item, index, arr) => {
+      if (index > fromIndex) {
+        const valueIndex = index - fromIndex;
+        return noFurtherThan(valueIndex, item, index, arr)
+      } else {
+        return false
+      }
+    });
+    if (toIndex > 0) {
+      toIndex -= 1;
+    } else if (toIndex === -1) {
+      toIndex = arr.length - 1;
+    }
   } else {
     toIndex = fromIndex;
   }
@@ -40,7 +54,10 @@ function fromTo (arr, options = {}) {
   }
 }
 
-/* TODO: add `noFurtherThan` function as an alternative, or replacement, for `to`.. Might result in easier code, e.g. "no further than a --option", rather than "stop here if the next item is an option or the end" */
+/*
+TODO: add `noFurtherThan` function as an additional alternative, or replacement, for `to`.. Might result in easier code, e.g. "no further than a --option", rather than "stop here if the next item is an option or the end". This is also how slice() works: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/slice
+
+*/
 
 class CommandLineArgs {
   constructor (args, optionDefinitions) {
@@ -79,6 +96,7 @@ class CommandLineArgs {
           result.push(fromTo(this.args, {
             from: dynamicDef.from,
             to: dynamicDef.to,
+            noFurtherThan: dynamicDef.noFurtherThan,
             remove: true
           }));
         }

index.js

@@ -1,7 +1,5 @@
 import fromTo from './lib/from-to.js'
 
-/* TODO: add `noFurtherThan` function as an alternative, or replacement, for `to`.. Might result in easier code, e.g. "no further than a --option", rather than "stop here if the next item is an option or the end" */
-
 class CommandLineArgs {
   constructor (args, optionDefinitions) {
     this.origArgv = args.slice()
@@ -39,6 +37,7 @@ class CommandLineArgs {
           result.push(fromTo(this.args, {
             from: dynamicDef.from,
             to: dynamicDef.to,
+            noFurtherThan: dynamicDef.noFurtherThan,
             remove: true
           }))
         }

lib/from-to.js

@@ -14,18 +14,32 @@
  * @returns string[]
  */
 function fromTo (arr, options = {}) {
-  const { from: fromFn, to: toFn, remove } = options
+  const { from: fromFn, to: toFn, noFurtherThan, remove } = options
   const fromIndex = arr.findIndex(fromFn)
   let toIndex
   if (toFn) {
     toIndex = arr.findIndex((item, index, arr) => {
-      if ((index > fromIndex) && toFn) {
+      if (index > fromIndex) {
         const valueIndex = index - fromIndex
         return toFn(valueIndex, item, index, arr)
       } else {
         return false
       }
     })
+  } else if (noFurtherThan) {
+    toIndex = arr.findIndex((item, index, arr) => {
+      if (index > fromIndex) {
+        const valueIndex = index - fromIndex
+        return noFurtherThan(valueIndex, item, index, arr)
+      } else {
+        return false
+      }
+    })
+    if (toIndex > 0) {
+      toIndex -= 1
+    } else if (toIndex === -1) {
+      toIndex = arr.length - 1
+    }
   } else {
     toIndex = fromIndex
   }

lib/option-definition.js

@@ -0,0 +1,14 @@
+class OptionDefinition {
+  name
+  from
+  to
+
+  /**
+   * An additional alternative, or replacement, for `to`. Might result in easier code, e.g. "no further than a --option", rather than "stop here if the next item is an option or the end". This is also how slice() works: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/slice
+   */
+  noFurtherThan
+  type
+  def
+}
+
+export default OptionDefinition

test.js

@@ -146,4 +146,54 @@ test.set('dynamic definition function receives fromArg', async function () {
   a.deepEqual(cla.args, ['one', 'two', '--two'])
 })
 
+test.set('noFurtherThan', async function () {
+  const argv = ['command1', 'arg', '--option', 'value', '--flag', 'command2', 'arg2']
+  const commands = ['command1', 'command2']
+  const optionDefinitions = [
+    {
+      from: arg => commands.includes(arg),
+      noFurtherThan: (valueIndex, arg, index, argv) => commands.includes(arg)
+    }
+  ]
+  const cla = new CommandLineArgs(argv, optionDefinitions)
+  const result = cla.parse()
+  // this.data = result
+  a.deepEqual(result, {
+    command1: ['arg', '--option', 'value', '--flag'],
+    command2: ['arg2']
+  })
+})
+
+test.set('to not found: no args matched', async function () {
+  const argv = ['command1', 'arg', '--option', 'value', '--flag']
+  const optionDefinitions = [
+    {
+      from: arg => arg === 'command1',
+      to: () => false
+    }
+  ]
+  const cla = new CommandLineArgs(argv, optionDefinitions)
+  const result = cla.parse()
+  // this.data = result
+  a.deepEqual(result, {
+    command1: []
+  })
+})
+
+test.set('noFurtherThan not found: all args matched until the end', async function () {
+  const argv = ['command1', 'arg', '--option', 'value', '--flag']
+  const optionDefinitions = [
+    {
+      from: arg => arg === 'command1',
+      noFurtherThan: () => false
+    }
+  ]
+  const cla = new CommandLineArgs(argv, optionDefinitions)
+  const result = cla.parse()
+  // this.data = result
+  a.deepEqual(result, {
+    command1: [ 'arg', '--option', 'value', '--flag' ]
+  })
+})
+
 export { test, only, skip }