yeoman-test 8.1.0 → 8.2.0

package/dist/run-context.d.ts

@@ -203,7 +203,11 @@ export declare class RunContextBase<GeneratorType extends BaseGenerator = Defaul
      * });
      */
     withGenerators(dependencies: Dependency[]): this;
-    withSpawnMock(stub?: import("sinon").SinonStub<any[], any>): this;
+    withSpawnMock(options?: ((...args: any[]) => any) | {
+        stub?: (...args: any[]) => any;
+        registerSinonDefaults?: boolean;
+        callback?: (stub: any) => void | Promise<void>;
+    }): this;
     withMockedGeneratorFactory(mockedGeneratorFactory: MockedGeneratorFactory): this;
     /**
      * Create mocked generators

package/dist/run-context.js

@@ -311,15 +311,35 @@ export class RunContextBase extends EventEmitter {
             }
         });
     }
-    withSpawnMock(stub = sinonStub()) {
+    withSpawnMock(options) {
         if (this.spawnStub) {
             throw new Error('Multiple withSpawnMock calls');
         }
+        const stub = typeof options === 'function' ? options : options?.stub ?? sinonStub();
+        const registerSinonDefaults = typeof options === 'function' ? false : options?.registerSinonDefaults ?? true;
+        const callback = typeof options === 'function' ? undefined : options?.callback;
+        if (registerSinonDefaults) {
+            // eslint-disable-next-line @typescript-eslint/no-empty-function
+            const defaultChild = { stdout: { on() { } }, stderr: { on() { } } };
+            const defaultReturn = { exitCode: 0, stdout: '', stderr: '' };
+            const stubFn = stub;
+            // eslint-disable-next-line @typescript-eslint/promise-function-async
+            stubFn.withArgs('spawnCommand').callsFake(() => Object.assign(Promise.resolve({ ...defaultReturn }), defaultChild));
+            // eslint-disable-next-line @typescript-eslint/promise-function-async
+            stubFn.withArgs('spawn').callsFake(() => Object.assign(Promise.resolve({ ...defaultReturn }), defaultChild));
+            stubFn.withArgs('spawnCommandSync').callsFake(() => ({ ...defaultReturn }));
+            stubFn.withArgs('spawnSync').callsFake(() => ({ ...defaultReturn }));
+        }
+        if (callback) {
+            this.onBeforePrepare(async () => {
+                await callback(stub);
+            });
+        }
         this.spawnStub = stub;
         return this.onEnvironment(env => {
             env.on('compose', (_namespace, generator) => {
                 const createCallback = method => function (...args) {
-                    stub.call(this, method, ...args);
+                    return stub.call(this, method, ...args);
                 };
                 generator.spawnCommand = createCallback('spawnCommand');
                 generator.spawnCommandSync = createCallback('spawnCommandSync');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "yeoman-test",
-  "version": "8.1.0",
+  "version": "8.2.0",
   "description": "Test utilities for Yeoman generators",
   "keywords": [
     "yeoman",