fix(cli): support --no-sandbox

Author: atjn

src/config/constants.ts

@@ -139,6 +139,10 @@ export default {
       alias: 'n',
       default: false,
     },
+    sandbox: {
+      type: 'boolean',
+      default: true,
+    },
   },
 
   CHROME_LAUNCH_ARGS: [

src/helpers/flags.ts

@@ -54,21 +54,25 @@ const getDefaultOptions = (): Options => {
 };
 
 const normalizeSandboxOption = (
-  noSandbox: boolean | undefined,
+  options: CLIOptions,
   logger: LoggerFunction,
 ): Partial<Options> => {
   let sandboxDisabled = false;
-  if (noSandbox) {
-    if (os.platform() !== 'linux') {
-      logger.warn(
-        'Disabling sandbox is only relevant on Linux platforms, request declined!',
-      );
-    } else {
-      sandboxDisabled = true;
-    }
+  if (options.noSandbox === true) {
+    sandboxDisabled = true;
+  }
+  if (options.sandbox === false) {
+    sandboxDisabled = true;
+  }
+  if (sandboxDisabled && os.platform() !== 'linux') {
+    logger.warn(
+      'Disabling sandbox is only relevant on Linux platforms, request declined!',
+    );
+    sandboxDisabled = false;
   }
   return {
     noSandbox: sandboxDisabled,
+    sandbox: !sandboxDisabled,
   };
 };
 

src/main.ts

@@ -63,7 +63,7 @@ async function generateImages(
         options,
         logger,
       ),
-      ...flags.normalizeSandboxOption(options.noSandbox, logger),
+      ...flags.normalizeSandboxOption(options, logger),
     };
   } else {
     modOptions = {

src/models/options.ts

@@ -156,6 +156,13 @@ export interface Options {
    @default false
    */
   readonly noSandbox: boolean;
+
+  /**
+   Enable sandbox on bundled Chromium on Linux platforms - recommended
+
+   @default true
+   */
+  readonly sandbox: boolean;
 }
 
 export type CLIOptions = Partial<Options>;