fix(compass-preferences-model): tell yargs about types for kebab case options (#3566)

Yargs is informed about the types of options where they can be determined, and
performs camel-case expansion on options specified in kebab case.

However, it does not apply those types in the latter case, making it so that
`--showed-network-opt-in foo` would lead to a `false` value for `showedNetworkOptIn`,
unlike `--showedNetworkOptIn foo`. Address this by also telling yargs about the
kebab-case versions explicitly.

Author: addaleax

package-lock.json

@@ -52,6 +52,7 @@
     "ampersand-state": "5.0.3",
     "bson": "^4.7.0",
     "js-yaml": "^4.1.0",
+    "lodash": "^4.17.21",
     "storage-mixin": "^5.1.0",
     "yargs-parser": "^21.1.1"
   },

packages/compass-preferences-model/package.json

@@ -82,6 +82,14 @@ describe('Global config file handling', function () {
     expect(result.cli).to.deep.equal({ enableMaps: true, theme: '' });
   });
 
+  it('knows the expected types of cli options when followed by an extra positional argument', async function () {
+    const result = await parseAndValidateGlobalPreferences({
+      globalConfigPaths: [],
+      argv: ['--showed-network-opt-in', 'about:blank'],
+    });
+    expect(result.cli).to.deep.equal({ showedNetworkOptIn: true });
+  });
+
   it('ignores CLI options that should be ignored', async function () {
     const result = await parseAndValidateGlobalPreferences({
       globalConfigPaths: [],

packages/compass-preferences-model/src/global-config.spec.ts

@@ -4,6 +4,7 @@ import { EJSON } from 'bson';
 import yaml from 'js-yaml';
 import type { Options as YargsOptions } from 'yargs-parser';
 import yargsParser from 'yargs-parser';
+import { kebabCase } from 'lodash';
 import type { AmpersandType, AllPreferences } from './preferences';
 import { allPreferencesProps } from './preferences';
 
@@ -91,9 +92,13 @@ const cliProps = Object.entries(allPreferencesProps).filter(
   ([, definition]) => definition.cli
 );
 function getCliPropNamesByType(type: AmpersandType<any>): string[] {
-  return cliProps
-    .filter(([, definition]) => definition.type === type)
-    .map(([key]) => key);
+  return [
+    ...new Set(
+      cliProps
+        .filter(([, definition]) => definition.type === type)
+        .flatMap(([key]) => [key, kebabCase(key)])
+    ),
+  ];
 }
 
 const yargsOptions: YargsOptions = {
@@ -106,6 +111,7 @@ const yargsOptions: YargsOptions = {
     'parse-numbers': false,
     // We validate options, so we don't want to keep --export-connections if we get --exportConnections
     'strip-dashed': true,
+    'camel-case-expansion': true,
   },
 };