@oclif/core 2.11.5 → 2.11.6

package/lib/interfaces/errors.d.ts

@@ -8,7 +8,7 @@ export interface OclifError {
 }
 export interface PrettyPrintableError {
     /**
-     * messsage to display related to the error
+     * message to display related to the error
      */
     message?: string;
     /**

package/lib/parser/errors.d.ts

@@ -22,8 +22,9 @@ export declare class InvalidArgsSpecError extends CLIParseError {
 }
 export declare class RequiredArgsError extends CLIParseError {
     args: Arg<any>[];
-    constructor({ args, parse }: CLIParseErrorOptions & {
+    constructor({ args, parse, flagsWithMultiple }: CLIParseErrorOptions & {
         args: Arg<any>[];
+        flagsWithMultiple?: string[];
     });
 }
 export declare class RequiredFlagError extends CLIParseError {

package/lib/parser/errors.js

@@ -30,13 +30,18 @@ class InvalidArgsSpecError extends CLIParseError {
 }
 exports.InvalidArgsSpecError = InvalidArgsSpecError;
 class RequiredArgsError extends CLIParseError {
-    constructor({ args, parse }) {
+    constructor({ args, parse, flagsWithMultiple }) {
         let message = `Missing ${args.length} required arg${args.length === 1 ? '' : 's'}`;
         const namedArgs = args.filter(a => a.name);
         if (namedArgs.length > 0) {
             const list = (0, list_1.renderList)(namedArgs.map(a => [a.name, a.description]));
             message += `:\n${list}`;
         }
+        if (flagsWithMultiple?.length) {
+            const flags = flagsWithMultiple.map(f => `--${f}`).join(', ');
+            message += `\n\nNote: ${flags} allow${flagsWithMultiple.length === 1 ? 's' : ''} multiple values. Because of this you need to provide all arguments before providing ${flagsWithMultiple.length === 1 ? 'that flag' : 'those flags'}.`;
+            message += '\nAlternatively, you can use "--" to signify the end of the flags and the beginning of arguments.';
+        }
         super({ parse, message });
         this.args = args;
     }

package/lib/parser/validate.js

@@ -30,7 +30,10 @@ async function validate(parse) {
             }
         }
         if (missingRequiredArgs.length > 0) {
-            throw new errors_1.RequiredArgsError({ parse, args: missingRequiredArgs });
+            const flagsWithMultiple = Object.entries(parse.input.flags)
+                .filter(([_, flagDef]) => flagDef.type === 'option' && Boolean(flagDef.multiple))
+                .map(([name]) => name);
+            throw new errors_1.RequiredArgsError({ parse, args: missingRequiredArgs, flagsWithMultiple });
         }
     }
     async function validateFlags() {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@oclif/core",
   "description": "base library for oclif CLIs",
-  "version": "2.11.5",
+  "version": "2.11.6",
   "author": "Salesforce",
   "bugs": "https://github.com/oclif/core/issues",
   "dependencies": {