yeoman-test 8.0.0-alpha.2 → 8.0.0-beta.0

package/dist/helpers.d.ts

@@ -1,7 +1,7 @@
-import GeneratorImplementation, { type StorageRecord, type BaseOptions as GeneratorOptions } from 'yeoman-generator';
+import GeneratorImplementation from 'yeoman-generator';
 import Environment from 'yeoman-environment';
 import type { createEnv } from 'yeoman-environment';
-import type { BaseEnvironmentOptions, BaseGenerator, GetGeneratorConstructor, PromptAnswers } from '@yeoman/types';
+import type { BaseEnvironmentOptions, BaseGenerator, GeneratorBaseOptions, GetGeneratorConstructor, GetGeneratorOptions, PromptAnswers } from '@yeoman/types';
 import type { SinonSpiedInstance } from 'sinon';
 import { type DummyPromptOptions } from './adapter.js';
 import RunContext, { BasicRunContext, type RunContextSettings } from './run-context.js';
@@ -17,7 +17,7 @@ export type GeneratorFactory<GenParameter extends BaseGenerator = GeneratorImple
 export declare class YeomanTest {
     settings?: RunContextSettings;
     environmentOptions?: BaseEnvironmentOptions;
-    generatorOptions?: GeneratorOptions;
+    generatorOptions?: GeneratorBaseOptions;
     /**
      * @deprecated
      * Create a function that will clean up the test directory,
@@ -64,7 +64,7 @@ export declare class YeomanTest {
      * @param generator - a Yeoman generator
      * @param localConfig - localConfig - should look just like if called config.getAll()
      */
-    mockLocalConfig(generator: BaseGenerator, localConfig: StorageRecord): void;
+    mockLocalConfig(generator: BaseGenerator, localConfig: any): void;
     /**
      * Create a mocked generator
      */
@@ -72,7 +72,7 @@ export declare class YeomanTest {
     /**
      * Create a simple, dummy generator
      */
-    createDummyGenerator<GenParameter extends BaseGenerator = GeneratorImplementation>(Generator?: GetGeneratorConstructor<GenParameter>, contents?: Record<string, (...args: any[]) => void>): GenParameter;
+    createDummyGenerator<GenParameter extends BaseGenerator = GeneratorImplementation>(Generator?: GetGeneratorConstructor<GenParameter>, contents?: Record<string, (...args: any[]) => void>): new (...args: any[]) => GenParameter;
     /**
      * Create a generator, using the given dependencies and controller arguments
      * Dependecies can be path (autodiscovery) or an array [{generator}, {name}]
@@ -92,7 +92,7 @@ export declare class YeomanTest {
      *            ];
      * var angular = createGenerator('angular:app', deps);
      */
-    createGenerator<GeneratorType extends BaseGenerator = GeneratorImplementation>(name: string, dependencies: Dependency[], args?: string[], options?: GeneratorOptions, localConfigOnly?: boolean): Promise<GeneratorType>;
+    createGenerator<GeneratorType extends BaseGenerator = GeneratorImplementation>(name: string, dependencies: Dependency[], args?: string[], options?: GetGeneratorOptions<GeneratorType>, localConfigOnly?: boolean): Promise<GeneratorType>;
     /**
      * @deprecated
      * Register a list of dependent generators into the provided env.
@@ -145,7 +145,7 @@ export declare class YeomanTest {
      * Prepare temporary dir without generator support.
      * Generator and environment will be undefined.
      */
-    prepareTemporaryDir(settings?: RunContextSettings): BasicRunContext;
+    prepareTemporaryDir(settings?: RunContextSettings): BasicRunContext<BaseGenerator>;
 }
 declare const defaultHelpers: YeomanTest;
 export default defaultHelpers;

package/dist/helpers.js

@@ -109,13 +109,14 @@ export class YeomanTest {
     /**
      * Create a mocked generator
      */
-    createMockedGenerator(GeneratorClass = class MockedGenerator extends GeneratorImplementation {
-    }) {
-        const generator = sinonSpy(GeneratorClass);
+    createMockedGenerator(GeneratorClass = GeneratorImplementation) {
+        class MockedGenerator extends GeneratorClass {
+        }
+        const generator = sinonSpy(MockedGenerator);
         for (const methodName of ['run', 'queueTasks', 'runWithOptions', 'queueOwnTasks']) {
-            if (GeneratorClass.prototype[methodName]) {
-                GeneratorClass.prototype[methodName] = sinonStub();
-            }
+            Object.defineProperty(MockedGenerator.prototype, methodName, {
+                value: sinonStub(),
+            });
         }
         return generator;
     }
@@ -129,8 +130,11 @@ export class YeomanTest {
     }) {
         class DummyGenerator extends Generator {
             constructor(...args) {
-                args[1].namespace = args[1].namespace ?? 'dummy';
-                args[1].resolved = args[1].resolved ?? 'dummy';
+                const optIndex = Array.isArray(args[0]) ? 1 : 0;
+                args[optIndex] = args[optIndex] ?? {};
+                const options = args[optIndex];
+                options.namespace = options.namespace ?? 'dummy';
+                options.resolved = options.resolved ?? 'dummy';
                 super(...args);
             }
         }

package/dist/run-context.d.ts

@@ -4,8 +4,6 @@ import { type Store } from 'mem-fs';
 import type { BaseEnvironmentOptions, BaseGenerator, GetGeneratorConstructor, GetGeneratorOptions, PromptAnswers } from '@yeoman/types';
 import type Environment from 'yeoman-environment';
 import { type LookupOptions } from 'yeoman-environment';
-import type GeneratorImplementation from 'yeoman-generator';
-import type { StorageRecord } from 'yeoman-generator';
 import { type MemFsEditor, type VinylMemFsEditorFile } from 'mem-fs-editor';
 import RunResult, { type RunResultOptions } from './run-result.js';
 import { type Dependency, type YeomanTest, type GeneratorFactory } from './helpers.js';
@@ -35,11 +33,11 @@ export type RunContextSettings = {
     namespace?: string;
 };
 type PromiseRunResult<GeneratorType extends BaseGenerator> = Promise<RunResult<GeneratorType>>;
-type MockedGeneratorFactory = <GenParameter extends BaseGenerator = GeneratorImplementation>(GeneratorClass?: GetGeneratorConstructor<GenParameter>) => GenParameter;
+type MockedGeneratorFactory<GenParameter extends BaseGenerator = BaseGenerator> = (GeneratorClass?: GetGeneratorConstructor<GenParameter>) => GenParameter;
 type EnvOptions = BaseEnvironmentOptions & {
     createEnv?: any;
 };
-export declare class RunContextBase<GeneratorType extends BaseGenerator = GeneratorImplementation> extends EventEmitter {
+export declare class RunContextBase<GeneratorType extends BaseGenerator = BaseGenerator> extends EventEmitter {
     readonly mockedGenerators: Record<string, BaseGenerator>;
     env: Environment;
     generator: GeneratorType;
@@ -221,7 +219,7 @@ export declare class RunContextBase<GeneratorType extends BaseGenerator = Genera
      * Mock the local configuration with the provided config
      * @param localConfig - should look just like if called config.getAll()
      */
-    withLocalConfig(localConfig: StorageRecord): this;
+    withLocalConfig(localConfig: any): this;
     /**
      * Don't reset mem-fs state cleared to aggregate snapshots from multiple runs.
      */
@@ -294,13 +292,13 @@ export declare class RunContextBase<GeneratorType extends BaseGenerator = Genera
      */
     private setDir;
 }
-export default class RunContext<GeneratorType extends BaseGenerator = GeneratorImplementation> extends RunContextBase<GeneratorType> implements Promise<RunResult<GeneratorType>> {
+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>>;
     get [Symbol.toStringTag](): string;
 }
-export declare class BasicRunContext extends RunContext {
+export declare class BasicRunContext<GeneratorType extends BaseGenerator = BaseGenerator> extends RunContext<GeneratorType> {
     run(): PromiseRunResult<any>;
 }
 export {};

package/dist/run-result.d.ts

@@ -37,7 +37,7 @@ export type RunResultOptions<GeneratorType extends BaseGenerator> = {
 /**
  * This class provides utilities for testing generated content.
  */
-export default class RunResult<GeneratorType extends BaseGenerator = GeneratorImplementation> {
+export default class RunResult<GeneratorType extends BaseGenerator = BaseGenerator> {
     env: any;
     generator: GeneratorType;
     cwd: string;
@@ -66,7 +66,8 @@ export default class RunResult<GeneratorType extends BaseGenerator = GeneratorIm
      * @returns {Object}
      */
     getStateSnapshot(filter?: any): Record<string, {
-        stateCleared: string;
+        stateCleared?: string;
+        state?: string;
     }>;
     /**
      * Either dumps the contents of the specified files or the name and the contents of each file to the console.

package/dist/test-context.d.ts

@@ -1,8 +1,7 @@
-import type { BaseGenerator } from '@yeoman/types';
 import type RunContext from './run-context.js';
 import type RunResult from './run-result.js';
 declare class TestContext {
-    runResult?: RunResult<BaseGenerator>;
+    runResult?: RunResult;
     private runContext?;
     startNewContext(runContext?: RunContext<any>): void;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "yeoman-test",
-  "version": "8.0.0-alpha.2",
+  "version": "8.0.0-beta.0",
   "description": "Test utilities for Yeoman generators",
   "homepage": "http://yeoman.io/authoring/testing.html",
   "author": "The Yeoman Team",
@@ -47,10 +47,10 @@
     "inquirer": "^9.2.2",
     "lodash": "^4.17.21",
     "mem-fs": "^3.0.0",
-    "mem-fs-editor": "^10.0.1",
+    "mem-fs-editor": "^10.0.2",
     "sinon": "^14.0.2",
     "temp-dir": "^3.0.0",
-    "yeoman-generator": "^6.0.0-alpha.2"
+    "yeoman-generator": "^6.0.0-alpha.4"
   },
   "peerDependencies": {
     "yeoman-environment": "^3.13.0 || ^4.0.0-alpha.0"