feat: handle mutually exclusive args in cli (trufflesuite#732)

Author: davidmurdoch

src/chains/ethereum/options/src/database-options.ts

@@ -38,13 +38,15 @@ export const DatabaseOptions: Definitions<DatabaseConfig> = {
     normalize,
     cliDescription: "Specify an alternative database instance, like MemDOWN",
     disableInCLI: true,
-    legacyName: "db"
+    legacyName: "db",
+    conflicts: ["dbPath"]
   },
   dbPath: {
     normalize,
     cliDescription: "Specify a path to a directory to save the chain database.",
     legacyName: "db_path",
     cliAliases: ["db", "db_path"],
-    cliType: "string"
+    cliType: "string",
+    conflicts: ["db"]
   }
 };

src/chains/ethereum/options/src/wallet-options.ts

@@ -200,7 +200,8 @@ export const WalletOptions: Definitions<WalletConfig> = {
     default: () => 10,
     legacyName: "total_accounts",
     cliAliases: ["a", "accounts"],
-    cliType: "number"
+    cliType: "number",
+    conflicts: ["accounts"]
   },
   accounts: {
     normalize,
@@ -217,14 +218,16 @@ export const WalletOptions: Definitions<WalletConfig> = {
           balance: BigInt(balance)
         } as OptionsAccount;
       });
-    }
+    },
+    conflicts: ["totalAccounts"]
   },
   deterministic: {
     normalize,
     cliDescription: "Use pre-defined, deterministic seed.",
     default: () => false,
     cliAliases: ["d", "deterministic"],
-    cliType: "boolean"
+    cliType: "boolean",
+    conflicts: ["mnemonic", "seed"]
   },
   seed: {
     normalize,
@@ -240,7 +243,8 @@ export const WalletOptions: Definitions<WalletConfig> = {
       "Random value, unless wallet.deterministic is specified",
     legacyName: "seed",
     cliAliases: ["s", "seed"],
-    cliType: "string"
+    cliType: "string",
+    conflicts: ["mnemonic", "deterministic"]
   },
   mnemonic: {
     normalize,
@@ -254,7 +258,8 @@ export const WalletOptions: Definitions<WalletConfig> = {
     defaultDescription: "Generated from wallet.seed",
     legacyName: "mnemonic",
     cliAliases: ["m", "mnemonic"],
-    cliType: "string"
+    cliType: "string",
+    conflicts: ["seed", "deterministic"]
   },
   unlockedAccounts: {
     normalize,

src/packages/cli/src/args.ts

@@ -93,6 +93,12 @@ function processOption(
       coerce: optionObj.cliCoerce
     };
 
+    if ("conflicts" in optionObj) {
+      options.conflicts = (optionObj as {
+        conflicts: string[];
+      }).conflicts.map(c => `${category}.${c}`);
+    }
+
     const key = `${category}.${option}`;
 
     // First, create *hidden* deprecated aliases...

src/packages/options/src/definition.ts

@@ -1,5 +1,8 @@
 import { Base, CliTypeMap, CliTypes } from "./base";
-import { ExclusiveGroupUnionAndUnconstrainedPlus } from "./exclusive";
+import {
+  ExclusiveGroupsByName,
+  ExclusiveGroupUnionAndUnconstrainedPlus
+} from "./exclusive";
 import {
   Legacy,
   OptionCliType,
@@ -33,22 +36,31 @@ export type Definitions<C extends Base.Config> = {
     readonly disableInCLI?: boolean;
     readonly cliAliases?: string[];
     readonly cliChoices?: string[] | number[];
-  } & (void extends OptionHasCliType<C, N>
-    ? {
-        readonly cliType?: CliTypeMap<CliTypes> | null;
-      }
+    // exclusiveGroups (conflicts)
+  } & (C[ExclusiveGroupsByName<C, N>] extends never
+    ? {}
     : {
-        readonly cliType?: CliTypeMap<OptionCliType<C, N>> | null;
-        readonly cliCoerce?: (
-          cliType: OptionCliType<C, N>
-        ) => OptionRawType<C, N>;
+        readonly conflicts: ExclusiveGroupsByName<C, N>[];
       }) &
+    // cliType
+    (void extends OptionHasCliType<C, N>
+      ? {
+          readonly cliType?: CliTypeMap<CliTypes> | null;
+        }
+      : {
+          readonly cliType?: CliTypeMap<OptionCliType<C, N>> | null;
+          readonly cliCoerce?: (
+            cliType: OptionCliType<C, N>
+          ) => OptionRawType<C, N>;
+        }) &
+    // hasDefault
     (void extends OptionHasDefault<C, N>
       ? {}
       : {
           readonly default: (config: InternalConfig<C>) => OptionType<C, N>;
           readonly defaultDescription?: string;
         }) &
+    // hasLegacy
     (void extends OptionHasLegacy<C, N>
       ? {}
       : {

src/packages/options/src/exclusive.ts

@@ -95,6 +95,20 @@ type Combine<
   ? I
   : never;
 
+export type ExclusiveGroupsByName<
+  C extends Base.Config,
+  N extends OptionName<C>,
+  GRPS extends ExclusiveGroups<C> = ExclusiveGroups<C>
+> = GRPS extends [infer GRP, ...infer Rest]
+  ? GRP extends unknown[]
+    ? N extends DeepTupleToUnion<GRP>
+      ? Exclude<DeepTupleToUnion<GRP>, N>
+      : Rest extends any[]
+      ? ExclusiveGroupsByName<C, N, Rest>
+      : never
+    : never
+  : never;
+
 type IsNeverType<T> = [T] extends [never] ? true : never;
 export type ExclusiveGroupUnionAndUnconstrainedPlus<
   C extends Base.Config,