feat: Add support for the --config flag and passing extra flags to the deno process

Author: KallynGowdy

.gitignore

@@ -1,4 +1,5 @@
 node_modules/
 dist/
 docs/
-tmp/
+tmp/
+src/test/deno.lock

src/DenoWorker.spec.ts

@@ -749,6 +749,129 @@ describe('DenoWorker', () => {
             });
         });
 
+        describe('denoConfig', async () => {
+            afterEach(() => {
+                jest.clearAllMocks();
+            });
+
+            it('should not include --config by default', async () => {
+                const spawnSpy = jest.spyOn(child_process, 'spawn');
+
+                worker = new DenoWorker(echoScript);
+
+                let resolve: any;
+                let promise = new Promise((res, rej) => {
+                    resolve = res;
+                });
+                worker.onmessage = (e) => {
+                    resolve();
+                };
+
+                worker.postMessage({
+                    type: 'echo',
+                    message: 'Hello',
+                });
+
+                await promise;
+
+                const call = spawnSpy.mock.calls[0];
+                const [_deno, args] = call;
+                expect(args).not.toContain('--config');
+
+                // should pass --no-config when denoConfig is omitted
+                expect(args).toContain('--no-config');
+            });
+
+            it('should not set --config by when denoConfig is empty', async () => {
+                const spawnSpy = jest.spyOn(child_process, 'spawn');
+
+                worker = new DenoWorker(echoScript, { denoConfig: '' });
+
+                let resolve: any;
+                let promise = new Promise((res, rej) => {
+                    resolve = res;
+                });
+                worker.onmessage = (e) => {
+                    resolve();
+                };
+
+                worker.postMessage({
+                    type: 'echo',
+                    message: 'Hello',
+                });
+
+                await promise;
+
+                const call = spawnSpy.mock.calls[0];
+                const [_deno, args] = call;
+                expect(args).not.toContain('--config');
+
+                // should pass --no-config when denoConfig is empty
+                expect(args).toContain('--no-config');
+            });
+
+            it('should set --config when denoConfig is nonempty', async () => {
+                const spawnSpy = jest.spyOn(child_process, 'spawn');
+                const configPath = path.resolve('./src/test/deno.json');
+                worker = new DenoWorker(echoScript, {
+                    denoConfig: configPath,
+                });
+
+                let resolve: any;
+                let promise = new Promise((res, rej) => {
+                    resolve = res;
+                });
+                worker.onmessage = (e) => {
+                    resolve();
+                };
+
+                worker.postMessage({
+                    type: 'echo',
+                    message: 'Hello',
+                });
+
+                await promise;
+
+                const call = spawnSpy.mock.calls[0];
+                const [_deno, args] = call;
+                expect(args).toContain(`--config=${configPath}`);
+            });
+        });
+
+        describe('denoExtraFlags', async () => {
+            afterEach(() => {
+                jest.clearAllMocks();
+            });
+
+            it('should include the given extra flags', async () => {
+                const spawnSpy = jest.spyOn(child_process, 'spawn');
+
+                worker = new DenoWorker(echoScript, {
+                    denoExtraFlags: ['--unstable', '--inspect'],
+                });
+
+                let resolve: any;
+                let promise = new Promise((res, rej) => {
+                    resolve = res;
+                });
+                worker.onmessage = (e) => {
+                    resolve();
+                };
+
+                worker.postMessage({
+                    type: 'echo',
+                    message: 'Hello',
+                });
+
+                await promise;
+
+                const call = spawnSpy.mock.calls[0];
+                const [_deno, args] = call;
+                expect(args).toContain('--unstable');
+                expect(args).toContain('--inspect');
+            });
+        });
+
         describe('denoV8Flags', async () => {
             afterEach(() => {
                 jest.clearAllMocks();

src/DenoWorker.ts

@@ -160,17 +160,22 @@ export interface DenoWorkerOptions {
     denoNoCheck: boolean;
 
     /**
-     * Whether to prevent Deno from loading a config file.
-     * Defaults to true.
+     * The path to the config file that Deno should use.
      */
-    denoNoConfig: boolean;
+    denoConfig: string;
 
     /**
      * Whether to prevent Deno from loading packages from npm.
      * Defaults to true.
      */
     denoNoNPM: boolean;
 
+    /**
+     * Extra flags that should be passed to Deno.
+     * This may be useful for passing flags that are not supported by this library.
+     */
+    denoExtraFlags: string[];
+
     /**
      * Allow Deno to make requests to hosts with certificate
      * errors.
@@ -305,9 +310,10 @@ export class DenoWorker {
                 denoLockFilePath: '',
                 denoCachedOnly: false,
                 denoNoCheck: false,
-                denoNoConfig: true,
+                denoConfig: undefined,
                 denoNoNPM: true,
                 unsafelyIgnoreCertificateErrors: false,
+                denoExtraFlags: [],
                 spawnOptions: {},
             },
             options || {}
@@ -419,7 +425,11 @@ export class DenoWorker {
             }
             addOption(runArgs, '--cached-only', this._options.denoCachedOnly);
             addOption(runArgs, '--no-check', this._options.denoNoCheck);
-            addOption(runArgs, '--no-config', this._options.denoNoConfig);
+            if (!this._options.denoConfig) {
+                addOption(runArgs, '--no-config', true);
+            } else {
+                addOption(runArgs, '--config', [this._options.denoConfig]);
+            }
             addOption(runArgs, '--no-npm', this._options.denoNoNPM);
             addOption(
                 runArgs,
@@ -501,6 +511,10 @@ export class DenoWorker {
                 }
             }
 
+            if (this._options.denoExtraFlags.length > 0) {
+                runArgs.push(...this._options.denoExtraFlags);
+            }
+
             this._process = spawn(
                 this._options.denoExecutable,
                 [

src/test/deno.json

@@ -0,0 +1 @@
+{}