bob-core 0.6.3 → 0.8.0

package/dist/Command.d.ts

@@ -17,5 +17,5 @@ export declare abstract class Command<C = undefined> extends CommandHelper {
     protected abstract handle(): Promise<void | number>;
     run(ctx: C, ...args: any[]): Promise<number>;
     protected option(key: string, defaultValue?: any): string | null;
-    protected argument(key: string, defaultValue?: any): string | null;
+    protected argument(key: string, defaultValue?: any): string | Array<string> | null;
 }

package/dist/Command.js

@@ -26,7 +26,7 @@ class Command extends CommandHelper_1.CommandHelper {
     option(key, defaultValue = null) {
         return this.parser.option(key) ?? defaultValue;
     }
-    argument(key, defaultValue) {
+    argument(key, defaultValue = null) {
         return this.parser.argument(key) ?? defaultValue;
     }
 }

package/dist/CommandHelper.js

@@ -13,6 +13,7 @@ class CommandHelper {
             {
                 name: 'help',
                 optional: true,
+                type: 'boolean',
                 help: (0, chalk_1.default) `Display help for the given command. When no command is given display help for the {green list} command`,
                 alias: ['h']
             }
@@ -38,14 +39,30 @@ class CommandHelper {
             log((0, chalk_1.default) `\n{yellow Arguments}:`);
             for (const signature of availableArguments) {
                 const spaces = (0, string_1.generateSpace)(maxLength - signature.name.length);
-                log((0, chalk_1.default) `  {green ${signature.name}} ${spaces} ${signature.help ?? '\b'} ${signature.defaultValue !== undefined && signature.optional ? (0, chalk_1.default) `{yellow [default: ${signature.defaultValue}]}` : ''}`);
+                let message = (0, chalk_1.default) `  {green ${signature.name}} ${spaces} ${signature.help ?? '\b'}`;
+                if (signature.defaultValue !== undefined && signature.optional) {
+                    const defaultValue = signature.type === 'array' ? JSON.stringify(signature.defaultValue) : signature.defaultValue;
+                    message += (0, chalk_1.default) ` {yellow [default: ${defaultValue}]}`;
+                }
+                if (signature.variadic) {
+                    message += (0, chalk_1.default) ` {white (variadic)}`;
+                }
+                log(message);
             }
         }
         if (availableOptions.length > 0) {
             log((0, chalk_1.default) `\n{yellow Options}:`);
             for (const signature of availableOptions) {
                 const spaces = (0, string_1.generateSpace)(maxLength - signature.optionWithAlias.length);
-                log((0, chalk_1.default) `  {green ${signature.optionWithAlias}} ${spaces} ${signature.help ?? '\b'}  ${signature.defaultValue !== undefined && signature.optional ? (0, chalk_1.default) `{yellow [default: ${signature.defaultValue}]}` : ''}`);
+                let message = (0, chalk_1.default) `{green ${signature.optionWithAlias}} ${spaces} ${signature.help ?? '\b'}`;
+                if (signature.type) {
+                    message += (0, chalk_1.default) ` {white (${signature.type})}`;
+                }
+                if (signature.defaultValue !== undefined && signature.optional) {
+                    const defaultValue = signature.type === 'array' ? JSON.stringify(signature.defaultValue) : signature.defaultValue;
+                    message += (0, chalk_1.default) ` {yellow [default: ${defaultValue}]}`;
+                }
+                log(message);
             }
         }
         if (this.commandsExamples.length > 0) {

package/dist/Parser.d.ts

@@ -1,9 +1,11 @@
 export type ArgSignature = {
     name: string;
-    optional: boolean;
+    type: string;
+    optional?: boolean;
+    variadic?: boolean;
     alias?: string[];
     help?: string;
-    defaultValue?: string | boolean | null;
+    defaultValue?: string | boolean | Array<string> | null;
     isOption?: boolean;
 };
 export declare class Parser {

package/dist/Parser.js

@@ -15,6 +15,25 @@ class Parser {
     argumentsSignature = {};
     optionsSignature = {};
     option(name) {
+        if (!this.optionsSignature[name]) {
+            throw new Error(`Option ${name} not found`);
+        }
+        const signature = this.optionsSignature[name];
+        if (signature.type === 'boolean') {
+            if (this.options[name] === 'true' || this.options[name] === '1') {
+                return true;
+            }
+            else if (this.options[name] === 'false' || this.options[name] === '0') {
+                return false;
+            }
+            return Boolean(this.options[name]);
+        }
+        if (signature.type === 'array') {
+            if (!this.options[name]) {
+                return [];
+            }
+            return Array.isArray(this.options[name]) ? this.options[name] : [this.options[name]];
+        }
         return this.options[name];
     }
     argument(name) {
@@ -49,8 +68,14 @@ class Parser {
                 }
             }
             else {
-                const paramValue = paramValues.shift();
-                this.arguments[param.name] = paramValue ?? param.defaultValue ?? null;
+                if (param.variadic) {
+                    const paramValue = paramValues.splice(0, paramValues.length);
+                    this.arguments[param.name] = paramValue ?? [];
+                }
+                else {
+                    const paramValue = paramValues.shift();
+                    this.arguments[param.name] = paramValue ?? param.defaultValue ?? null;
+                }
                 this.argumentsSignature[param.name] = param;
             }
         }
@@ -58,15 +83,22 @@ class Parser {
     parseParamSignature(argument) {
         let cleanedArgs = argument;
         let isOptional = false;
-        if (argument.endsWith('?')) {
+        let isVariadic = false;
+        if (cleanedArgs.endsWith('?')) {
             cleanedArgs = cleanedArgs.slice(0, -1);
             isOptional = true;
         }
+        if (cleanedArgs.endsWith('*')) {
+            cleanedArgs = cleanedArgs.slice(0, -1);
+            isVariadic = true;
+        }
         const arg = {
             name: cleanedArgs,
             optional: isOptional,
+            type: isVariadic ? 'array' : 'string',
             help: undefined,
-            defaultValue: null,
+            defaultValue: isVariadic ? [] : null,
+            variadic: isVariadic,
             isOption: false
         };
         if (arg.name.includes(':')) {
@@ -84,14 +116,18 @@ class Parser {
             }
             else if (arg.defaultValue === 'true') {
                 arg.defaultValue = true;
+                arg.type = 'boolean';
             }
             else if (arg.defaultValue === 'false') {
                 arg.defaultValue = false;
+                arg.type = 'boolean';
             }
         }
         else {
             if (arg.name.startsWith('--')) {
+                arg.optional = true;
                 arg.defaultValue = false;
+                arg.type = 'boolean';
             }
         }
         if (arg.name.includes('|')) {
@@ -103,9 +139,11 @@ class Parser {
             arg.isOption = true;
             arg.name = arg.name.slice(2);
         }
-        if (this.helperDefinitions[arg.name]) {
-            arg.help = this.helperDefinitions[arg.name];
+        if (arg.defaultValue === '*') {
+            arg.defaultValue = [];
+            arg.type = 'array';
         }
+        arg.help = arg.help ?? this.helperDefinitions[arg.name] ?? this.helperDefinitions[`--${arg.name}`];
         return arg;
     }
     validate() {
@@ -115,6 +153,9 @@ class Parser {
             if (!value && !argSignature.optional) {
                 throw new MissingRequiredArgumentValue_1.MissingRequiredArgumentValue(argSignature);
             }
+            if (!value?.length && argSignature.variadic && !argSignature.optional) {
+                throw new MissingRequiredArgumentValue_1.MissingRequiredArgumentValue(argSignature);
+            }
         }
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bob-core",
-  "version": "0.6.3",
+  "version": "0.8.0",
   "description": "BOB Core",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",