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

package/dist/adapter.js

@@ -99,7 +99,7 @@ export class TestAdapter {
         }
     }
     close() {
-        // No empty
+        this.promptModule.restoreDefaultPrompts();
     }
     async prompt(questions, initialAnswers) {
         return this.promptModule(questions, initialAnswers);

package/dist/helpers.d.ts

@@ -1,15 +1,13 @@
-import GeneratorImplementation from 'yeoman-generator';
-import Environment from 'yeoman-environment';
-import type { createEnv } from 'yeoman-environment';
-import type { BaseEnvironmentOptions, BaseGenerator, GeneratorBaseOptions, GetGeneratorConstructor, GetGeneratorOptions, PromptAnswers } from '@yeoman/types';
+import type { BaseEnvironment, BaseEnvironmentOptions, BaseGenerator, BaseGeneratorOptions, 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';
+import type { DefaultEnvironmentApi, DefaultGeneratorApi } from './type-helpers.js';
 /**
  * Dependencies can be path (autodiscovery) or an array [<generator>, <name>]
  */
-export type Dependency = string | Parameters<Environment['registerStub']>;
-export type GeneratorFactory<GenParameter extends BaseGenerator = GeneratorImplementation> = GetGeneratorConstructor<GenParameter> | ((...args: ConstructorParameters<GetGeneratorConstructor<GenParameter>>) => GenParameter);
+export type Dependency = Parameters<DefaultEnvironmentApi['register']> | Parameters<DefaultEnvironmentApi['registerStub']>;
+export type GeneratorFactory<GenParameter extends BaseGenerator = DefaultGeneratorApi> = GetGeneratorConstructor<GenParameter> | ((...args: ConstructorParameters<GetGeneratorConstructor<GenParameter>>) => GenParameter);
 /**
  * Collection of unit test helpers. (mostly related to Mocha syntax)
  * @class YeomanTest
@@ -17,7 +15,7 @@ export type GeneratorFactory<GenParameter extends BaseGenerator = GeneratorImple
 export declare class YeomanTest {
     settings?: RunContextSettings;
     environmentOptions?: BaseEnvironmentOptions;
-    generatorOptions?: GeneratorBaseOptions;
+    generatorOptions?: BaseGeneratorOptions;
     /**
      * @deprecated
      * Create a function that will clean up the test directory,
@@ -51,13 +49,13 @@ export declare class YeomanTest {
      * @example
      * mockPrompt(angular, {'bootstrap': 'Y', 'compassBoostrap': 'Y'});
      */
-    mockPrompt(envOrGenerator: BaseGenerator | Environment, mockedAnswers?: PromptAnswers, options?: DummyPromptOptions): void;
+    mockPrompt(envOrGenerator: BaseGenerator | DefaultEnvironmentApi, mockedAnswers?: PromptAnswers, options?: DummyPromptOptions): void;
     /**
      * @deprecated
      * Restore defaults prompts on a generator.
      * @param generator or environment
      */
-    restorePrompt(envOrGenerator: BaseGenerator | Environment): void;
+    restorePrompt(envOrGenerator: BaseGenerator | DefaultEnvironmentApi): void;
     /**
      * @deprecated
      * Provide mocked values to the config
@@ -68,11 +66,11 @@ export declare class YeomanTest {
     /**
      * Create a mocked generator
      */
-    createMockedGenerator(GeneratorClass?: typeof GeneratorImplementation): SinonSpiedInstance<typeof GeneratorImplementation>;
+    createMockedGenerator(GeneratorClass?: any): SinonSpiedInstance<DefaultGeneratorApi>;
     /**
      * Create a simple, dummy generator
      */
-    createDummyGenerator<GenParameter extends BaseGenerator = GeneratorImplementation>(Generator?: GetGeneratorConstructor<GenParameter>, contents?: Record<string, (...args: any[]) => void>): 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}]
@@ -92,7 +90,7 @@ export declare class YeomanTest {
      *            ];
      * var angular = createGenerator('angular:app', deps);
      */
-    createGenerator<GeneratorType extends BaseGenerator = GeneratorImplementation>(name: string, dependencies: Dependency[], args?: string[], options?: GetGeneratorOptions<GeneratorType>, localConfigOnly?: boolean): Promise<GeneratorType>;
+    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.
@@ -100,7 +98,7 @@ export declare class YeomanTest {
      *
      * @param dependencies - paths to the generators dependencies
      */
-    registerDependencies(env: Environment, dependencies: Dependency[]): void;
+    registerDependencies(env: DefaultEnvironmentApi, dependencies: Dependency[]): void;
     /**
      * Shortcut to the Environment's createEnv.
      *
@@ -116,7 +114,7 @@ export declare class YeomanTest {
      *   createEnv.restore();
      * });
      */
-    createEnv(...args: Parameters<typeof createEnv>): ReturnType<typeof createEnv> | Promise<ReturnType<typeof createEnv>>;
+    createEnv(...args: any[]): Promise<DefaultEnvironmentApi>;
     /**
      * Creates a test environment.
      *
@@ -124,7 +122,7 @@ export declare class YeomanTest {
      * @param {Object} - Options to be passed to the environment
      * const env = createTestEnv(require('yeoman-environment').createEnv);
      */
-    createTestEnv(envContructor?: (...args: unknown[]) => any, options?: BaseEnvironmentOptions): any;
+    createTestEnv(envContructor?: (...args: any[]) => Promise<BaseEnvironment>, options?: BaseEnvironmentOptions): Promise<BaseEnvironment>;
     /**
      * Get RunContext type
      * @return {RunContext}
@@ -134,13 +132,13 @@ export declare class YeomanTest {
      * Run the provided Generator
      * @param GeneratorOrNamespace - Generator constructor or namespace
      */
-    run<GeneratorType extends BaseGenerator = GeneratorImplementation>(GeneratorOrNamespace: string | GeneratorFactory<GeneratorType>, settings?: RunContextSettings, envOptions?: BaseEnvironmentOptions): RunContext<GeneratorType>;
+    run<GeneratorType extends BaseGenerator = DefaultGeneratorApi>(GeneratorOrNamespace: string | GeneratorFactory<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 = GeneratorImplementation>(GeneratorOrNamespace: string | GeneratorFactory<GeneratorType>, settings?: RunContextSettings, envOptions?: BaseEnvironmentOptions): RunContext<GeneratorType>;
+    create<GeneratorType extends BaseGenerator = DefaultGeneratorApi>(GeneratorOrNamespace: string | GeneratorFactory<GeneratorType>, settings?: RunContextSettings, envOptions?: BaseEnvironmentOptions): RunContext<GeneratorType>;
     /**
      * Prepare temporary dir without generator support.
      * Generator and environment will be undefined.

package/dist/helpers.js

@@ -4,11 +4,15 @@ import { resolve } from 'node:path';
 import process from 'node:process';
 import _ from 'lodash';
 import { spy as sinonSpy, stub as sinonStub } from 'sinon';
-import GeneratorImplementation from 'yeoman-generator';
-import Environment from 'yeoman-environment';
 import { DummyPrompt, TestAdapter } from './adapter.js';
 import RunContext, { BasicRunContext } from './run-context.js';
 import testContext from './test-context.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)
@@ -95,7 +99,7 @@ export class YeomanTest {
      */
     restorePrompt(envOrGenerator) {
         const environment = envOrGenerator.env ?? envOrGenerator;
-        environment.adapter.promptModule.restoreDefaultPrompts();
+        environment.adapter.close();
     }
     /**
      * @deprecated
@@ -207,8 +211,10 @@ export class YeomanTest {
      *   createEnv.restore();
      * });
      */
-    createEnv(...args) {
-        return Environment.createEnv(...args);
+    async createEnv(...args) {
+        const dynamicEnv = await import('yeoman-environment');
+        const createEnv = dynamicEnv.createEnv ?? dynamicEnv.default.createEnv;
+        return createEnv(...args);
     }
     /**
      * Creates a test environment.
@@ -217,7 +223,7 @@ export class YeomanTest {
      * @param {Object} - Options to be passed to the environment
      * const env = createTestEnv(require('yeoman-environment').createEnv);
      */
-    createTestEnv(envContructor = this.createEnv, options = { localConfigOnly: true }) {
+    async createTestEnv(envContructor = this.createEnv, options = { localConfigOnly: true }) {
         let envOptions = cloneDeep(this.environmentOptions ?? {});
         if (typeof options === 'boolean') {
             envOptions = {

package/dist/run-context.d.ts

@@ -2,12 +2,12 @@
 import { EventEmitter } from 'node:events';
 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 MemFsEditor, type VinylMemFsEditorFile } from 'mem-fs-editor';
+import { type MemFsEditorFile, type MemFsEditor } from 'mem-fs-editor';
 import RunResult, { type RunResultOptions } from './run-result.js';
 import { type Dependency, type YeomanTest, type GeneratorFactory } from './helpers.js';
 import { type DummyPromptOptions } from './adapter.js';
+import type { DefaultGeneratorApi, DefaultEnvironmentApi } from './type-helpers.js';
 /**
  * Provides settings for creating a `RunContext`.
  */
@@ -21,7 +21,7 @@ export type RunContextSettings = {
     oldCwd?: string;
     forwardCwd?: boolean;
     autoCleanup?: boolean;
-    memFs?: Store;
+    memFs?: Store<MemFsEditorFile>;
     /**
      * File path to the generator (only used if Generator is a constructor)
      */
@@ -33,20 +33,20 @@ export type RunContextSettings = {
     namespace?: string;
 };
 type PromiseRunResult<GeneratorType extends BaseGenerator> = Promise<RunResult<GeneratorType>>;
-type MockedGeneratorFactory<GenParameter extends BaseGenerator = BaseGenerator> = (GeneratorClass?: GetGeneratorConstructor<GenParameter>) => GenParameter;
+type MockedGeneratorFactory<GenParameter extends BaseGenerator = DefaultGeneratorApi> = (GeneratorClass?: GetGeneratorConstructor<GenParameter>) => GenParameter;
 type EnvOptions = BaseEnvironmentOptions & {
     createEnv?: any;
 };
-export declare class RunContextBase<GeneratorType extends BaseGenerator = BaseGenerator> extends EventEmitter {
+export declare class RunContextBase<GeneratorType extends BaseGenerator = DefaultGeneratorApi> extends EventEmitter {
     readonly mockedGenerators: Record<string, BaseGenerator>;
-    env: Environment;
+    env: DefaultEnvironmentApi;
     generator: GeneratorType;
     readonly settings: RunContextSettings;
     readonly envOptions: EnvOptions;
     completed: boolean;
     targetDirectory?: string;
     editor: MemFsEditor;
-    memFs: Store<VinylMemFsEditorFile>;
+    memFs: Store<MemFsEditorFile>;
     mockedGeneratorFactory: MockedGeneratorFactory;
     protected environmentPromise?: PromiseRunResult<GeneratorType>;
     private args;
@@ -66,6 +66,7 @@ export declare class RunContextBase<GeneratorType extends BaseGenerator = BaseGe
     private built;
     private ran;
     private errored;
+    private readonly beforePrepareCallbacks;
     /**
      * This class provide a run context object to façade the complexity involved in setting
      * up a generator for testing
@@ -260,12 +261,18 @@ export declare class RunContextBase<GeneratorType extends BaseGenerator = BaseGe
      * @returns
      */
     onGenerator(callback: (this: this, generator: GeneratorType) => any): this;
+    /**
+     * Execute callback prefore parepare
+     * @param callback
+     * @returns
+     */
+    onBeforePrepare(callback: (this: this) => void | Promise<void>): this;
     /**
      * Execute callback after environment is ready
      * @param callback
      * @returns
      */
-    onEnvironment(callback: (this: this, env: Environment) => any): this;
+    onEnvironment(callback: (this: this, env: DefaultEnvironmentApi) => any): this;
     prepare(): Promise<void>;
     protected assertNotBuild(): void;
     /**

package/dist/run-context.js

@@ -43,6 +43,7 @@ export class RunContextBase extends EventEmitter {
     built = false;
     ran = false;
     errored = false;
+    beforePrepareCallbacks = [];
     /**
      * This class provide a run context object to façade the complexity involved in setting
      * up a generator for testing
@@ -297,16 +298,14 @@ export class RunContextBase extends EventEmitter {
             for (const dependency of dependencies) {
                 if (Array.isArray(dependency)) {
                     if (typeof dependency[0] === 'string') {
-                        // eslint-disable-next-line no-await-in-loop
-                        await env.register(...dependency);
+                        env.register(...dependency);
                     }
                     else {
                         env.registerStub(...dependency);
                     }
                 }
                 else {
-                    // eslint-disable-next-line no-await-in-loop
-                    await env.register(dependency);
+                    env.register(dependency);
                 }
             }
         });
@@ -417,6 +416,16 @@ export class RunContextBase extends EventEmitter {
         this.onGeneratorCallbacks.push(callback);
         return this;
     }
+    /**
+     * Execute callback prefore parepare
+     * @param callback
+     * @returns
+     */
+    onBeforePrepare(callback) {
+        this.assertNotBuild();
+        this.beforePrepareCallbacks.push(callback);
+        return this;
+    }
     /**
      * Execute callback after environment is ready
      * @param callback
@@ -428,6 +437,12 @@ export class RunContextBase extends EventEmitter {
         return this;
     }
     async prepare() {
+        if (this.beforePrepareCallbacks.length > 0) {
+            for (const cb of this.beforePrepareCallbacks) {
+                // eslint-disable-next-line no-await-in-loop
+                await cb.call(this);
+            }
+        }
         this.assertNotBuild();
         this.built = true;
         if (!this.targetDirectory && this.settings.tmpdir !== false) {

package/dist/run-result.d.ts

@@ -1,9 +1,9 @@
 import type { Store } from 'mem-fs';
-import { type MemFsEditor } from 'mem-fs-editor';
-import type { BaseEnvironment, BaseEnvironmentOptions, BaseGenerator } from '@yeoman/types';
-import type GeneratorImplementation from 'yeoman-generator';
+import { type MemFsEditorFile, type MemFsEditor } from 'mem-fs-editor';
+import type { BaseEnvironmentOptions, BaseGenerator } from '@yeoman/types';
 import { type RunContextSettings } from './run-context.js';
 import { type GeneratorFactory, type YeomanTest } from './helpers.js';
+import type { DefaultEnvironmentApi, DefaultGeneratorApi } from './type-helpers.js';
 /**
  * Provides options for `RunResult`s.
  */
@@ -12,7 +12,7 @@ export type RunResultOptions<GeneratorType extends BaseGenerator> = {
     /**
      * The environment of the generator.
      */
-    env: BaseEnvironment;
+    env: DefaultEnvironmentApi;
     envOptions: BaseEnvironmentOptions;
     /**
      * The working directory after running the generator.
@@ -25,7 +25,7 @@ export type RunResultOptions<GeneratorType extends BaseGenerator> = {
     /**
      * The file-system of the generator.
      */
-    memFs: Store;
+    memFs: Store<MemFsEditorFile>;
     fs?: MemFsEditor;
     /**
      * The mocked generators of the context.
@@ -42,7 +42,7 @@ export default class RunResult<GeneratorType extends BaseGenerator = BaseGenerat
     generator: GeneratorType;
     cwd: string;
     oldCwd: string;
-    memFs: Store;
+    memFs: Store<MemFsEditorFile>;
     fs: MemFsEditor;
     mockedGenerators: any;
     options: RunResultOptions<GeneratorType>;
@@ -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 = GeneratorImplementation>(GeneratorOrNamespace: string | GeneratorFactory<GeneratorType>, settings?: RunContextSettings, envOptions?: BaseEnvironmentOptions): import("./run-context.js").default<GeneratorType>;
+    create<GeneratorType extends BaseGenerator = DefaultGeneratorApi>(GeneratorOrNamespace: string | GeneratorFactory<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/dist/run-result.js

@@ -77,7 +77,6 @@ export default class RunResult {
             this.memFs.each(file => {
                 console.log(file.path);
                 if (file.contents) {
-                    // eslint-disable-next-line @typescript-eslint/no-base-to-string
                     console.log(file.contents.toString('utf8'));
                 }
             });

package/dist/type-helpers.d.ts

@@ -0,0 +1,6 @@
+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

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

package/package.json

@@ -1,36 +1,55 @@
 {
   "name": "yeoman-test",
-  "version": "8.0.0-beta.0",
+  "version": "8.0.0-beta.2",
   "description": "Test utilities for Yeoman generators",
+  "keywords": [
+    "yeoman",
+    "unit test"
+  ],
   "homepage": "http://yeoman.io/authoring/testing.html",
+  "repository": "yeoman/yeoman-test",
+  "license": "MIT",
   "author": "The Yeoman Team",
   "type": "module",
-  "files": [
-    "dist"
-  ],
-  "types": "./dist/index.d.ts",
   "exports": {
     "types": "./dist/index.d.ts",
     "import": "./dist/index.js"
   },
-  "keywords": [
-    "yeoman",
-    "unit test"
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
   ],
-  "repository": "yeoman/yeoman-test",
-  "license": "MIT",
-  "engines": {
-    "node": "^16.17.0 || >=18.12.0"
+  "scripts": {
+    "build": "tsc",
+    "coverage": "nyc report --reporter=text-lcov | coveralls",
+    "doc": "npm run doc:generate && npm run doc:fix && npm run doc:prettier",
+    "doc:fix": "sed -i -e 's:^[[:space:]]*<!--[[:space:]]*$::g' -e 's:^[[:space:]]*-->[[:space:]]*$::g' $npm_package_config_doc_path/global.html",
+    "doc:generate": "jsdoc -c jsdoc.json -d $npm_package_config_doc_path",
+    "doc:prettier": "prettier $npm_package_config_doc_path --write --ignore-path .prettierignore-doc",
+    "precommit": "lint-staged",
+    "prepare": "npm run build",
+    "pretest": "xo",
+    "test": "c8 esmocha"
   },
   "config": {
     "doc_path": "../yeoman-test-doc"
   },
+  "dependencies": {
+    "inquirer": "^9.2.2",
+    "lodash": "^4.17.21",
+    "mem-fs": "^3.0.0",
+    "mem-fs-editor": "^10.0.2",
+    "sinon": "^14.0.2",
+    "temp-dir": "^3.0.0",
+    "type-fest": "^3.10.0"
+  },
   "devDependencies": {
+    "@types/inquirer": "^9.0.3",
     "@types/node": "^16.18.19",
     "@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",
@@ -39,47 +58,23 @@
     "tui-jsdoc-template": "^1.2.2",
     "typescript": "^5.0.4",
     "xo": "^0.54.2",
-    "yeoman-environment": "^3.16.1"
-  },
-  "dependencies": {
-    "@types/inquirer": "^9.0.3",
-    "@yeoman/types": "^0.1.2",
-    "inquirer": "^9.2.2",
-    "lodash": "^4.17.21",
-    "mem-fs": "^3.0.0",
-    "mem-fs-editor": "^10.0.2",
-    "sinon": "^14.0.2",
-    "temp-dir": "^3.0.0",
-    "yeoman-generator": "^6.0.0-alpha.4"
+    "yeoman-environment": "^3.16.1",
+    "yeoman-generator": "^5.8.0"
   },
   "peerDependencies": {
-    "yeoman-environment": "^3.13.0 || ^4.0.0-alpha.0"
-  },
-  "scripts": {
-    "test": "c8 esmocha",
-    "build": "tsc",
-    "prepare": "npm run build",
-    "pretest": "xo",
-    "precommit": "lint-staged",
-    "doc": "npm run doc:generate && npm run doc:fix && npm run doc:prettier",
-    "doc:generate": "jsdoc -c jsdoc.json -d $npm_package_config_doc_path",
-    "doc:prettier": "prettier $npm_package_config_doc_path --write --ignore-path .prettierignore-doc",
-    "doc:fix": "sed -i -e 's:^[[:space:]]*<!--[[:space:]]*$::g' -e 's:^[[:space:]]*-->[[:space:]]*$::g' $npm_package_config_doc_path/global.html",
-    "coverage": "nyc report --reporter=text-lcov | coveralls"
+    "@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"
   },
-  "husky": {
-    "hooks": {
-      "pre-commit": "npm run pretest"
+  "peerDependenciesMeta": {
+    "yeoman-environment": {
+      "optional": true
+    },
+    "yeoman-generator": {
+      "optional": true
     }
   },
-  "lint-staged": {
-    "*.js": [
-      "xo --fix",
-      "git add"
-    ],
-    "*.json": [
-      "prettier --write",
-      "git add"
-    ]
+  "engines": {
+    "node": "^16.17.0 || >=18.12.0"
   }
 }