rework createGenerator parameters to match yeoman-environment

yeoman · May 24, 2023 · 17ff321 · 17ff321
1 parent c99f984
commit 17ff321
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 12 deletions.
diff --git a/src/helpers.ts b/src/helpers.ts
@@ -1,4 +1,3 @@
-/* eslint-disable max-params */
 import { mkdirSync, existsSync, rmSync } from 'node:fs';
 import { resolve } from 'node:path';
 import process from 'node:process';
@@ -10,7 +9,7 @@ import type {
   BaseGenerator,
   BaseGeneratorOptions,
   GetGeneratorConstructor,
-  GetGeneratorOptions,
+  InstantiateOptions,
   PromptAnswers,
   PromptQuestion,
 } from '@yeoman/types';
@@ -218,12 +217,13 @@ export class YeomanTest {
    * var angular = createGenerator('angular:app', deps);
    */
   async createGenerator<GeneratorType extends BaseGenerator = DefaultGeneratorApi>(
-    name: string,
-    dependencies: Dependency[],
-    args?: string[],
-    options?: GetGeneratorOptions<GeneratorType>,
-    localConfigOnly = true,
+    name: string | GetGeneratorConstructor<GeneratorType>,
+    options: {
+      dependencies?: Dependency[];
+      localConfigOnly?: boolean;
+    } & InstantiateOptions<GeneratorType> = {},
   ): Promise<GeneratorType> {
+    const { dependencies = [], localConfigOnly = true, ...instantiateOptions } = options;
     const env = await this.createEnv({ sharedOptions: { localConfigOnly } });
     for (const dependency of dependencies) {
       if (typeof dependency === 'string') {
@@ -233,7 +233,7 @@ export class YeomanTest {
       }
     }
 
-    return env.create<GeneratorType>(name, { generatorArgs: args, generatorOptions: options });
+    return env.create<GeneratorType>(name, instantiateOptions);
   }
 
   /**

diff --git a/test/helpers.spec.ts b/test/helpers.spec.ts
@@ -28,20 +28,29 @@ describe('yeoman-test', function () {
 
   describe('.createGenerator()', function () {
     it('create a new generator', async function () {
-      const generator = await helpers.createGenerator('unicorn:app', [[this.StubGenerator, { namespace: 'unicorn:app' }]]);
+      const generator = await helpers.createGenerator('unicorn:app', {
+        dependencies: [[this.StubGenerator, { namespace: 'unicorn:app' }]],
+      });
 
       assert.ok(generator instanceof this.StubGenerator);
     });
 
     it('pass args params to the generator', async function () {
-      const generator = await helpers.createGenerator('unicorn:app', [[this.StubGenerator, { namespace: 'unicorn:app' }]], ['temp']);
+      const generator = await helpers.createGenerator('unicorn:app', {
+        dependencies: [[this.StubGenerator, { namespace: 'unicorn:app' }]],
+        generatorArgs: ['temp'],
+      });
 
       assert.deepEqual(generator.args, ['temp']);
     });
 
     it('pass options param to the generator', async function () {
-      const generator = await helpers.createGenerator('unicorn:app', [[this.StubGenerator, { namespace: 'unicorn:app' }]], ['temp'], {
-        ui: 'tdd',
+      const generator = await helpers.createGenerator('unicorn:app', {
+        dependencies: [[this.StubGenerator, { namespace: 'unicorn:app' }]],
+        generatorArgs: ['temp'],
+        generatorOptions: {
+          ui: 'tdd',
+        },
       });
 
       assert.equal(generator.options.ui, 'tdd');