yeoman-test 11.5.1 → 11.5.3

package/dist/helpers.d.ts

@@ -126,7 +126,7 @@ export declare class YeomanTest {
      * @param {Object} - Options to be passed to the environment
      * const env = createTestEnv(require('yeoman-environment').createEnv);
      */
-    createTestEnv(environmentContructor?: CreateEnv, options?: EnvironmentOptions): Promise<BaseEnvironment>;
+    createTestEnv(environmentContructor?: CreateEnv, options?: EnvironmentOptions): Promise<DefaultEnvironmentApi>;
     /**
      * Creates a TestAdapter using helpers default options.
      */

package/dist/run-context.d.ts

@@ -37,7 +37,7 @@ type EnvironmentOptions = BaseEnvironmentOptions & {
     createEnv?: CreateEnvironment;
 };
 export declare class RunContextBase<GeneratorType extends BaseGenerator = DefaultGeneratorApi> extends EventEmitter {
-    readonly mockedGenerators: Record<string, BaseGenerator>;
+    readonly mockedGenerators: Record<string, unknown>;
     env: DefaultEnvironmentApi;
     generator: GeneratorType;
     readonly settings: RunContextSettings;
@@ -153,14 +153,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.
      *

package/dist/run-context.js

@@ -263,9 +263,10 @@ export class RunContextBase extends EventEmitter {
         }
         // Add options as both kebab and camel case. This is to stay backward compatibles with
         // the switch we made to meow for options parsing.
+        const optionsAny = options;
         for (const key of Object.keys(options)) {
-            options[camelCase(key)] = options[key];
-            options[kebabCase(key)] = options[key];
+            optionsAny[camelCase(key)] = optionsAny[key];
+            optionsAny[kebabCase(key)] = optionsAny[key];
         }
         this.options = { ...this.options, ...options };
         return this;
@@ -290,7 +291,9 @@ export class RunContextBase extends EventEmitter {
      */
     withAnswers(answers, options) {
         this.answers = { ...this.answers, ...answers };
-        Object.assign(this.adapterOptions, options);
+        if (options) {
+            this.withAdapterOptions(options);
+        }
         return this;
     }
     /**

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: any;
+    mockedGenerators: Record<string, unknown>;
     options: RunResultOptions<GeneratorType>;
     spawnStub?: any;
     readonly askedQuestions: AskedQuestions;
@@ -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.1",
+  "version": "11.5.3",
   "description": "Test utilities for Yeoman generators",
   "keywords": [
     "yeoman",
@@ -40,7 +40,7 @@
     "fix": "prettier . --write && eslint . --fix",
     "precommit": "lint-staged",
     "prepare": "npm run build && husky",
-    "pretest": "eslint .",
+    "pretest": "eslint . && tsc -p tsconfig.spec.json",
     "test": "vitest run --coverage"
   },
   "config": {

package/types/type-helpers.d.ts

@@ -3,15 +3,7 @@ import type GeneratorImplementation from 'yeoman-generator';
 // eslint-disable-next-line @typescript-eslint/ban-ts-comment
 // @ts-ignore
 import type EnvironmentImplementation from 'yeoman-environment';
-import type { IfAny } from 'type-fest';
+import type { IsAny } from 'type-fest';
 
-export type DefaultGeneratorApi = IfAny<
-  typeof GeneratorImplementation,
-  BaseGenerator,
-  typeof GeneratorImplementation extends BaseGenerator ? typeof GeneratorImplementation : BaseGenerator
->;
-export type DefaultEnvironmentApi = IfAny<
-  typeof EnvironmentImplementation,
-  BaseEnvironment,
-  typeof EnvironmentImplementation extends BaseEnvironment ? typeof EnvironmentImplementation : BaseEnvironment
->;
+export type DefaultGeneratorApi = IsAny<GeneratorImplementation> extends true ? BaseGenerator : GeneratorImplementation;
+export type DefaultEnvironmentApi = IsAny<EnvironmentImplementation> extends true ? BaseEnvironment : EnvironmentImplementation;