yeoman-test 11.5.0 → 11.5.2

package/dist/helpers.d.ts

@@ -21,7 +21,7 @@ export type Dependency = string | Parameters<DefaultEnvironmentApi['register']>;
 export declare class YeomanTest {
     settings?: RunContextSettings;
     environmentOptions?: EnvironmentOptions;
-    generatorOptions?: GeneratorOptions;
+    generatorOptions?: Partial<Omit<GeneratorOptions, 'env' | 'resolved' | 'namespace'>>;
     adapterOptions?: Omit<TestAdapterOptions, 'mockedAnswers'>;
     defaultGenerator?: string;
     importMeta?: Pick<ImportMeta, 'resolve'>;
@@ -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.
      */
@@ -136,21 +136,22 @@ export declare class YeomanTest {
      * @return {RunContext}
      */
     getRunContextType(): typeof RunContext;
+    createRunContext<GeneratorType extends BaseGenerator = DefaultGeneratorApi>(GeneratorOrNamespace: string | GetGeneratorConstructor<GeneratorType>, settings?: RunContextSettings, environmentOptions?: EnvironmentOptions): RunContext<GeneratorType>;
     /**
      * Run the provided Generator
      * @param GeneratorOrNamespace - Generator constructor or namespace
      */
-    run<GeneratorType extends BaseGenerator = DefaultGeneratorApi>(GeneratorOrNamespace: string | GetGeneratorConstructor<GeneratorType>, settings?: RunContextSettings, environmentOptions?: EnvironmentOptions): RunContext<GeneratorType>;
+    run<GeneratorType extends BaseGenerator = DefaultGeneratorApi>(GeneratorOrNamespace: string | GetGeneratorConstructor<GeneratorType>, settings?: RunContextSettings, environmentOptions?: EnvironmentOptions): ReturnType<typeof this.createRunContext<GeneratorType>>;
     /**
      * Run the default generator
      */
-    runDefault<GeneratorType extends BaseGenerator = BaseGenerator>(settings?: RunContextSettings, environmentOptions?: EnvironmentOptions): RunContext<GeneratorType>;
+    runDefault<GeneratorType extends BaseGenerator = BaseGenerator>(settings?: RunContextSettings, environmentOptions?: EnvironmentOptions): ReturnType<typeof this.createRunContext<GeneratorType>>;
     /**
      * Prepare a run context
      * @param  {String|Function} GeneratorOrNamespace - Generator constructor or namespace
      * @return {RunContext}
      */
-    create<GeneratorType extends BaseGenerator = DefaultGeneratorApi>(GeneratorOrNamespace: string | GetGeneratorConstructor<GeneratorType>, settings?: RunContextSettings, environmentOptions?: EnvironmentOptions): RunContext<GeneratorType>;
+    create<GeneratorType extends BaseGenerator = DefaultGeneratorApi>(GeneratorOrNamespace: string | GetGeneratorConstructor<GeneratorType>, settings?: RunContextSettings, environmentOptions?: EnvironmentOptions): ReturnType<typeof this.createRunContext<GeneratorType>>;
     /**
      * Prepare temporary dir without generator support.
      * Generator and environment will be undefined.

package/dist/helpers.js

@@ -249,6 +249,10 @@ export class YeomanTest {
     getRunContextType() {
         return RunContext;
     }
+    createRunContext(GeneratorOrNamespace, settings, environmentOptions) {
+        const RunContext = this.getRunContextType();
+        return new RunContext(GeneratorOrNamespace, settings, environmentOptions, this);
+    }
     /**
      * Run the provided Generator
      * @param GeneratorOrNamespace - Generator constructor or namespace
@@ -256,7 +260,6 @@ export class YeomanTest {
     run(GeneratorOrNamespace, settings, environmentOptions) {
         const contextSettings = cloneDeep(this.settings ?? {});
         const generatorOptions = cloneDeep(this.generatorOptions ?? {});
-        const RunContext = this.getRunContextType();
         if (typeof GeneratorOrNamespace === 'string') {
             if (GeneratorOrNamespace.startsWith('.')) {
                 if (!this.importMeta) {
@@ -268,7 +271,7 @@ export class YeomanTest {
                 GeneratorOrNamespace = fileURLToPath(GeneratorOrNamespace);
             }
         }
-        const runContext = new RunContext(GeneratorOrNamespace, { ...contextSettings, ...settings }, environmentOptions, this).withOptions(generatorOptions);
+        const runContext = this.createRunContext(GeneratorOrNamespace, { ...contextSettings, ...settings }, environmentOptions).withOptions(generatorOptions);
         if (settings?.autoCleanup !== false) {
             testContext.startNewContext(runContext);
         }

package/dist/run-context.d.ts

@@ -53,7 +53,7 @@ export declare class RunContextBase<GeneratorType extends BaseGenerator = Defaul
     private args;
     private options;
     private answers?;
-    private readonly adapterOptions?;
+    private readonly adapterOptions;
     private keepFsState?;
     private readonly onGeneratorCallbacks;
     private readonly onTargetDirectoryCallbacks;
@@ -153,7 +153,7 @@ 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: any): this;
+    withEnvironment(callback: (this: this, environment: DefaultEnvironmentApi) => DefaultEnvironmentApi | void): this;
     /**
      * Customize enviroment run method.
      *

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

@@ -44,13 +44,13 @@ export type RunResultOptions<GeneratorType extends BaseGenerator> = {
  * This class provides utilities for testing generated content.
  */
 export default class RunResult<GeneratorType extends BaseGenerator = BaseGenerator> {
-    env: any;
+    env: DefaultEnvironmentApi;
     generator: GeneratorType;
     cwd: string;
     oldCwd: string;
     memFs: Store<MemFsEditorFile>;
     fs: MemFsEditor;
-    mockedGenerators: any;
+    mockedGenerators: Record<string, BaseGenerator>;
     options: RunResultOptions<GeneratorType>;
     spawnStub?: any;
     readonly askedQuestions: AskedQuestions;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "yeoman-test",
-  "version": "11.5.0",
+  "version": "11.5.2",
   "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;