docs(command): add executable example commands

c4spar · May 21, 2020 · 8fbe263 · 8fbe263
1 parent fa131eb
commit 8fbe263
Show file tree

Hide file tree

Showing 5 changed files with 115 additions and 94 deletions.
diff --git a/...s/command/arguments-syntax-sub-command.ts → ...ples/command/arguments-syntax-variadic.ts b/...s/command/arguments-syntax-sub-command.ts → ...ples/command/arguments-syntax-variadic.ts
diff --git a/examples/command/custom-option-processing.ts b/examples/command/custom-option-processing.ts
@@ -3,14 +3,10 @@
 import { Command } from '../../packages/command/lib/command.ts';
 
 const { options } = await new Command()
-    .option( '-f, --float <value:number>', 'float argument' )
-    .option( '-i, --integer <value:number>', 'integer argument' )
-    .option( '-v, --variadic <value...:string>', 'repeatable value' )
-    .option( '-l, --list <items:string[]>', 'comma separated list' )
     .option( '-o, --object <item:string>', 'map string to object', ( value: string ): { value: string } => {
         return { value };
     } )
-    .option( '-C, --color <item:string>', 'map string to object', {
+    .option( '-C, --color <item:string>', 'collect colors', {
         collect: true,
         value: ( value: string, previous: string[] = [] ): string[] => {
 

diff --git a/examples/command/custom-option-type.ts b/examples/command/custom-option-type.ts
@@ -7,15 +7,13 @@ const email = (): ITypeHandler<string> => {
 
     const emailRegex: RegExp = /^(([^<>()\[\]\\.,;:\s@"]+(\.[^<>()\[\]\\.,;:\s@"]+)*)|(".+"))@((\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\])|(([a-zA-Z\-0-9]+\.)+[a-zA-Z]{2,}))$/;
 
-    return ( option: IFlagOptions, arg: IFlagArgument, value: string | false ): string | undefined => {
+    return ( option: IFlagOptions, arg: IFlagArgument, value: string ): string => {
 
-        if ( value ) {
-            if ( !emailRegex.test( value.toLowerCase() ) ) {
-                throw new Error( `Option --${ option.name } must be a valid email but got: ${ value }` );
-            }
+        if ( !emailRegex.test( value.toLowerCase() ) ) {
+            throw new Error( `Option --${ option.name } must be a valid email but got: ${ value }` );
         }
 
-        return value || undefined;
+        return value;
     };
 };
 

diff --git a/examples/command/environment-variables.ts b/examples/command/environment-variables.ts
@@ -6,4 +6,4 @@ await new Command()
     .env( 'SOME_ENV_VAR=<value:number>', 'Description ...' )
     .parse( Deno.args );
 
-console.log( Deno.env().SOME_ENV_VAR );
+console.log( Deno.env.get( 'SOME_ENV_VAR' ) );