@yeoman/types/types/generator/generator.d.ts

Common API for yeoman's generator/environment stack

import type { BaseEnvironment } from '../environment/environment.js';
import type { GeneratorMeta } from '../environment/methods-options.js';
import type { GeneratorFeatures } from './generator-features.js';
import type { GeneratorOptions } from './generator-options.js';

export type EnvironmentGenerator = {
  readonly env: BaseEnvironment;
  readonly features: unknown;

  emit(eventName: string | symbol, ...arguments_: any[]): boolean;
  on(eventName: string | symbol, listener: (...arguments_: any[]) => void): unknown;
  once(eventName: string | symbol, listener: (...arguments_: any[]) => void): unknown;

  _postConstruct?(): Promise<void>;

  /**
   * Get the generator destination root directory.
   */
  destinationRoot(): string;
  /**
   * Set the generator destination root directory.
   */
  destinationRoot(rootPath: string): string;

  // Generator >= v5
  queueTasks?(): Promise<void>;
};

export type BaseGenerator<
  O extends GeneratorOptions = GeneratorOptions,
  F extends GeneratorFeatures = GeneratorFeatures,
> = EnvironmentGenerator & {
  readonly options: O;

  // Generator >= v5
  readonly features: F | undefined;

  readonly _meta?: GeneratorMeta;
};

export type BaseGeneratorConstructor<O extends GeneratorOptions = GeneratorOptions, F extends GeneratorFeatures = GeneratorFeatures> = new (
  arguments_?: string[],
  options?: O,
  features?: F,
) => BaseGenerator<O, F>;