Improve typing of RunResult (#165)

Improve typing of RunResult: - Add default for generator type in RunResult - Improve typing in helpers to make typescript better at infering generator type
yeoman · Jan 24, 2023 · e12bf11 · e12bf11
1 parent 028e982
commit e12bf11
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 7 deletions.
diff --git a/src/helpers.ts b/src/helpers.ts
@@ -22,10 +22,10 @@ export type Dependency = string | Parameters<Environment['registerStub']> | Para
 
 type GeneratorNew<GenParameter extends YeomanGenerator = YeomanGenerator> = new (
   ...args: ConstructorParameters<typeof YeomanGenerator<GenParameter['options']>>
-) => YeomanGenerator<GenParameter['options']>;
+) => GenParameter;
 type GeneratorBuilder<GenParameter extends YeomanGenerator = YeomanGenerator> = (
   ...args: ConstructorParameters<typeof YeomanGenerator<GenParameter['options']>>
-) => YeomanGenerator<GenParameter['options']>;
+) => GenParameter;
 
 export type GeneratorConstructor<GenParameter extends YeomanGenerator = YeomanGenerator> =
   | GeneratorNew<GenParameter>
@@ -305,7 +305,7 @@ export class YeomanTest {
    */
 
   run<GeneratorType extends YeomanGenerator = YeomanGenerator>(
-    GeneratorOrNamespace: string | GeneratorConstructor,
+    GeneratorOrNamespace: string | GeneratorConstructor<GeneratorType>,
     settings?: RunContextSettings,
     envOptions?: Options,
   ): RunContext<GeneratorType> {
@@ -332,7 +332,7 @@ export class YeomanTest {
    */
 
   create<GeneratorType extends YeomanGenerator = YeomanGenerator>(
-    GeneratorOrNamespace: string | GeneratorConstructor,
+    GeneratorOrNamespace: string | GeneratorConstructor<GeneratorType>,
     settings?: RunContextSettings,
     envOptions?: Options,
   ) {

diff --git a/src/run-context.ts b/src/run-context.ts
@@ -70,7 +70,7 @@ export class RunContextBase<GeneratorType extends Generator = Generator> extends
   private readonly onEnvironmentCallbacks: Array<(this: this, env: Environment) => any> = [];
 
   private readonly inDirCallbacks: any[] = [];
-  private readonly Generator: string | GeneratorConstructor | typeof Generator;
+  private readonly Generator: string | GeneratorConstructor<GeneratorType> | typeof Generator;
   private readonly helpers: YeomanTest;
   private readonly temporaryDir = path.join(tempDirectory, crypto.randomBytes(20).toString('hex'));
 
@@ -94,7 +94,7 @@ export class RunContextBase<GeneratorType extends Generator = Generator> extends
    */
 
   constructor(
-    generatorType: string | GeneratorConstructor | typeof Generator,
+    generatorType: string | GeneratorConstructor<GeneratorType> | typeof Generator,
     settings?: RunContextSettings,
     envOptions: Options = {},
     helpers = defaultHelpers,

diff --git a/src/run-result.ts b/src/run-result.ts
@@ -66,7 +66,7 @@ export type RunResultOptions<GeneratorType extends Generator> = {
  * This class provides utilities for testing generated content.
  */
 
-export default class RunResult<GeneratorType extends Generator> {
+export default class RunResult<GeneratorType extends Generator = Generator> {
   env: any;
   generator: GeneratorType;
   cwd: string;