@oclif/core 4.0.36 → 4.1.0

package/lib/interfaces/parser.d.ts

@@ -167,6 +167,10 @@ export type FlagProps = {
      * This is helpful if the default value contains sensitive data that shouldn't be published to npm.
      */
     noCacheDefault?: boolean;
+    /**
+     * At least one of these flags must be provided.
+     */
+    atLeastOne?: string[];
 };
 export type ArgProps = {
     name: string;

package/lib/parser/validate.js

@@ -64,7 +64,10 @@ async function validate(parse) {
                 return [{ name, reason: `Missing required flag ${name}`, status: 'failed', validationFn: 'required' }];
             }
             if (flag.exactlyOne && flag.exactlyOne.length > 0) {
-                return [validateAcrossFlags(flag)];
+                return [validateExactlyOneAcrossFlags(flag)];
+            }
+            if (flag.atLeastOne && flag.atLeastOne.length > 0) {
+                return [validateAtLeastOneAcrossFlags(flag)];
             }
             return [];
         });
@@ -91,8 +94,8 @@ async function validate(parse) {
         return cachedResolvedFlags;
     }
     const getPresentFlags = (flags) => Object.keys(flags).filter((key) => key !== undefined);
-    function validateAcrossFlags(flag) {
-        const base = { name: flag.name, validationFn: 'validateAcrossFlags' };
+    function validateExactlyOneAcrossFlags(flag) {
+        const base = { name: flag.name, validationFn: 'validateExactlyOneAcrossFlags' };
         const intersection = Object.entries(parse.input.flags)
             .map((entry) => entry[0]) // array of flag names
             .filter((flagName) => parse.output.flags[flagName] !== undefined) // with values
@@ -105,6 +108,20 @@ async function validate(parse) {
         }
         return { ...base, status: 'success' };
     }
+    function validateAtLeastOneAcrossFlags(flag) {
+        const base = { name: flag.name, validationFn: 'validateAtLeastOneAcrossFlags' };
+        const intersection = Object.entries(parse.input.flags)
+            .map((entry) => entry[0]) // array of flag names
+            .filter((flagName) => parse.output.flags[flagName] !== undefined) // with values
+            .filter((flagName) => flag.atLeastOne && flag.atLeastOne.includes(flagName)); // and in the atLeastOne list
+        if (intersection.length === 0) {
+            // the command's atLeastOne may or may not include itself, so we'll use Set to add + de-dupe
+            const deduped = (0, util_1.uniq)(flag.atLeastOne?.map((flag) => `--${flag}`) ?? []).join(', ');
+            const reason = `At least one of the following must be provided: ${deduped}`;
+            return { ...base, reason, status: 'failed' };
+        }
+        return { ...base, status: 'success' };
+    }
     async function validateExclusive(name, flags) {
         const base = { name, validationFn: 'validateExclusive' };
         const resolved = await resolveFlags(flags);

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@oclif/core",
   "description": "base library for oclif CLIs",
-  "version": "4.0.36",
+  "version": "4.1.0",
   "author": "Salesforce",
   "bugs": "https://github.com/oclif/core/issues",
   "dependencies": {
@@ -51,7 +51,7 @@
     "cross-env": "^7.0.3",
     "eslint": "^8.57.1",
     "eslint-config-oclif": "^5.2.2",
-    "eslint-config-oclif-typescript": "^3.1.12",
+    "eslint-config-oclif-typescript": "^3.1.13",
     "eslint-config-prettier": "^9.1.0",
     "husky": "^9.1.7",
     "lint-staged": "^15",