Type adjusts (#27194)

generators/angular/generator.ts

@@ -1,4 +1,3 @@
-// @ts-nocheck
 /**
  * Copyright 2013-2024 the original author or authors from the JHipster project.
  *
@@ -21,7 +20,7 @@ import { camelCase } from 'lodash-es';
 import chalk from 'chalk';
 import { isFileStateModified } from 'mem-fs-editor/state';
 
-import BaseApplicationGenerator, { type Entity } from '../base-application/index.js';
+import BaseApplicationGenerator from '../base-application/index.js';
 import { GENERATOR_ANGULAR, GENERATOR_CLIENT, GENERATOR_LANGUAGES } from '../generator-list.js';
 import { defaultLanguage } from '../languages/support/index.js';
 import { clientFrameworkTypes } from '../../jdl/jhipster/index.js';
@@ -32,9 +31,9 @@ import {
   generateTestEntityId as getTestEntityId,
   generateTestEntityPrimaryKey as getTestEntityPrimaryKey,
 } from '../client/support/index.js';
-import type { CommonClientServerApplication } from '../base-application/types.js';
 import { createNeedleCallback, mutateData } from '../base/support/index.js';
 import { writeEslintClientRootConfigFile } from '../javascript/generators/eslint/support/tasks.js';
+import type { PostWritingEntitiesTaskParam } from '../../lib/types/application/tasks.js';
 import { cleanupEntitiesFiles, postWriteEntitiesFiles, writeEntitiesFiles } from './entity-files-angular.js';
 import { writeFiles } from './files-angular.js';
 import cleanupOldFilesTask from './cleanup.js';
@@ -101,9 +100,8 @@ export default class AngularGenerator extends BaseApplicationGenerator {
       },
       addNeedles({ source, application }) {
         source.addEntitiesToClient = param => {
-          const { application, entities } = param;
-          this.addEntitiesToModule({ application, entities });
-          this.addEntitiesToMenu({ application, entities });
+          this.addEntitiesToModule(param);
+          this.addEntitiesToMenu(param);
         };
 
         source.addAdminRoute = (args: Omit<Parameters<typeof addRoute>[0], 'needle'>) =>
@@ -394,18 +392,18 @@ export default class AngularGenerator extends BaseApplicationGenerator {
     this.needleApi.clientAngular.addElementToAdminMenu(routerName, iconName, enableTranslation, translationKeyMenu, jhiPrefix);
   }
 
-  addEntitiesToMenu({ application, entities }: { application: CommonClientServerApplication; entities: Entity[] }) {
+  addEntitiesToMenu({ application, entities }: PostWritingEntitiesTaskParam) {
     const filePath = `${application.clientSrcDir}app/layouts/navbar/navbar.component.html`;
     const ignoreNonExisting = chalk.yellow('Reference to entities not added to menu.');
     const editCallback = addToEntitiesMenu({ application, entities });
 
     this.editFile(filePath, { ignoreNonExisting }, editCallback);
   }
 
-  addEntitiesToModule({ application, entities }: { application: CommonClientServerApplication; entities: Entity[] }) {
-    const filePath = `${application.clientSrcDir}app/entities/entity.routes.ts`;
+  addEntitiesToModule(param: PostWritingEntitiesTaskParam) {
+    const filePath = `${param.application.clientSrcDir}app/entities/entity.routes.ts`;
     const ignoreNonExisting = chalk.yellow(`Route(s) not added to ${filePath}.`);
-    const addRouteCallback = addEntitiesRoute({ application, entities });
+    const addRouteCallback = addEntitiesRoute(param);
     this.editFile(filePath, { ignoreNonExisting }, addRouteCallback);
   }
 

generators/angular/support/needles.ts

@@ -21,7 +21,7 @@ import type { BaseApplication } from '../../base-application/types.js';
 import { createNeedleCallback } from '../../base/support/needles.js';
 import { upperFirstCamelCase } from '../../../lib/utils/string.js';
 import { joinCallbacks } from '../../base/support/write-files.js';
-import { asPostWritingEntitiesTask } from '../../base-application/support/task-type-inference.js';
+import type { PostWritingEntitiesTaskParam } from '../../../lib/types/application/tasks.js';
 
 export function addRoute({
   needle,
@@ -56,7 +56,7 @@ export function addRoute({
   });
 }
 
-export const addEntitiesRoute = asPostWritingEntitiesTask(function addEntitiesRoute({ application, entities }: { application; entities }) {
+export function addEntitiesRoute({ application, entities }: PostWritingEntitiesTaskParam) {
   const { enableTranslation } = application;
   return joinCallbacks(
     ...entities.map(entity => {
@@ -73,7 +73,7 @@ export const addEntitiesRoute = asPostWritingEntitiesTask(function addEntitiesRo
       });
     }),
   );
-});
+}
 
 type MenuItem = {
   jhiPrefix: string;

generators/angular/support/translate-angular.ts

@@ -314,7 +314,7 @@ export const createTranslationReplacer = (getWebappTranslation, opts: ReplacerOp
     );
   }
   return function replaceAngularTranslations(content, filePath) {
-    if (/\.html$/.test(filePath)) {
+    if (filePath.endsWith('.html')) {
       if (!enableTranslation) {
         content = content.replace(new RegExp(TRANSLATE_REGEX, 'g'), '');
         content = replacePlaceholders(getWebappTranslation, content);
@@ -332,7 +332,7 @@ export const createTranslationReplacer = (getWebappTranslation, opts: ReplacerOp
       if (/(:?route|module)\.ts$/.test(filePath)) {
         content = replacePageTitles(getWebappTranslation, content);
       }
-      if (/error\.route\.ts$/.test(filePath)) {
+      if (filePath.endsWith('error.route.ts')) {
         content = replaceErrorMessage(getWebappTranslation, content);
       }
     }

generators/app/__snapshots__/generator.spec.ts.snap

@@ -250,6 +250,7 @@ exports[`generator - app with default config should match snapshot 1`] = `
   "clientFramework": "angular",
   "clientFrameworkAngular": true,
   "clientFrameworkAny": true,
+  "clientFrameworkBuiltIn": true,
   "clientFrameworkNo": false,
   "clientFrameworkReact": false,
   "clientFrameworkVue": false,
@@ -867,6 +868,7 @@ exports[`generator - app with gateway should match snapshot 1`] = `
   "clientFramework": "angular",
   "clientFrameworkAngular": true,
   "clientFrameworkAny": true,
+  "clientFrameworkBuiltIn": true,
   "clientFrameworkNo": false,
   "clientFrameworkReact": false,
   "clientFrameworkVue": false,

generators/base-application/support/enum.ts

@@ -47,23 +47,23 @@ const getEnums = (enums, customValuesState, comments) => {
     return enums.map(enumValue => ({
       name: enumValue,
       value: enumValue,
-      comment: comments && comments[enumValue] && formatDocAsJavaDoc(comments[enumValue], 4),
+      comment: comments?.[enumValue] && formatDocAsJavaDoc(comments[enumValue], 4),
     }));
   }
   return enums.map(enumValue => {
     if (!doesTheEnumValueHaveACustomValue(enumValue)) {
       return {
         name: enumValue.trim(),
         value: enumValue.trim(),
-        comment: comments && comments[enumValue] && formatDocAsJavaDoc(comments[enumValue], 4),
+        comment: comments?.[enumValue] && formatDocAsJavaDoc(comments[enumValue], 4),
       };
     }
 
     const matched = /\s*(.+?)\s*\((.+?)\)/.exec(enumValue);
     return {
       name: matched![1],
       value: matched![2],
-      comment: comments && comments[matched![1]] && formatDocAsJavaDoc(comments[matched![1]], 4),
+      comment: comments?.[matched![1]] && formatDocAsJavaDoc(comments[matched![1]], 4),
     };
   });
 };

generators/base-application/support/prepare-entity.ts

@@ -275,9 +275,9 @@ export default function prepareEntity(entityWithConfig, generator, application)
 
 export function derivedPrimaryKeyProperties(primaryKey) {
   mutateData(primaryKey, {
-    hasUUID: primaryKey.fields && primaryKey.fields.some(field => field.fieldType === UUID),
-    hasLong: primaryKey.fields && primaryKey.fields.some(field => field.fieldType === LONG),
-    hasInteger: primaryKey.fields && primaryKey.fields.some(field => field.fieldType === INTEGER),
+    hasUUID: primaryKey.fields?.some(field => field.fieldType === UUID),
+    hasLong: primaryKey.fields?.some(field => field.fieldType === LONG),
+    hasInteger: primaryKey.fields?.some(field => field.fieldType === INTEGER),
     typeUUID: primaryKey.type === UUID,
     typeString: primaryKey.type === STRING,
     typeLong: primaryKey.type === LONG,
@@ -604,7 +604,7 @@ function preparePostEntityCommonDerivedPropertiesNotTyped(entity: any) {
     entity.relationships.some(relationship => !relationship.id && relationship.persistableRelationship);
 
   entity.allReferences
-    .filter(reference => reference.relationship && reference.relationship.relatedField)
+    .filter(reference => reference.relationship?.relatedField)
     .forEach(reference => {
       reference.relatedReference = reference.relationship.relatedField.reference;
     });

generators/base-application/support/prepare-field.ts

@@ -1,4 +1,3 @@
-// @ts-nocheck
 /**
  * Copyright 2013-2024 the original author or authors from the JHipster project.
  *
@@ -22,6 +21,7 @@ import { fieldTypes, validations } from '../../../jdl/jhipster/index.js';
 import { getTypescriptType, prepareField as prepareClientFieldForTemplates } from '../../client/support/index.js';
 import { prepareField as prepareServerFieldForTemplates } from '../../server/support/index.js';
 import { mutateData } from '../../../lib/utils/object.js';
+import type CoreGenerator from '../../base-core/generator.js';
 import { fieldIsEnum } from './field-utils.js';
 import { prepareProperty } from './prepare-property.js';
 
@@ -104,7 +104,7 @@ const fakeStringTemplateForFieldName = columnName => {
  * @param {string} type csv, cypress, json-serializable, ts
  * @returns fake value
  */
-function generateFakeDataForField(field, faker, changelogDate, type = 'csv') {
+function generateFakeDataForField(this: CoreGenerator, field, faker, changelogDate, type = 'csv') {
   let data;
   if (field.fakerTemplate) {
     data = faker.faker(field.fakerTemplate);
@@ -264,7 +264,7 @@ export default function prepareField(entityWithConfig, field, generator) {
     prepareServerFieldForTemplates(entityWithConfig, field, generator);
   }
 
-  prepareClientFieldForTemplates(entityWithConfig, field, generator);
+  prepareClientFieldForTemplates(entityWithConfig, field);
   return field;
 }
 
@@ -371,8 +371,8 @@ export function getEnumValuesWithCustomValues(enumValues) {
     }
     const matched = /\s*(.+?)\s*\((.+?)\)/.exec(enumValue);
     return {
-      name: matched[1],
-      value: matched[2],
+      name: matched![1],
+      value: matched![2],
     };
   });
 }

generators/base-application/support/prepare-relationship.ts

@@ -1,3 +1,4 @@
+// @ts-nocheck
 /**
  * Copyright 2013-2024 the original author or authors from the JHipster project.
  *
@@ -22,8 +23,11 @@ import pluralize from 'pluralize';
 import { checkAndReturnRelationshipOnValue, databaseTypes, entityOptions, validations } from '../../../jdl/jhipster/index.js';
 import { getJoinTableName, hibernateSnakeCase } from '../../server/support/index.js';
 import { mutateData } from '../../../lib/utils/object.js';
-import { stringifyApplicationData } from './debug.js';
+import type CoreGenerator from '../../base-core/generator.js';
+import type { Relationship } from '../../../lib/types/application/relationship.js';
+import type { Entity } from '../../../lib/types/application/entity.js';
 import { prepareProperty } from './prepare-property.js';
+import { stringifyApplicationData } from './debug.js';
 
 const { NEO4J, NO: DATABASE_NO } = databaseTypes;
 const { MapperTypes } = entityOptions;
@@ -33,12 +37,17 @@ const {
 
 const { MAPSTRUCT } = MapperTypes;
 
-function _defineOnUpdateAndOnDelete(relationship, generator) {
+function _defineOnUpdateAndOnDelete(relationship: Relationship, generator: CoreGenerator) {
   relationship.onDelete = checkAndReturnRelationshipOnValue(relationship.options?.onDelete, generator);
   relationship.onUpdate = checkAndReturnRelationshipOnValue(relationship.options?.onUpdate, generator);
 }
 
-export default function prepareRelationship(entityWithConfig, relationship, generator, ignoreMissingRequiredRelationship) {
+export default function prepareRelationship(
+  entityWithConfig: Entity,
+  relationship: Relationship<Entity>,
+  generator: CoreGenerator,
+  ignoreMissingRequiredRelationship = false,
+) {
   const entityName = entityWithConfig.name;
   const { otherEntityName, relationshipSide, relationshipType, relationshipName } = relationship;
 
@@ -228,7 +237,7 @@ export default function prepareRelationship(entityWithConfig, relationship, gene
     relationship.otherEntityPath = relationship.otherEntityFolderName;
   }
 
-  if (relationship.relationshipValidateRules && relationship.relationshipValidateRules.includes(REQUIRED)) {
+  if (relationship.relationshipValidateRules?.includes(REQUIRED)) {
     if (entityName.toLowerCase() === relationship.otherEntityName.toLowerCase()) {
       generator.log.warn(`Error at entity ${entityName}: required relationships to the same entity are not supported.`);
     } else {

generators/base-application/support/relationship.ts

@@ -76,7 +76,7 @@ export const loadEntitiesOtherSide = (entities: JSONEntity[], { application }: {
           if (!application || application.authenticationTypeOauth2) {
             errors.push("oauth2 applications with database and '--sync-user-with-idp' option");
           }
-          if (!application || !application.authenticationTypeOauth2) {
+          if (!application?.authenticationTypeOauth2) {
             errors.push('jwt and session authentication types in monolith or gateway applications with database');
           }
           throw new Error(`Error at entity ${entity.name}: relationships with built-in User entity is supported in ${errors}.`);

generators/base-core/generator.ts

@@ -67,6 +67,7 @@ import { dockerPlaceholderGenerator } from '../docker/utils.js';
 import { getConfigWithDefaults } from '../../jdl/jhipster/index.js';
 import { extractArgumentsFromConfigs } from '../../lib/command/index.js';
 import type { Entity } from '../../lib/types/base/entity.js';
+import type BaseApplicationGenerator from '../base-application/generator.js';
 
 const {
   INITIALIZING,
@@ -696,8 +697,9 @@ You can ignore this error by passing '--skip-checks' to jhipster command.`);
    * Compose with a jhipster generator using default jhipster config.
    * @return {object} the composed generator
    */
-  async composeWithJHipster(generator: string, options?: ComposeOptions) {
-    assert(typeof generator === 'string', 'generator should to be a string');
+  async composeWithJHipster<const G extends string>(gen: G, options?: ComposeOptions<BaseApplicationGenerator>) {
+    assert(typeof gen === 'string', 'generator should to be a string');
+    let generator: string = gen;
     if (!isAbsolute(generator)) {
       const namespace = generator.includes(':') ? generator : `jhipster:${generator}`;
       if (await this.env.get(namespace)) {
@@ -729,7 +731,7 @@ You can ignore this error by passing '--skip-checks' to jhipster command.`);
   /**
    * Compose with a jhipster generator using default jhipster config, but queue it immediately.
    */
-  async dependsOnJHipster(generator: string, options?: ComposeOptions) {
+  async dependsOnJHipster(generator: string, options?: ComposeOptions<BaseApplicationGenerator>) {
     return this.composeWithJHipster(generator, {
       ...options,
       schedule: false,
@@ -972,7 +974,7 @@ templates: ${JSON.stringify(existingTemplates, null, 2)}`;
       } catch (error) {
         throw new Error(`Error rendering template ${sourceFileFrom} to ${targetFile}: ${error}`, { cause: error });
       }
-      if (!isBinary && transform && transform.length) {
+      if (!isBinary && transform?.length) {
         this.editFile(targetFile, ...transform);
       }
       return targetFile;

generators/base-workspaces/internal/docker-prompts.ts

@@ -389,7 +389,7 @@ export function getAppFolders(directory, deploymentApplicationType) {
                 deploymentApplicationType === (fileData['generator-jhipster'].applicationType ?? MONOLITH) ||
                 (deploymentApplicationType === MICROSERVICE && fileData['generator-jhipster'].applicationType === GATEWAY))
             ) {
-              appsFolders.push(file.match(/([^/]*)\/*$/)[1]);
+              appsFolders.push(/([^/]*)\/*$/.exec(file)[1]);
             }
           } catch (err) {
             this.log.error(chalk.red(`${yoRcFile}: this .yo-rc.json can't be read`));

generators/base/api.d.ts

@@ -14,14 +14,17 @@ export type ApplicationWithConfig = {
 export type JHipsterGeneratorOptions = BaseOptions & {
   /* cli options */
   commandName: string;
+  programName: string;
   positionalArguments?: unknown[];
+  createEnvBuilder?: any;
 
   /* yeoman options */
   skipYoResolve?: boolean;
   sharedData: any;
   force?: boolean;
 
   /* base options */
+  defaults?: boolean;
   applicationId?: string;
   applicationWithConfig?: ApplicationWithConfig;
   /**
@@ -191,7 +194,7 @@ export type WriteFileOptions<DataType = ApplicationType<Entity>, Generator = Cor
     }
   | {
       /** templates to be written */
-      templates: WriteFileTemplate<DataType, Generator>;
+      templates: WriteFileTemplate<DataType, Generator>[];
     }
   | {
       /** blocks to be written */

generators/base/generator.ts

@@ -454,7 +454,7 @@ export default class JHipsterBaseBlueprintGenerator<TaskTypes extends BaseTaskTy
   protected async composeWithBlueprints(subGen?: string, options?: ComposeOptions) {
     if (subGen === undefined) {
       const { namespace } = this.options;
-      if (!namespace || !namespace.startsWith('jhipster:')) {
+      if (!namespace?.startsWith('jhipster:')) {
         throw new Error(`Generator is not blueprintable ${namespace}`);
       }
       subGen = namespace.substring('jhipster:'.length);
@@ -653,7 +653,7 @@ export default class JHipsterBaseBlueprintGenerator<TaskTypes extends BaseTaskTy
    */
   private _findBlueprintVersion(blueprintPkgName) {
     const blueprintPackageJson = this._findBlueprintPackageJson(blueprintPkgName);
-    if (!blueprintPackageJson || !blueprintPackageJson.version) {
+    if (!blueprintPackageJson?.version) {
       this.log.warn(`Could not retrieve version of blueprint '${blueprintPkgName}'`);
       return undefined;
     }

generators/base/internal/blueprint.ts

@@ -26,7 +26,7 @@ import { requireNamespace } from '@yeoman/namespace';
  */
 export function loadBlueprintsFromConfiguration(config) {
   // handle both config based on yeoman's Storage object, and direct configuration loaded from .yo-rc.json
-  const configuration = config && config.getAll && typeof config.getAll === 'function' ? config.getAll() || {} : config;
+  const configuration = config?.getAll && typeof config.getAll === 'function' ? config.getAll() || {} : config;
   // load blueprints from config file
   const blueprints = configuration.blueprints || [];
 
@@ -134,7 +134,7 @@ export function normalizeBlueprintName(blueprint) {
     return ns.with({ unscoped: `generator-jhipster-${ns.unscoped}` }).toString();
     // eslint-disable-next-line no-empty
   } catch {}
-  if (blueprint && blueprint.startsWith('@')) {
+  if (blueprint?.startsWith('@')) {
     return blueprint;
   }
   if (blueprint && !blueprint.startsWith('generator-jhipster')) {

generators/base/support/basename.ts

@@ -5,7 +5,7 @@ import { camelCase } from 'lodash-es';
  */
 export const getFrontendAppName = ({ baseName }: { baseName: string }) => {
   const name = camelCase(baseName) + (baseName.endsWith('App') ? '' : 'App');
-  return name.match(/^\d/) ? 'App' : name;
+  return /^\d/.exec(name) ? 'App' : name;
 };
 
 export const getMicroserviceAppName = ({ microserviceName }: { microserviceName: string }) => {