yeoman-test 11.5.2 → 11.6.0

package/dist/run-context.d.ts

@@ -31,13 +31,13 @@ export type RunContextSettings = {
      */
     namespace?: string;
 };
-type PromiseRunResult<GeneratorType extends BaseGenerator> = Promise<RunResult<GeneratorType>>;
+type PromiseRunResult<GeneratorType extends BaseGenerator, ResultType = RunResult<GeneratorType>> = Promise<ResultType>;
 type MockedGeneratorFactory<GenParameter extends BaseGenerator = DefaultGeneratorApi> = (GeneratorClass?: GetGeneratorConstructor<GenParameter>) => GetGeneratorConstructor<GenParameter>;
 type EnvironmentOptions = BaseEnvironmentOptions & {
     createEnv?: CreateEnvironment;
 };
-export declare class RunContextBase<GeneratorType extends BaseGenerator = DefaultGeneratorApi> extends EventEmitter {
-    readonly mockedGenerators: Record<string, BaseGenerator>;
+export declare class RunContextBase<GeneratorType extends BaseGenerator = DefaultGeneratorApi, ResultType = RunResult<GeneratorType>> extends EventEmitter {
+    readonly mockedGenerators: Record<string, unknown>;
     env: DefaultEnvironmentApi;
     generator: GeneratorType;
     readonly settings: RunContextSettings;
@@ -81,11 +81,12 @@ export declare class RunContextBase<GeneratorType extends BaseGenerator = Defaul
      * @return {this}
      */
     constructor(generatorType?: string | GetGeneratorConstructor<GeneratorType>, settings?: RunContextSettings, environmentOptions?: EnvironmentOptions, helpers?: YeomanTest);
+    createRunResult(): ResultType;
     /**
      * Run the generator on the environment and promises a RunResult instance.
      * @return {PromiseRunResult} Promise a RunResult instance.
      */
-    run(): PromiseRunResult<GeneratorType>;
+    run(): PromiseRunResult<GeneratorType, ResultType>;
     on(eventName: string | symbol, listener: (...arguments_: any[]) => void): this;
     /**
      * @deprecated
@@ -153,14 +154,14 @@ export declare class RunContextBase<GeneratorType extends BaseGenerator = Defaul
      * @param {Function} [cb] - callback who'll receive the folder path as argument
      * @return {this} run context instance
      */
-    withEnvironment(callback: (this: this, environment: DefaultEnvironmentApi) => DefaultEnvironmentApi | void): this;
+    withEnvironment(callback: (this: this, environment: DefaultEnvironmentApi) => DefaultEnvironmentApi | void | Promise<DefaultEnvironmentApi | void>): this;
     /**
      * Customize enviroment run method.
      *
      * @param callback
      * @return {this} run context instance
      */
-    withEnvironmentRun(callback: (this: this, env: DefaultEnvironmentApi, gen: GeneratorType) => void): this;
+    withEnvironmentRun(callback: (this: this, env: DefaultEnvironmentApi, gen: GeneratorType) => void | Promise<void>): this;
     /**
      * Run lookup on the environment.
      *
@@ -306,7 +307,7 @@ export declare class RunContextBase<GeneratorType extends BaseGenerator = Defaul
      * Return a promise representing the generator run process
      * @return Promise resolved on end or rejected on error
      */
-    protected toPromise(): PromiseRunResult<GeneratorType>;
+    protected toPromise(): PromiseRunResult<GeneratorType, ResultType>;
     protected _createRunResultOptions(): RunResultOptions<GeneratorType>;
     /**
      * Keeps compatibility with events
@@ -321,10 +322,10 @@ export declare class RunContextBase<GeneratorType extends BaseGenerator = Defaul
      */
     private setDir;
 }
-export default class RunContext<GeneratorType extends BaseGenerator = BaseGenerator> extends RunContextBase<GeneratorType> implements Promise<RunResult<GeneratorType>> {
-    then<TResult1 = RunResult<GeneratorType>, TResult2 = never>(onfulfilled?: ((value: RunResult<GeneratorType>) => TResult1 | PromiseLike<TResult1>) | undefined, onrejected?: ((reason: any) => TResult2 | PromiseLike<TResult2>) | undefined): Promise<TResult1 | TResult2>;
-    catch<TResult = never>(onrejected?: ((reason: any) => TResult | PromiseLike<TResult>) | undefined): Promise<RunResult<GeneratorType> | TResult>;
-    finally(onfinally?: (() => void) | undefined): Promise<RunResult<GeneratorType>>;
+export default class RunContext<GeneratorType extends BaseGenerator = BaseGenerator, ResultType = RunResult<GeneratorType>> extends RunContextBase<GeneratorType, ResultType> implements Promise<ResultType> {
+    then<TResult1 = ResultType, TResult2 = never>(onfulfilled?: ((value: ResultType) => TResult1 | PromiseLike<TResult1>) | null | undefined, onrejected?: ((reason: any) => TResult2 | PromiseLike<TResult2>) | null | undefined): Promise<TResult1 | TResult2>;
+    catch<TResult = never>(onrejected?: ((reason: any) => TResult | PromiseLike<TResult>) | null | undefined): Promise<ResultType | TResult>;
+    finally(onfinally?: (() => void) | null | undefined): Promise<ResultType>;
     get [Symbol.toStringTag](): string;
 }
 export declare class BasicRunContext<GeneratorType extends BaseGenerator = BaseGenerator> extends RunContext<GeneratorType> {

package/dist/run-context.js

@@ -74,6 +74,9 @@ export class RunContextBase extends EventEmitter {
         this.memFs = settings?.memFs ?? createMemFs();
         this.mockedGeneratorFactory = this.helpers.createMockedGenerator;
     }
+    createRunResult() {
+        return new RunResult(this._createRunResultOptions());
+    }
     /**
      * Run the generator on the environment and promises a RunResult instance.
      * @return {PromiseRunResult} Promise a RunResult instance.
@@ -91,7 +94,7 @@ export class RunContextBase extends EventEmitter {
             this.helpers.restorePrompt(this.env);
             this.completed = true;
         }
-        const runResult = new RunResult(this._createRunResultOptions());
+        const runResult = this.createRunResult();
         testContext.runResult = runResult;
         return runResult;
     }
@@ -582,7 +585,7 @@ export class RunContextBase extends EventEmitter {
      * @return Promise resolved on end or rejected on error
      */
     async toPromise() {
-        return this.environmentPromise ?? this.run();
+        return (this.environmentPromise ?? this.run());
     }
     _createRunResultOptions() {
         return {

package/dist/run-result.d.ts

@@ -34,7 +34,7 @@ export type RunResultOptions<GeneratorType extends BaseGenerator> = {
     /**
      * The mocked generators of the context.
      */
-    mockedGenerators: Record<string, BaseGenerator>;
+    mockedGenerators: Record<string, unknown>;
     spawnStub?: any;
     settings: RunContextSettings;
     helpers: YeomanTest;
@@ -50,7 +50,7 @@ export default class RunResult<GeneratorType extends BaseGenerator = BaseGenerat
     oldCwd: string;
     memFs: Store<MemFsEditorFile>;
     fs: MemFsEditor;
-    mockedGenerators: Record<string, BaseGenerator>;
+    mockedGenerators: Record<string, unknown>;
     options: RunResultOptions<GeneratorType>;
     spawnStub?: any;
     readonly askedQuestions: AskedQuestions;
@@ -59,7 +59,7 @@ export default class RunResult<GeneratorType extends BaseGenerator = BaseGenerat
      * Create another RunContext reusing the settings.
      * See helpers.create api
      */
-    create<G extends BaseGenerator = GeneratorType>(GeneratorOrNamespace: string | GetGeneratorConstructor<G>, settings?: RunContextSettings, environmentOptions?: BaseEnvironmentOptions): import("./run-context.js").default<G>;
+    create<G extends BaseGenerator = GeneratorType>(GeneratorOrNamespace: string | GetGeneratorConstructor<G>, settings?: RunContextSettings, environmentOptions?: BaseEnvironmentOptions): import("./run-context.js").default<G, RunResult<G>>;
     getSpawnArgsUsingDefaultImplementation(): unknown[][];
     /**
      * Return an object with fs changes.
@@ -217,9 +217,9 @@ export default class RunResult<GeneratorType extends BaseGenerator = BaseGenerat
     /**
      * Get the generator mock
      * @param generator - the namespace of the mocked generator
-     * @returns the generator mock
+     * @returns the generator mock, by default is the mock property of node:test's mock.
      */
-    getGeneratorMock(generator: string): ReturnType<typeof mock.fn>['mock'];
+    getGeneratorMock<MockType = ReturnType<typeof mock.fn>['mock']>(generator: string): MockType;
     /**
      * Get the number of times a mocked generator was composed
      * @param generator - the namespace of the mocked generator

package/dist/run-result.js

@@ -271,14 +271,14 @@ export default class RunResult {
     /**
      * Get the generator mock
      * @param generator - the namespace of the mocked generator
-     * @returns the generator mock
+     * @returns the generator mock, by default is the mock property of node:test's mock.
      */
     getGeneratorMock(generator) {
         const mockedGenerator = this.mockedGenerators[generator];
         if (!mockedGenerator) {
             throw new Error(`Generator ${generator} is not mocked`);
         }
-        return mockedGenerator.mock;
+        return (mockedGenerator.mock ?? mockedGenerator);
     }
     /**
      * Get the number of times a mocked generator was composed

package/package.json

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