yeoman-test 11.3.1 → 11.4.1

package/dist/adapter.js

@@ -10,3 +10,4 @@ export class TestAdapter extends BaseTestAdapter {
         });
     }
 }
+export {} from '@yeoman/adapter/testing';

package/dist/helpers.d.ts

@@ -1,10 +1,15 @@
 import { mock } from 'node:test';
 import type { BaseEnvironment, BaseEnvironmentOptions, BaseGenerator, BaseGeneratorConstructor, BaseGeneratorOptions, GetGeneratorConstructor, InstantiateOptions, PromptAnswers } from '@yeoman/types';
+import type { IsAny } from 'type-fest';
 import type { DefaultEnvironmentApi, DefaultGeneratorApi } from '../types/type-helpers.js';
 import { type DummyPromptOptions, TestAdapter, type TestAdapterOptions } from './adapter.js';
 import RunContext, { BasicRunContext, type RunContextSettings } from './run-context.js';
+type YeomanGeneratorOptions = import('yeoman-generator').BaseOptions;
+type GeneratorOptions = IsAny<YeomanGeneratorOptions> extends true ? BaseGeneratorOptions : YeomanGeneratorOptions;
+type YeomanEnvironmentOptions = import('yeoman-environment').EnvironmentOptions;
+type EnvironmentOptions = IsAny<YeomanEnvironmentOptions> extends true ? BaseEnvironmentOptions : YeomanEnvironmentOptions;
 export declare const setDefaultDummyParentClass: (parentClass: any) => void;
-export type CreateEnv = (options: BaseEnvironmentOptions) => Promise<BaseEnvironment>;
+export type CreateEnv = (options: EnvironmentOptions) => Promise<BaseEnvironment>;
 /**
  * Dependencies can be path (autodiscovery) or an array [<generator>, <name>]
  */
@@ -15,9 +20,11 @@ export type Dependency = string | Parameters<DefaultEnvironmentApi['register']>;
  */
 export declare class YeomanTest {
     settings?: RunContextSettings;
-    environmentOptions?: BaseEnvironmentOptions;
-    generatorOptions?: BaseGeneratorOptions;
+    environmentOptions?: EnvironmentOptions;
+    generatorOptions?: GeneratorOptions;
     adapterOptions?: Omit<TestAdapterOptions, 'mockedAnswers'>;
+    defaultGenerator?: string;
+    importMeta?: Pick<ImportMeta, 'resolve'>;
     /**
      * @deprecated
      * Create a function that will clean up the test directory,
@@ -111,7 +118,7 @@ export declare class YeomanTest {
      *   createEnv.restore();
      * });
      */
-    createEnv(options: BaseEnvironmentOptions): Promise<DefaultEnvironmentApi>;
+    createEnv(options: EnvironmentOptions): Promise<DefaultEnvironmentApi>;
     /**
      * Creates a test environment.
      *
@@ -119,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?: BaseEnvironmentOptions): Promise<BaseEnvironment>;
+    createTestEnv(environmentContructor?: CreateEnv, options?: EnvironmentOptions): Promise<BaseEnvironment>;
     /**
      * Creates a TestAdapter using helpers default options.
      */
@@ -133,13 +140,17 @@ export declare class YeomanTest {
      * Run the provided Generator
      * @param GeneratorOrNamespace - Generator constructor or namespace
      */
-    run<GeneratorType extends BaseGenerator = DefaultGeneratorApi>(GeneratorOrNamespace: string | GetGeneratorConstructor<GeneratorType>, settings?: RunContextSettings, environmentOptions?: BaseEnvironmentOptions): RunContext<GeneratorType>;
+    run<GeneratorType extends BaseGenerator = DefaultGeneratorApi>(GeneratorOrNamespace: string | GetGeneratorConstructor<GeneratorType>, settings?: RunContextSettings, environmentOptions?: EnvironmentOptions): RunContext<GeneratorType>;
+    /**
+     * Run the default generator
+     */
+    runDefault<GeneratorType extends BaseGenerator = BaseGenerator>(settings?: RunContextSettings, environmentOptions?: EnvironmentOptions): RunContext<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?: BaseEnvironmentOptions): RunContext<GeneratorType>;
+    create<GeneratorType extends BaseGenerator = DefaultGeneratorApi>(GeneratorOrNamespace: string | GetGeneratorConstructor<GeneratorType>, settings?: RunContextSettings, environmentOptions?: EnvironmentOptions): RunContext<GeneratorType>;
     /**
      * Prepare temporary dir without generator support.
      * Generator and environment will be undefined.
@@ -148,4 +159,4 @@ export declare class YeomanTest {
 }
 declare const defaultHelpers: YeomanTest;
 export default defaultHelpers;
-export declare const createHelpers: (options: any) => YeomanTest;
+export declare const createHelpers: (options: Partial<YeomanTest>) => YeomanTest;

package/dist/helpers.js

@@ -3,6 +3,7 @@ import { createRequire } from 'node:module';
 import { resolve } from 'node:path';
 import process from 'node:process';
 import { mock } from 'node:test';
+import { fileURLToPath } from 'node:url';
 import { cloneDeep } from 'lodash-es';
 import { TestAdapter } from './adapter.js';
 import RunContext, { BasicRunContext } from './run-context.js';
@@ -25,6 +26,8 @@ export class YeomanTest {
     environmentOptions;
     generatorOptions;
     adapterOptions;
+    defaultGenerator;
+    importMeta;
     /**
      * @deprecated
      * Create a function that will clean up the test directory,
@@ -254,12 +257,30 @@ export class YeomanTest {
         const contextSettings = cloneDeep(this.settings ?? {});
         const generatorOptions = cloneDeep(this.generatorOptions ?? {});
         const RunContext = this.getRunContextType();
+        if (typeof GeneratorOrNamespace === 'string' && GeneratorOrNamespace.startsWith('.')) {
+            if (!this.importMeta) {
+                throw new Error('importMeta is required to resolve relative generator paths');
+            }
+            GeneratorOrNamespace = this.importMeta.resolve(GeneratorOrNamespace);
+            if (URL.canParse(GeneratorOrNamespace)) {
+                GeneratorOrNamespace = fileURLToPath(GeneratorOrNamespace);
+            }
+        }
         const runContext = new RunContext(GeneratorOrNamespace, { ...contextSettings, ...settings }, environmentOptions, this).withOptions(generatorOptions);
         if (settings?.autoCleanup !== false) {
             testContext.startNewContext(runContext);
         }
         return runContext;
     }
+    /**
+     * Run the default generator
+     */
+    runDefault(settings, environmentOptions) {
+        if (!this.defaultGenerator) {
+            throw new Error('No default generator defined');
+        }
+        return this.run(this.defaultGenerator, settings, environmentOptions);
+    }
     /**
      * Prepare a run context
      * @param  {String|Function} GeneratorOrNamespace - Generator constructor or namespace

package/dist/index.d.ts

@@ -1,5 +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, result } from './test-context.js';
+export { default as context, result, typedResult } from './test-context.js';
 export { TestAdapter } from './adapter.js';

package/dist/index.js

@@ -1,5 +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, result } from './test-context.js';
+export { default as context, result, typedResult } from './test-context.js';
 export { TestAdapter } from './adapter.js';

package/dist/run-context.js

@@ -10,8 +10,9 @@ import { camelCase, kebabCase, merge as lodashMerge, set as lodashSet } from 'lo
 import { resetFileCommitStates } from 'mem-fs-editor/state';
 import { create as createMemFs } from 'mem-fs';
 import { create as createMemFsEditor } from 'mem-fs-editor';
-import RunResult from './run-result.js';
-import defaultHelpers from './helpers.js';
+import RunResult, {} from './run-result.js';
+import defaultHelpers, {} from './helpers.js';
+import {} from './adapter.js';
 import testContext from './test-context.js';
 const tempDirectory = realpathSync(tmpdir());
 export class RunContextBase extends EventEmitter {

package/dist/run-result.d.ts

@@ -1,12 +1,12 @@
-import { type mock } from 'node:test';
+import type { mock } from 'node:test';
 import type { Store } from 'mem-fs';
 import { type MemFsEditor, type MemFsEditorFile } from 'mem-fs-editor';
 import type { BaseEnvironmentOptions, BaseGenerator, GetGeneratorConstructor } from '@yeoman/types';
 import type { DefaultEnvironmentApi } from '../types/type-helpers.js';
-import { type RunContextSettings } from './run-context.js';
-import { type YeomanTest } from './helpers.js';
-import { type AskedQuestions } from './adapter.js';
-import { ValueOf } from 'type-fest';
+import type { RunContextSettings } from './run-context.js';
+import type { YeomanTest } from './helpers.js';
+import type { AskedQuestions } from './adapter.js';
+import type { ValueOf } from 'type-fest';
 type MemFsEditorDumpFile = ValueOf<ReturnType<MemFsEditor['dump']>>;
 /**
  * Provides options for `RunResult`s.

package/dist/test-context.d.ts

@@ -1,3 +1,4 @@
+import type { BaseGenerator } from '@yeoman/types';
 import type RunContext from './run-context.js';
 import type RunResult from './run-result.js';
 declare class TestContext {
@@ -14,3 +15,4 @@ export default testContext;
  * Provides a proxy for last executed context result.
  */
 export declare const result: RunResult;
+export declare const typedResult: <GeneratorType extends BaseGenerator>() => RunResult<GeneratorType>;

package/dist/test-context.js

@@ -41,3 +41,4 @@ const handler2 = {
  * Provides a proxy for last executed context result.
  */
 export const result = new Proxy({}, handler2);
+export const typedResult = () => result;

package/package.json

@@ -1,13 +1,16 @@
 {
   "name": "yeoman-test",
-  "version": "11.3.1",
+  "version": "11.4.1",
   "description": "Test utilities for Yeoman generators",
   "keywords": [
     "yeoman",
     "unit test"
   ],
   "homepage": "http://yeoman.io/authoring/testing.html",
-  "repository": "yeoman/yeoman-test",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/yeoman/yeoman-test.git"
+  },
   "license": "MIT",
   "author": "The Yeoman Team",
   "type": "module",
@@ -44,26 +47,27 @@
     "doc_path": "../yeoman-test-doc"
   },
   "dependencies": {
-    "lodash-es": "^4.17.23",
-    "mem-fs-editor": "^12.0.2",
+    "lodash-es": "^4.18.1",
+    "mem-fs-editor": "^12.0.3",
     "signal-exit": "^4.1.0",
-    "type-fest": "^5.4.4"
+    "type-fest": "^5.6.0"
   },
   "devDependencies": {
     "@types/lodash-es": "^4.17.12",
-    "@types/node": "^20.19.35",
-    "@vitest/coverage-v8": "^4.0.18",
+    "@types/node": "^22.19.17",
+    "@typescript-eslint/parser": "^8.56.1",
+    "@vitest/coverage-v8": "^4.1.4",
     "@yeoman/adapter": "^4.0.2",
     "@yeoman/eslint": "^1.0.0",
     "husky": "^9.1.7",
     "jsdoc": "^4.0.5",
-    "lint-staged": "^16.3.0",
-    "prettier": "^3.8.1",
-    "prettier-plugin-packagejson": "^3.0.0",
-    "typescript": "^5.9.3",
-    "vitest": "^4.0.18",
-    "yeoman-environment": "^6.0.0",
-    "yeoman-generator": "^8.0.0-beta.8"
+    "lint-staged": "^16.4.0",
+    "prettier": "^3.8.3",
+    "prettier-plugin-packagejson": "^3.0.2",
+    "typescript": "^6.0.3",
+    "vitest": "^4.1.4",
+    "yeoman-environment": "^6.0.1",
+    "yeoman-generator": "^8.1.2"
   },
   "peerDependencies": {
     "@yeoman/adapter": "^1.6.0 || ^2.0.0 || ^3.0.0 || ^4.0.1",