feat(command): return literal arguments in .parse() method and ad…

…d `.getLiteralArgs()` method (#26)

packages/command/lib/base-command.ts

@@ -26,6 +26,7 @@ export class BaseCommand<O = any, A extends Array<any> = any> {
         [ 'boolean', { name: 'boolean', handler: new BooleanType() } ]
     ] );
     protected rawArgs: string[] = [];
+    protected literalArgs: string[] = [];
     // @TODO: get script name: https://github.com/denoland/deno/pull/5034
     // protected name: string = location.pathname.split( '/' ).pop() as string;
     protected _name: string = 'COMMAND';
@@ -537,26 +538,28 @@ export class BaseCommand<O = any, A extends Array<any> = any> {
                 await this.executeExecutable( this.rawArgs );
             }
 
-            return { options: {} as O, args: this.rawArgs as any as A, cmd: this };
+            return { options: {} as O, args: this.rawArgs as any as A, cmd: this, literal: this.literalArgs };
 
         } else if ( this._useRawArgs ) {
 
             if ( dry ) {
-                return { options: {} as O, args: this.rawArgs as any as A, cmd: this };
+                return { options: {} as O, args: this.rawArgs as any as A, cmd: this, literal: this.literalArgs };
             }
 
             return await this.execute( {} as O, ...this.rawArgs as A );
 
         } else {
 
-            const { flags, unknown } = this.parseFlags( this.rawArgs, true );
+            const { flags, unknown, literal } = this.parseFlags( this.rawArgs );
+
+            this.literalArgs = literal;
 
             const params = this.parseArguments( unknown, flags );
 
             this.validateEnvVars();
 
             if ( dry ) {
-                return { options: flags, args: params as any as A, cmd: this };
+                return { options: flags, args: params as any as A, cmd: this, literal: this.literalArgs };
             }
 
             return await this.execute( flags, ...params );
@@ -575,7 +578,7 @@ export class BaseCommand<O = any, A extends Array<any> = any> {
 
         if ( actionOption && actionOption.action ) {
             await actionOption.action( options, ...args );
-            return { options, args: args as any as A, cmd: this };
+            return { options, args: args as any as A, cmd: this, literal: this.literalArgs };
         }
 
         if ( this.fn ) {
@@ -601,7 +604,7 @@ export class BaseCommand<O = any, A extends Array<any> = any> {
             }
         }
 
-        return { options, args: args as any as A, cmd: this };
+        return { options, args: args as any as A, cmd: this, literal: this.literalArgs };
     }
 
     /**
@@ -1392,6 +1395,10 @@ export class BaseCommand<O = any, A extends Array<any> = any> {
         return this.examples.find( example => example.name === name );
     }
 
+    public getLiteralArgs(): string[] {
+        return this.literalArgs;
+    }
+
     /********************************************************************************
      **** HELPER ********************************************************************
      ********************************************************************************/

packages/command/lib/types.ts

@@ -1,7 +1,6 @@
-import { BaseCommand } from './base-command.ts';
-import { ITypeHandler } from '../../flags/lib/types.ts';
-import { IFlagArgument, IFlagOptions, IGenericObject, OptionType } from '../../flags/lib/types.ts';
+import { IFlagArgument, IFlagOptions, ITypeHandler, OptionType } from '../../flags/lib/types.ts';
 import { Type } from '../types/type.ts';
+import { BaseCommand } from './base-command.ts';
 
 /** Action handler. */
 export type IAction<O, A extends Array<any>> = ( options: O, ...args: A ) => void | Promise<void>;
@@ -77,8 +76,9 @@ export interface IExample {
 
 /** Result of `cmd.parse()`. */
 export interface IParseResult<O = any, A extends Array<any> = any> {
-    options: O,
-    args: A
+    options: O;
+    args: A;
+    literal: string[];
     cmd: BaseCommand<O>;
 }
 

packages/command/test/command/literal-arguments_test.ts

@@ -0,0 +1,15 @@
+import { Command } from '../../lib/command.ts';
+import { assertEquals } from '../lib/assert.ts';
+
+Deno.test( 'command literal arguments', async () => {
+
+    const { options, args, literal } = await new Command()
+        .throwErrors()
+        .option( '-f, --flag [val:string]', '...' )
+        .action( () => {} )
+        .parse( [ '-f', 'value', '--', '-t', 'abc' ] );
+
+    assertEquals( options, { flag: 'value' } );
+    assertEquals( args, [] );
+    assertEquals( literal, [ '-t', 'abc' ] );
+} );