yeoman-test 7.0.0 → 7.2.0

package/dist/helpers.d.ts

@@ -9,7 +9,7 @@ import type { RunContextSettings } from './run-context.js';
 /**
  * Dependencies can be path (autodiscovery) or an array [<generator>, <name>]
  */
-export type Dependency = string | Parameters<Environment['registerStub']>;
+export type Dependency = string | Parameters<Environment['registerStub']> | Parameters<Environment['register']>;
 type GeneratorNew<GenParameter extends YeomanGenerator = YeomanGenerator> = new (...args: ConstructorParameters<typeof YeomanGenerator<GenParameter['options']>>) => YeomanGenerator<GenParameter['options']>;
 type GeneratorBuilder<GenParameter extends YeomanGenerator = YeomanGenerator> = (...args: ConstructorParameters<typeof YeomanGenerator<GenParameter['options']>>) => YeomanGenerator<GenParameter['options']>;
 export type GeneratorConstructor<GenParameter extends YeomanGenerator = YeomanGenerator> = GeneratorNew<GenParameter> | GeneratorBuilder<GenParameter>;
@@ -95,7 +95,7 @@ export declare class YeomanTest {
      *            ];
      * var angular = createGenerator('angular:app', deps);
      */
-    createGenerator<GeneratorType extends YeomanGenerator = YeomanGenerator>(name: string, dependencies: Dependency[], args?: string[], options?: YeomanGenerator.GeneratorOptions, localConfigOnly?: boolean): GeneratorType;
+    createGenerator<GeneratorType extends YeomanGenerator = YeomanGenerator>(name: string, dependencies: Dependency[], args?: string[], options?: YeomanGenerator.GeneratorOptions, localConfigOnly?: boolean): GeneratorType | Promise<GeneratorType>;
     /**
      * @deprecated
      * Register a list of dependent generators into the provided env.
@@ -119,16 +119,15 @@ export declare class YeomanTest {
      *   createEnv.restore();
      * });
      */
-    createEnv(...args: Parameters<typeof createEnv>): ReturnType<typeof createEnv>;
+    createEnv(...args: Parameters<typeof createEnv>): ReturnType<typeof createEnv> | Promise<ReturnType<typeof createEnv>>;
     /**
      * Creates a test environment.
      *
      * @param {Function} envContructor - environment constructor method.
      * @param {Object} [options] - Options to be passed to the environment
-     * @returns {Object} environment instance
      * const env = createTestEnv(require('yeoman-environment').createEnv);
      */
-    createTestEnv(envContructor?: (args?: string | string[] | undefined, opts?: Environment.Options | undefined, adapter?: import("yeoman-environment/lib/adapter.js") | undefined) => Environment<Environment.Options>, options?: Environment.Options): Environment<Environment.Options>;
+    createTestEnv(envContructor?: (args?: string | string[] | undefined, opts?: Environment.Options | undefined, adapter?: import("yeoman-environment/lib/adapter.js") | undefined) => Environment<Environment.Options> | Promise<Environment<Environment.Options>>, options?: Environment.Options): Environment<Environment.Options> | Promise<Environment<Environment.Options>>;
     /**
      * Get RunContext type
      * @return {RunContext}

package/dist/helpers.js

@@ -147,9 +147,16 @@ export class YeomanTest {
      * var angular = createGenerator('angular:app', deps);
      */
     createGenerator(name, dependencies, args, options, localConfigOnly = true) {
-        const env = this.createEnv([], { sharedOptions: { localConfigOnly } });
-        this.registerDependencies(env, dependencies);
-        return env.create(name, args, options);
+        const maybeEnv = this.createEnv([], { sharedOptions: { localConfigOnly } });
+        // TODO convert method to async.
+        if ('then' in maybeEnv) {
+            return maybeEnv.then(env => {
+                this.registerDependencies(env, dependencies);
+                return env.create(name, args, options);
+            });
+        }
+        this.registerDependencies(maybeEnv, dependencies);
+        return maybeEnv.create(name, args, options);
     }
     /**
      * @deprecated
@@ -161,7 +168,12 @@ export class YeomanTest {
     registerDependencies(env, dependencies) {
         for (const dependency of dependencies) {
             if (Array.isArray(dependency)) {
-                env.registerStub(dependency[0], dependency[1]);
+                if (typeof dependency[0] === 'string') {
+                    env.register(...dependency);
+                }
+                else {
+                    env.registerStub(...dependency);
+                }
             }
             else {
                 env.register(dependency);
@@ -191,7 +203,6 @@ export class YeomanTest {
      *
      * @param {Function} envContructor - environment constructor method.
      * @param {Object} [options] - Options to be passed to the environment
-     * @returns {Object} environment instance
      * const env = createTestEnv(require('yeoman-environment').createEnv);
      */
     createTestEnv(envContructor = this.createEnv, options = { localConfigOnly: true }) {

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 export { default, createHelpers, YeomanTest, type Dependency } from './helpers.js';
 export { default as RunContext, RunContextBase, type RunContextSettings } from './run-context.js';
 export { default as RunResult, type RunResultOptions } from './run-result.js';
+export { default as context } from './test-context.js';
 export { DummyPrompt, TestAdapter } from './adapter.js';

package/dist/index.js

@@ -1,4 +1,5 @@
 export { default, createHelpers, YeomanTest } from './helpers.js';
 export { default as RunContext, RunContextBase } from './run-context.js';
 export { default as RunResult } from './run-result.js';
+export { default as context } from './test-context.js';
 export { DummyPrompt, TestAdapter } from './adapter.js';

package/dist/run-context.d.ts

@@ -31,7 +31,7 @@ export type RunContextSettings = {
     namespace?: string;
 };
 type PromiseRunResult<GeneratorType extends Generator> = Promise<RunResult<GeneratorType>>;
-export declare class RunContextBase<GeneratorType extends Generator> extends EventEmitter {
+export declare class RunContextBase<GeneratorType extends Generator = Generator> extends EventEmitter {
     readonly mockedGenerators: Record<string, Generator>;
     env: Environment;
     generator: GeneratorType;
@@ -54,6 +54,7 @@ export declare class RunContextBase<GeneratorType extends Generator> extends Eve
     private oldCwd?;
     private eventListenersSet;
     private envCB;
+    private built;
     private ran;
     private errored;
     /**

package/dist/run-context.js

@@ -32,6 +32,7 @@ export class RunContextBase extends EventEmitter {
     oldCwd;
     eventListenersSet = false;
     envCB;
+    built = false;
     ran = false;
     errored = false;
     /**
@@ -47,14 +48,9 @@ export class RunContextBase extends EventEmitter {
     constructor(generatorType, settings, envOptions = {}, helpers = defaultHelpers) {
         super();
         this.settings = {
-            namespace: 'gen:test',
             ...settings,
         };
         this.Generator = generatorType;
-        if (typeof generatorType !== 'string') {
-            const { namespace, resolved } = this.settings;
-            this.withGenerators([[generatorType, namespace, resolved]]);
-        }
         this.envOptions = envOptions;
         this.withOptions({
             force: true,
@@ -72,7 +68,8 @@ export class RunContextBase extends EventEmitter {
      * @return {PromiseRunResult} Promise a RunResult instance.
      */
     async run() {
-        if (!this.ran) {
+        this.ran = true;
+        if (!this.built) {
             await this.build();
         }
         try {
@@ -288,13 +285,20 @@ export class RunContextBase extends EventEmitter {
      */
     withGenerators(dependencies) {
         assert(Array.isArray(dependencies), 'dependencies should be an array');
-        return this.onEnvironment(env => {
+        return this.onEnvironment(async (env) => {
             for (const dependency of dependencies) {
                 if (Array.isArray(dependency)) {
-                    env.registerStub(...dependency);
+                    if (typeof dependency[0] === 'string') {
+                        // eslint-disable-next-line no-await-in-loop, @typescript-eslint/await-thenable
+                        await env.register(...dependency);
+                    }
+                    else {
+                        env.registerStub(...dependency);
+                    }
                 }
                 else {
-                    env.register(dependency);
+                    // eslint-disable-next-line no-await-in-loop, @typescript-eslint/await-thenable
+                    await env.register(dependency);
                 }
             }
         });
@@ -397,7 +401,7 @@ export class RunContextBase extends EventEmitter {
         return this;
     }
     assertNotBuild() {
-        if (this.ran || this.completed) {
+        if (this.built || this.completed) {
             throw new Error('The context is already built');
         }
     }
@@ -407,7 +411,7 @@ export class RunContextBase extends EventEmitter {
      */
     async build() {
         this.assertNotBuild();
-        this.ran = true;
+        this.built = true;
         if (!this.targetDirectory && this.settings.tmpdir !== false) {
             this.inTmpDir();
         }
@@ -424,7 +428,7 @@ export class RunContextBase extends EventEmitter {
         if (!this.targetDirectory) {
             throw new Error('targetDirectory is required');
         }
-        const testEnv = this.helpers.createTestEnv(this.envOptions.createEnv, {
+        const testEnv = await this.helpers.createTestEnv(this.envOptions.createEnv, {
             cwd: this.settings.forwardCwd ? this.targetDirectory : undefined,
             ...this.options,
             ...this.envOptions,
@@ -439,13 +443,14 @@ export class RunContextBase extends EventEmitter {
             // eslint-disable-next-line no-await-in-loop
             await onEnvironmentCallback.call(this, this.env);
         }
-        let { namespace } = this.settings;
-        if (typeof this.Generator === 'string') {
-            namespace = this.env.namespace(this.Generator);
-            if (namespace !== this.Generator) {
-                // Generator is a file path, it should be registered.
-                this.env.register(this.Generator);
-            }
+        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);
+        }
+        else if (typeof this.Generator !== 'string') {
+            const { resolved } = this.settings;
+            this.env.registerStub(this.Generator, namespace, resolved);
         }
         // eslint-disable-next-line @typescript-eslint/await-thenable
         this.generator = (await this.env.create(namespace, this.args, this.options));

package/dist/test-context.d.ts

@@ -1,6 +1,5 @@
 import type RunContext from './run-context.js';
 declare class TestContext {
-    autoCleanup: boolean;
     private runContext?;
     startNewContext(runContext: RunContext<any>): void;
 }

package/dist/test-context.js

@@ -1,5 +1,4 @@
 class TestContext {
-    autoCleanup = false;
     runContext;
     startNewContext(runContext) {
         this.runContext?.cleanupTemporaryDir();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "yeoman-test",
-  "version": "7.0.0",
+  "version": "7.2.0",
   "description": "Test utilities for Yeoman generators",
   "homepage": "http://yeoman.io/authoring/testing.html",
   "author": "The Yeoman Team",
@@ -26,7 +26,7 @@
     "doc_path": "../yeoman-test-doc"
   },
   "devDependencies": {
-    "@esbuild-kit/esm-loader": "^2.5.1",
+    "@node-loaders/esbuild": "^0.6.0",
     "@types/mocha": "^10.0.0",
     "@types/sinon": "^10.0.13",
     "coveralls": "^3.1.1",