yeoman-test 8.0.0-beta.1 → 8.0.0-beta.3

package/dist/default-environment.d.ts

@@ -0,0 +1 @@
+export function defaultEnvironment(): Promise<any>;

package/dist/default-environment.js

@@ -0,0 +1,4 @@
+export const defaultEnvironment = async () => {
+    const dynamicEnv = await import('yeoman-environment');
+    return dynamicEnv.createEnv ?? dynamicEnv.default.createEnv;
+};

package/dist/helpers.d.ts

@@ -1,13 +1,12 @@
 import type { BaseEnvironmentOptions, BaseGenerator, BaseGeneratorOptions, GetGeneratorConstructor, GetGeneratorOptions, PromptAnswers } from '@yeoman/types';
 import type { SinonSpiedInstance } from 'sinon';
+import type { DefaultEnvironmentApi, DefaultGeneratorApi } from '../types/type-helpers.js';
 import { type DummyPromptOptions } from './adapter.js';
 import RunContext, { BasicRunContext, type RunContextSettings } from './run-context.js';
-import type { DefaultEnvironmentApi, DefaultGeneratorApi } from './type-helpers.js';
 /**
  * Dependencies can be path (autodiscovery) or an array [<generator>, <name>]
  */
-export type Dependency = string | Parameters<DefaultEnvironmentApi['registerStub']>;
-export type GeneratorFactory<GenParameter extends BaseGenerator = DefaultGeneratorApi> = GetGeneratorConstructor<GenParameter> | ((...args: ConstructorParameters<GetGeneratorConstructor<GenParameter>>) => GenParameter);
+export type Dependency = string | Parameters<DefaultEnvironmentApi['register']>;
 /**
  * Collection of unit test helpers. (mostly related to Mocha syntax)
  * @class YeomanTest
@@ -66,11 +65,11 @@ export declare class YeomanTest {
     /**
      * Create a mocked generator
      */
-    createMockedGenerator(GeneratorClass: any): Promise<SinonSpiedInstance<DefaultGeneratorApi>>;
+    createMockedGenerator(GeneratorClass?: any): SinonSpiedInstance<DefaultGeneratorApi>;
     /**
      * Create a simple, dummy generator
      */
-    createDummyGenerator<GenParameter extends BaseGenerator = DefaultGeneratorApi>(Generator?: GetGeneratorConstructor<GenParameter>, contents?: Record<string, (...args: any[]) => void>): Promise<new (...args: any[]) => GenParameter>;
+    createDummyGenerator<GenParameter extends BaseGenerator = DefaultGeneratorApi>(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}]
@@ -91,14 +90,6 @@ export declare class YeomanTest {
      * var angular = createGenerator('angular:app', deps);
      */
     createGenerator<GeneratorType extends BaseGenerator = DefaultGeneratorApi>(name: string, dependencies: Dependency[], args?: string[], options?: GetGeneratorOptions<GeneratorType>, localConfigOnly?: boolean): Promise<GeneratorType>;
-    /**
-     * @deprecated
-     * Register a list of dependent generators into the provided env.
-     * Dependecies can be path (autodiscovery) or an array [{generator}, {name}]
-     *
-     * @param dependencies - paths to the generators dependencies
-     */
-    registerDependencies(env: DefaultEnvironmentApi, dependencies: Dependency[]): void;
     /**
      * Shortcut to the Environment's createEnv.
      *
@@ -132,13 +123,13 @@ export declare class YeomanTest {
      * Run the provided Generator
      * @param GeneratorOrNamespace - Generator constructor or namespace
      */
-    run<GeneratorType extends BaseGenerator = DefaultGeneratorApi>(GeneratorOrNamespace: string | GeneratorFactory<GeneratorType>, settings?: RunContextSettings, envOptions?: BaseEnvironmentOptions): RunContext<GeneratorType>;
+    run<GeneratorType extends BaseGenerator = DefaultGeneratorApi>(GeneratorOrNamespace: string | GetGeneratorConstructor<GeneratorType>, settings?: RunContextSettings, envOptions?: BaseEnvironmentOptions): RunContext<GeneratorType>;
     /**
      * Prepare a run context
      * @param  {String|Function} GeneratorOrNamespace - Generator constructor or namespace
      * @return {RunContext}
      */
-    create<GeneratorType extends BaseGenerator = DefaultGeneratorApi>(GeneratorOrNamespace: string | GeneratorFactory<GeneratorType>, settings?: RunContextSettings, envOptions?: BaseEnvironmentOptions): RunContext<GeneratorType>;
+    create<GeneratorType extends BaseGenerator = DefaultGeneratorApi>(GeneratorOrNamespace: string | GetGeneratorConstructor<GeneratorType>, settings?: RunContextSettings, envOptions?: BaseEnvironmentOptions): RunContext<GeneratorType>;
     /**
      * Prepare temporary dir without generator support.
      * Generator and environment will be undefined.

package/dist/helpers.js

@@ -7,6 +7,13 @@ import { spy as sinonSpy, stub as sinonStub } from 'sinon';
 import { DummyPrompt, TestAdapter } from './adapter.js';
 import RunContext, { BasicRunContext } from './run-context.js';
 import testContext from './test-context.js';
+import { defaultEnvironment } from './default-environment.js';
+let GeneratorImplementation;
+try {
+    const GeneratorImport = await import('yeoman-generator');
+    GeneratorImplementation = GeneratorImport.default ?? GeneratorImport;
+}
+catch { }
 const { cloneDeep } = _;
 /**
  * Collection of unit test helpers. (mostly related to Mocha syntax)
@@ -107,11 +114,7 @@ export class YeomanTest {
     /**
      * Create a mocked generator
      */
-    async createMockedGenerator(GeneratorClass) {
-        if (!GeneratorClass) {
-            const GeneratorImplementation = await import('yeoman-generator');
-            GeneratorClass = (GeneratorImplementation.default ?? GeneratorImplementation);
-        }
+    createMockedGenerator(GeneratorClass = GeneratorImplementation) {
         class MockedGenerator extends GeneratorClass {
         }
         const generator = sinonSpy(MockedGenerator);
@@ -125,17 +128,12 @@ export class YeomanTest {
     /**
      * Create a simple, dummy generator
      */
-    async createDummyGenerator(Generator, contents = {
+    createDummyGenerator(Generator = GeneratorImplementation, contents = {
         test() {
             this.shouldRun = true;
         },
     }) {
-        if (!Generator) {
-            const GeneratorImplementation = await import('yeoman-generator');
-            Generator = (GeneratorImplementation.default ?? GeneratorImplementation);
-        }
-        const GeneratorConstructor = Generator;
-        class DummyGenerator extends GeneratorConstructor {
+        class DummyGenerator extends Generator {
             constructor(...args) {
                 const optIndex = Array.isArray(args[0]) ? 1 : 0;
                 args[optIndex] = args[optIndex] ?? {};
@@ -174,30 +172,15 @@ export class YeomanTest {
      */
     async createGenerator(name, dependencies, args, options, localConfigOnly = true) {
         const env = await this.createEnv([], { sharedOptions: { localConfigOnly } });
-        this.registerDependencies(env, dependencies);
-        return env.create(name, args, options);
-    }
-    /**
-     * @deprecated
-     * Register a list of dependent generators into the provided env.
-     * Dependecies can be path (autodiscovery) or an array [{generator}, {name}]
-     *
-     * @param dependencies - paths to the generators dependencies
-     */
-    registerDependencies(env, dependencies) {
         for (const dependency of dependencies) {
-            if (Array.isArray(dependency)) {
-                if (typeof dependency[0] === 'string') {
-                    env.register(...dependency);
-                }
-                else {
-                    env.registerStub(...dependency);
-                }
+            if (typeof dependency === 'string') {
+                env.register(dependency);
             }
             else {
-                env.register(dependency);
+                env.register(...dependency);
             }
         }
+        return env.create(name, args, options);
     }
     /**
      * Shortcut to the Environment's createEnv.
@@ -215,9 +198,7 @@ export class YeomanTest {
      * });
      */
     async createEnv(...args) {
-        const dynamicEnv = await import('yeoman-environment');
-        const createEnv = dynamicEnv.createEnv ?? dynamicEnv.default.createEnv;
-        return createEnv(...args);
+        return (await defaultEnvironment())(...args);
     }
     /**
      * Creates a test environment.

package/dist/run-context.d.ts

@@ -1,13 +1,12 @@
 /// <reference types="node" resolution-mode="require"/>
 import { EventEmitter } from 'node:events';
 import { type Store } from 'mem-fs';
-import type { BaseEnvironmentOptions, BaseGenerator, GetGeneratorConstructor, GetGeneratorOptions, PromptAnswers } from '@yeoman/types';
-import { type LookupOptions } from 'yeoman-environment';
+import type { BaseEnvironmentOptions, BaseGenerator, GetGeneratorConstructor, GetGeneratorOptions, PromptAnswers, LookupOptions } from '@yeoman/types';
 import { type MemFsEditorFile, type MemFsEditor } from 'mem-fs-editor';
+import type { DefaultGeneratorApi, DefaultEnvironmentApi } from '../types/type-helpers.js';
 import RunResult, { type RunResultOptions } from './run-result.js';
-import { type Dependency, type YeomanTest, type GeneratorFactory } from './helpers.js';
+import { type Dependency, type YeomanTest } from './helpers.js';
 import { type DummyPromptOptions } from './adapter.js';
-import type { DefaultGeneratorApi, DefaultEnvironmentApi } from './type-helpers.js';
 /**
  * Provides settings for creating a `RunContext`.
  */
@@ -33,7 +32,7 @@ export type RunContextSettings = {
     namespace?: string;
 };
 type PromiseRunResult<GeneratorType extends BaseGenerator> = Promise<RunResult<GeneratorType>>;
-type MockedGeneratorFactory<GenParameter extends BaseGenerator = DefaultGeneratorApi> = (GeneratorClass?: GetGeneratorConstructor<GenParameter>) => Promise<GenParameter>;
+type MockedGeneratorFactory<GenParameter extends BaseGenerator = DefaultGeneratorApi> = (GeneratorClass?: GetGeneratorConstructor<GenParameter>) => GetGeneratorConstructor<GenParameter>;
 type EnvOptions = BaseEnvironmentOptions & {
     createEnv?: any;
 };
@@ -77,7 +76,7 @@ export declare class RunContextBase<GeneratorType extends BaseGenerator = Defaul
      * @param settings
      * @return {this}
      */
-    constructor(generatorType?: string | GeneratorFactory<GeneratorType>, settings?: RunContextSettings, envOptions?: EnvOptions, helpers?: YeomanTest);
+    constructor(generatorType?: string | GetGeneratorConstructor<GeneratorType>, settings?: RunContextSettings, envOptions?: EnvOptions, helpers?: YeomanTest);
     /**
      * Run the generator on the environment and promises a RunResult instance.
      * @return {PromiseRunResult} Promise a RunResult instance.

package/dist/run-context.js

@@ -296,16 +296,11 @@ export class RunContextBase extends EventEmitter {
         assert(Array.isArray(dependencies), 'dependencies should be an array');
         return this.onEnvironment(async (env) => {
             for (const dependency of dependencies) {
-                if (Array.isArray(dependency)) {
-                    if (typeof dependency[0] === 'string') {
-                        env.register(...dependency);
-                    }
-                    else {
-                        env.registerStub(...dependency);
-                    }
+                if (typeof dependency === 'string') {
+                    env.register(dependency);
                 }
                 else {
-                    env.register(dependency);
+                    env.register(...dependency);
                 }
             }
         });
@@ -332,13 +327,10 @@ export class RunContextBase extends EventEmitter {
      */
     withMockedGenerators(namespaces) {
         assert(Array.isArray(namespaces), 'namespaces should be an array');
-        return this.onBeforePrepare(async () => {
-            const MockedGenerator = await this.mockedGeneratorFactory();
-            const dependencies = namespaces.map(namespace => [MockedGenerator, namespace]);
-            const entries = dependencies.map(([generator, namespace]) => [namespace, generator]);
-            Object.assign(this.mockedGenerators, Object.fromEntries(entries));
-            this.withGenerators(dependencies);
-        });
+        const mockedGenerators = Object.fromEntries(namespaces.map(namespace => [namespace, this.mockedGeneratorFactory()]));
+        const dependencies = Object.entries(mockedGenerators).map(([namespace, mock]) => [mock, { namespace }]);
+        Object.assign(this.mockedGenerators, mockedGenerators);
+        return this.withGenerators(dependencies);
     }
     /**
      * Mock the local configuration with the provided config
@@ -504,11 +496,11 @@ export class RunContextBase extends EventEmitter {
         const { namespace = typeof this.Generator === 'string' ? this.env.namespace(this.Generator) : 'gen:test' } = this.settings;
         if (typeof this.Generator === 'string' && namespace !== this.Generator) {
             // Generator is a file path, it should be registered.
-            this.env.register(this.Generator, namespace);
+            this.env.register(this.Generator, { namespace });
         }
         else if (typeof this.Generator !== 'string') {
             const { resolved } = this.settings;
-            this.env.registerStub(this.Generator, namespace, resolved);
+            this.env.register(this.Generator, { namespace, resolved });
         }
         this.generator = await this.env.create(namespace, this.args, {
             force: true,

package/dist/run-result.d.ts

@@ -1,9 +1,9 @@
 import type { Store } from 'mem-fs';
 import { type MemFsEditorFile, type MemFsEditor } from 'mem-fs-editor';
-import type { BaseEnvironmentOptions, BaseGenerator } from '@yeoman/types';
+import type { BaseEnvironmentOptions, BaseGenerator, GetGeneratorConstructor } from '@yeoman/types';
+import type { DefaultEnvironmentApi, DefaultGeneratorApi } from '../types/type-helpers.js';
 import { type RunContextSettings } from './run-context.js';
-import { type GeneratorFactory, type YeomanTest } from './helpers.js';
-import type { DefaultEnvironmentApi, DefaultGeneratorApi } from './type-helpers.js';
+import { type YeomanTest } from './helpers.js';
 /**
  * Provides options for `RunResult`s.
  */
@@ -51,7 +51,7 @@ export default class RunResult<GeneratorType extends BaseGenerator = BaseGenerat
      * Create another RunContext reusing the settings.
      * See helpers.create api
      */
-    create<GeneratorType extends BaseGenerator = DefaultGeneratorApi>(GeneratorOrNamespace: string | GeneratorFactory<GeneratorType>, settings?: RunContextSettings, envOptions?: BaseEnvironmentOptions): import("./run-context.js").default<GeneratorType>;
+    create<GeneratorType extends BaseGenerator = DefaultGeneratorApi>(GeneratorOrNamespace: string | GetGeneratorConstructor<GeneratorType>, settings?: RunContextSettings, envOptions?: BaseEnvironmentOptions): import("./run-context.js").default<GeneratorType>;
     /**
      * Return an object with fs changes.
      * @param {Function} filter - parameter forwarded to mem-fs-editor#dump

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "yeoman-test",
-  "version": "8.0.0-beta.1",
+  "version": "8.0.0-beta.3",
   "description": "Test utilities for Yeoman generators",
   "keywords": [
     "yeoman",
@@ -17,7 +17,8 @@
   },
   "types": "./dist/index.d.ts",
   "files": [
-    "dist"
+    "dist",
+    "types"
   ],
   "scripts": {
     "build": "tsc",
@@ -29,7 +30,7 @@
     "precommit": "lint-staged",
     "prepare": "npm run build",
     "pretest": "xo",
-    "test": "c8 esmocha"
+    "test": "c8 esmocha --forbid-only"
   },
   "config": {
     "doc_path": "../yeoman-test-doc"
@@ -49,7 +50,7 @@
     "@types/sinon": "^10.0.13",
     "c8": "^7.13.0",
     "coveralls": "^3.1.1",
-    "esmocha": "^0.1.4",
+    "esmocha": "^1.0.1",
     "husky": "^8.0.2",
     "jsdoc": "^3.6.10",
     "lint-staged": "^13.0.3",
@@ -58,13 +59,13 @@
     "tui-jsdoc-template": "^1.2.2",
     "typescript": "^5.0.4",
     "xo": "^0.54.2",
-    "yeoman-environment": "^3.16.1",
-    "yeoman-generator": "^6.0.0-beta.1"
+    "yeoman-environment": "^3.17.0",
+    "yeoman-generator": "^5.8.0"
   },
   "peerDependencies": {
-    "@yeoman/types": "^0.3.0",
-    "yeoman-environment": "^3.13.0 || ^4.0.0-alpha.0",
-    "yeoman-generator": "^5.8.0 || ^6.0.0-beta.1"
+    "@yeoman/types": "^0.4.0",
+    "yeoman-environment": ">=3.17.0 < 5.0.0",
+    "yeoman-generator": ">=5.8.0 < 7.0.0"
   },
   "peerDependenciesMeta": {
     "yeoman-environment": {

package/types/type-helpers.d.ts

@@ -0,0 +1,17 @@
+import type { BaseGenerator, BaseEnvironment } from '@yeoman/types';
+import type GeneratorImplementation from 'yeoman-generator';
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment, @typescript-eslint/prefer-ts-expect-error
+// @ts-ignore
+import type EnvironmentImplementation from 'yeoman-environment';
+import type { IfAny } 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
+>;

package/dist/type-helpers.d.ts

@@ -1,6 +0,0 @@
-import { type BaseGenerator, type BaseEnvironment } from '@yeoman/types';
-import type GeneratorImplementation from 'yeoman-generator';
-import type EnvironmentImplementation from 'yeoman-environment';
-import type { IfAny } 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>;

package/dist/type-helpers.js

@@ -1 +0,0 @@
-export {};