Add CLI flag and docs

mozilla · Oct 15, 2023 · 9d0512a · 9d0512a
1 parent 4dffb2d
commit 9d0512a
Show file tree

Hide file tree

Showing 3 changed files with 33 additions and 0 deletions.
diff --git a/src/cmd/run.js b/src/cmd/run.js
@@ -49,6 +49,7 @@ export default async function run(
     firefoxApkComponent,
     // Chromium CLI options.
     chromiumBinary,
+    chromiumPref,
     chromiumProfile,
   },
   {
@@ -86,6 +87,10 @@ export default async function run(
     customPrefs['extensions.manifestV3.enabled'] = true;
   }
 
+  // Create an alias for --chromium-pref since it has been transformed into an
+  // object containing one or more preferences.
+  const customChromiumPrefs = { ...chromiumPref };
+
   const manifestData = await getValidatedManifest(sourceDir);
 
   const profileDir = firefoxProfile || chromiumProfile;
@@ -193,6 +198,7 @@ export default async function run(
       ...commonRunnerParams,
       chromiumBinary,
       chromiumProfile,
+      customChromiumPrefs,
     };
 
     const chromiumRunner = await createExtensionRunner({

diff --git a/src/program.js b/src/program.js
@@ -653,6 +653,18 @@ Example: $0 --help run.
         demandOption: false,
         type: 'string',
       },
+      'chromium-pref': {
+        describe:
+          'Launch chromium with a custom preference ' +
+          '(example: --chromium-pref=browser.theme.follows_system_colors=false). ' +
+          'You can repeat this option to set more than one ' +
+          'preference.',
+        demandOption: false,
+        requiresArg: true,
+        type: 'array',
+        coerce: (arg) =>
+          arg != null ? coerceCLICustomPreference(arg) : undefined,
+      },
       'chromium-profile': {
         describe: 'Path to a custom Chromium profile',
         demandOption: false,

diff --git a/tests/unit/test.program.js b/tests/unit/test.program.js
@@ -627,6 +627,21 @@ describe('program.main', () => {
     });
   });
 
+  it('converts custom chromium preferences into an object', () => {
+    const fakeCommands = fake(commands, {
+      run: () => Promise.resolve(),
+    });
+    return execProgram(
+      ['run', '--chromium-pref', 'prop=true', '--chromium-pref', 'prop2=value2'],
+      { commands: fakeCommands },
+    ).then(() => {
+      const { chromiumPref } = fakeCommands.run.firstCall.args[0];
+      assert.isObject(chromiumPref);
+      assert.equal(chromiumPref.prop, true);
+      assert.equal(chromiumPref.prop2, 'value2');
+    });
+  });
+
   it('passes shouldExitProgram option to commands', () => {
     const fakeCommands = fake(commands, {
       lint: () => Promise.resolve(),