gen-jhipster/dist/generators/base/types.d.ts

VHipster - Spring Boot + Angular/React/Vue in one handy generator

import type { ExportGeneratorOptionsFromCommand, ExportStoragePropertiesFromCommand } from '../../lib/command/types.ts';
import type { Config as CoreConfig, Features as CoreFeatures, Options as CoreOptions } from '../base-core/types.ts';

import type Command from './command.ts';
import type BaseGenerator from './generator.ts';

export type Source = {
  /* Dummy field to declare an empty type */
  _jhipsterSource: never;
};

export type CleanupArgumentType = Record<string, (string | [boolean, ...string[]])[]>;

export type Control = {
  readonly existingProject: boolean;
  readonly jhipsterOldVersion: string | null;
  readonly environmentHasDockerCompose?: boolean;
  readonly customizeRemoveFiles: ((file: string) => string | undefined)[];
  /**
   * Check if the JHipster version used to generate an existing project is less than the passed version argument
   *
   * @param {string} version - A valid semver version string
   */
  isJhipsterVersionLessThan(version: string): boolean;
  removeFiles: (options: { oldVersion?: string; removedInVersion: string } | string, ...files: string[]) => Promise<void>;
  /**
   * Cleanup files conditionally based on version and condition.
   * @example
   * cleanupFiles({ '6.0.0': ['file1', 'file2', [application.shouldRemove, 'file3']] })
   * @example
   * cleanupFiles('4.0.0', { '6.0.0': ['file1', 'file2', [application.shouldRemove, 'file3']] })
   */
  cleanupFiles: (cleanup: CleanupArgumentType) => Promise<void> | ((oldVersion: string, cleanup: CleanupArgumentType) => Promise<void>);
};

export type Config = CoreConfig &
  ExportStoragePropertiesFromCommand<typeof Command> & {
    jhipsterVersion?: string;
    lastLiquibaseTimestamp?: number;
    creationTimestamp?: number;
    blueprints?: { name: string; version?: string }[];
  };

export type Options = CoreOptions &
  ExportGeneratorOptionsFromCommand<typeof Command> & {
    reproducibleTests?: boolean;
    entities?: string[];

    jhipsterContext?: BaseGenerator;
    composeWithLocalBlueprint?: boolean;
  };

export type Features = CoreFeatures & {
  /**
   * Compose with bootstrap generator.
   *
   * Bootstrap generator adds support to:
   *  - multistep templates.
   *  - sort jhipster configuration json.
   *  - force jhipster configuration commit.
   *  - earlier prettier config commit for correct prettier.
   *  - prettier and eslint.
   *
   * Defaults to false for generators that extends base-core directly and generators with namespaces matching *:bootstrap*.
   * Defaults to true for others generators that extends base.
   */
  jhipsterBootstrap?: boolean;

  /**
   * Indicates if the generator is a side-by-side blueprint.
   */
  sbsBlueprint?: boolean;
  /**
   * Check if the generator is composed as a blueprint.
   */
  checkBlueprint?: boolean;

  /**
   * Store current version at .yo-rc.json.
   * Defaults to true.
   */
  storeJHipsterVersion?: boolean;

  /**
   * Store current version at .yo-rc.json.
   * Defaults to true.
   */
  storeBlueprintVersion?: boolean;
};