feat(flags): implement stopEarly option (#39)

c4spar · Jun 4, 2020 · ee683d3 · ee683d3
1 parent 4f18db7
commit ee683d3
Show file tree

Hide file tree

Showing 3 changed files with 87 additions and 1 deletion.
diff --git a/packages/flags/README.md b/packages/flags/README.md
@@ -75,6 +75,7 @@ if ( flags.help ) {
 | Param | Type | Required | Description |
 | ----- | :--: | :--: | ----------- |
 | allowEmpty | `boolean` | No | Allow no arguments. Defaults to `false` |
+| stopEarly | `boolean` | No | If enabled, all values starting from the first non option argument will be added to `unknown`. |
 | flags | `IFlagOptions[]` | No | Array of flag options. |
 | parse | `function` | No | Custom type parser. |
 

diff --git a/packages/flags/lib/flags.ts b/packages/flags/lib/flags.ts
@@ -31,6 +31,7 @@ export function parseFlags<O = any>( args: string[], opts: IParseOptions = {} ):
     const flags: IFlags = {};
     const literal: string[] = [];
     const unknown: string[] = [];
+    let stopEarly: boolean = false;
 
     opts.flags.forEach( opt => {
         opt.depends?.forEach( flag => {
@@ -63,7 +64,7 @@ export function parseFlags<O = any>( args: string[], opts: IParseOptions = {} ):
         const isFlag = current.length > 1 && current[ 0 ] === '-';
         const next = () => normalized[ i + 1 ];
 
-        if ( isFlag ) {
+        if ( isFlag && !stopEarly ) {
 
             if ( current[ 2 ] === '-' || ( current[ 1 ] === '-' && current.length === 3 ) ) {
                 throw new Error( `Invalid flag name: ${ current }` );
@@ -234,6 +235,9 @@ export function parseFlags<O = any>( args: string[], opts: IParseOptions = {} ):
             }
 
         } else {
+            if ( opts.stopEarly ) {
+                stopEarly = true;
+            }
             unknown.push( current );
         }
     }

diff --git a/packages/flags/test/setting/stop-early_test.ts b/packages/flags/test/setting/stop-early_test.ts
@@ -0,0 +1,81 @@
+import { parseFlags } from '../../lib/flags.ts';
+import { OptionType } from '../../lib/types.ts';
+import { assertEquals, assertThrows } from '../lib/assert.ts';
+
+Deno.test( 'flags stopEarly disable', () => {
+
+    const { flags, unknown, literal } = parseFlags( [
+        '-f', 'true', 'run', 'script-name', '--script-arg1', '--script-arg2', '--', '--literal-arg1', '--literal-arg2'
+    ], {
+        stopEarly: false,
+        flags: [ {
+            name: 'flag',
+            aliases: [ 'f' ],
+            type: OptionType.BOOLEAN
+        }, {
+            name: 'script-arg1',
+            aliases: [ 's' ],
+            type: OptionType.BOOLEAN
+        }, {
+            name: 'script-arg2',
+            aliases: [ 'S' ],
+            type: OptionType.BOOLEAN
+        } ]
+    } );
+
+    assertEquals( flags, { flag: true, scriptArg1: true, scriptArg2: true } );
+    assertEquals( unknown, [ 'run', 'script-name' ] );
+    assertEquals( literal, [ '--literal-arg1', '--literal-arg2' ] );
+} );
+
+Deno.test( 'flags stopEarly enabled', () => {
+
+    const { flags, unknown, literal } = parseFlags( [
+        '-f', 'true', 'run', 'script-name', '--script-arg1', '--script-arg2', '--script-arg3', '--', '--literal-arg1', '--literal-arg2'
+    ], {
+        stopEarly: true,
+        flags: [ {
+            name: 'flag',
+            aliases: [ 'f' ],
+            type: OptionType.BOOLEAN
+        }, {
+            name: 'script-arg1',
+            aliases: [ 's' ],
+            type: OptionType.BOOLEAN
+        }, {
+            name: 'script-arg2',
+            aliases: [ 'S' ],
+            type: OptionType.BOOLEAN
+        } ]
+    } );
+
+    assertEquals( flags, { flag: true } );
+    assertEquals( unknown, [ 'run', 'script-name', '--script-arg1', '--script-arg2', '--script-arg3' ] );
+    assertEquals( literal, [ '--literal-arg1', '--literal-arg2' ] );
+} );
+
+Deno.test( 'flags stopEarly unknown option', () => {
+
+    assertThrows(
+        () => parseFlags( [
+            '-f', 'true', '-t', 'true', 'run', 'script-name', '--script-arg1', '--script-arg2', '--script-arg3', '--', '--literal-arg1', '--literal-arg2'
+        ], {
+            stopEarly: true,
+            flags: [ {
+                name: 'flag',
+                aliases: [ 'f' ],
+                type: OptionType.BOOLEAN
+            }, {
+                name: 'script-arg1',
+                aliases: [ 's' ],
+                type: OptionType.BOOLEAN
+            }, {
+                name: 'script-arg2',
+                aliases: [ 'S' ],
+                type: OptionType.BOOLEAN
+            } ]
+        } ),
+        Error,
+        'Unknown option: -t'
+    );
+} );