deno_flags.deno.txt

              
   DENO_FLAGS  
              



ALTERNATIVES ==>                  #See yargs

VERSION ==>                       #See Deno doc

Deno.args                         #STR_ARR. CLI argv, excluding deno commands|flags

std/flags/mod.ts                  #
parse(STR_ARR[, OPTS])->FLAGS_OBJ #Parse CLI flags
                                  #STR_ARR is usually Deno.args

--FLAG
--FLAG=VAR
--FLAG VAR
-F
-F=VAR
-F VAR                            #Syntax of flags
-ABC...                           #Can use multiple single character flags in a row
CASE ==>                          #Case is not converted:
                                  #  - keep user-specified case as is
                                  #  - only matches user-specified case

FLAGS._                           #STR|NUM_ARR. Non-flags arguments (neither key|value)
OPTS.stopEarly                    #BOOL (def: false).
                                  #On the first non-flag argument, consider all following arguments as non-flag
                                  #E.g. ['a', '-b']:
                                  #  - false: { _: ['a'], b: true }
                                  #  - true: { _: ['a', '-b'] }
OPTS.--                           #BOOL (def: false). Split FLAGs._ into:
                                  #  - FLAGS._: before --
                                  #  - FLAGS.--: after --
                                  #In both cases, -- itself is not returned

OPTS.unknown                      #FUNC('RAW_ARG'[, 'FLAG', VAL])->BOOL
                                  #If returning false (def: true), ignore argument
                                  #Called on:
                                  #  - not a flag
                                  #     - FLAG|VAL are undefined then
                                  #  - flag not defined in OPTS.boolean|string|alias

OPTS.boolean                      #BOOL or 'FLAG'[_ARR] with type BOOL:
                                  #  - value transtyped to BOOL (including 'true|false')
                                  #  - default value false
                                  #If true, treats all flags as BOOL, except --FLAG=VAL or -F=VAL
                                  #If false (def), same as []
                                  #In any case, flags with no values are considered BOOL
OPTS.negatable                    #'FLAG'[_ARR] with value false when using --no-*
NUMBER FLAGS ==>                  #Automatically transtyped
                                  #  - except: after --
                                  #Including FLOAT
                                  #Including negative NUM, but only as --FLAG=-NUM or -F=-NUM
OPTS.string                       #'FLAG'[_ARR] (def: []) with type STR, i.e. no BOOL|NUM conversion
OPTS.collect                      #'FLAG'[_ARR] with type ARR.
                                  #  - flag must be repeated
                                  #  - default value []
OBJECT FLAGS ==>                  #'VARR' automatically converted to OBJ
                                  #NUM keys are considered OBJ keys, not ARR

OPTS.alias.FLAG                   #'FLAG2'[_ARR] alias name
                                  #FLAGS.* contains both name before|after aliasing

OPTS.default.FLAG                 #VAL. Default value