drop bootstrap-* generators and add proxy generators (#31555)

Author: mshima

cli/environment-builder.ts

@@ -18,16 +18,17 @@
  */
 import assert from 'node:assert';
 import { existsSync } from 'node:fs';
-import path, { resolve } from 'node:path';
+import path, { join, resolve } from 'node:path';
 import { pathToFileURL } from 'node:url';
 
 import { QueuedAdapter } from '@yeoman/adapter';
 import chalk from 'chalk';
 import { cloneDeep, mergeWith } from 'lodash-es';
 import Environment from 'yeoman-environment';
 
+import BaseGenerator from '../generators/base/index.ts';
 import { type Blueprint, mergeBlueprints, parseBlueprintInfo } from '../generators/base/internal/index.ts';
-import { getPackageRoot, isDistFolder } from '../lib/index.ts';
+import { getPackageRoot, getSourceRoot, isDistFolder } from '../lib/index.ts';
 import { createJHipsterLogger, packageNameToNamespace } from '../lib/utils/index.ts';
 import { readCurrentPathYoRcFile } from '../lib/utils/yo-rc.ts';
 
@@ -179,13 +180,43 @@ export default class EnvironmentBuilder {
       packagePaths: [getPackageRoot()],
       lookups: jhipsterGeneratorsLookup,
     });
+
     generators.forEach(generator => {
       // Verify jhipster generators namespace.
       assert(
         generator.namespace.startsWith(`${CLI_NAME}:`),
         `Error on the registered namespace ${generator.namespace}, make sure your folder is called generator-jhipster.`,
       );
     });
+
+    // TODO: remove aliases in JHipster 10
+    for (const [alias, gen] of [
+      ['bootstrap-application', 'app:bootstrap'],
+      ['bootstrap-application-base', 'base-application:bootstrap'],
+      ['bootstrap-application-client', 'client:bootstrap'],
+      ['bootstrap-application-server', 'server:bootstrap'],
+      ['bootstrap-workspaces', 'base-workspaces:bootstrap'],
+    ]) {
+      this.env.register(
+        class extends BaseGenerator {
+          customLifecycle = true;
+
+          async beforeQueue() {
+            if (!this.fromBlueprint) {
+              await this.composeWithBlueprints();
+            }
+
+            await this.dependsOnJHipster(`jhipster:${gen}`);
+          }
+        },
+        {
+          namespace: `jhipster:${alias}`,
+          resolved: join(getSourceRoot(), `generators/${gen.replaceAll(':', '/generators/')}/index.${isDistFolder() ? 'j' : 't'}s`),
+          packagePath: getPackageRoot(),
+        },
+      );
+    }
+
     return this;
   }
 

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

@@ -23,13 +23,13 @@ Options:
   --node-package-manager <value>           Force an unsupported client package manager
   --ignore-errors                          Don't fail on prettier errors.
   --creation-timestamp <value>             Project creation timestamp (used for reproducible builds)
+  --skip-jhipster-dependencies             Don't write jhipster dependencies to package.json. (env: JHI_SKIP_JHIPSTER_DEPENDENCIES)
+  --base-name <value>                      Application base name
   --jdl-store <value>                      JDL store
   --skip-client                            Skip the client-side application generation
   --skip-server                            Skip the server-side application generation
   --skip-user-management                   Skip the user management module during app generation
   --application-type <value>               Application type to generate (choices: "monolith", "gateway", "microservice")
-  --skip-jhipster-dependencies             Don't write jhipster dependencies to package.json. (env: JHI_SKIP_JHIPSTER_DEPENDENCIES)
-  --base-name <value>                      Application base name
   --prettier-tab-width <value>             Default tab width for prettier (default: 2)
   --monorepository                         Use monorepository
   --skip-commit-hook                       Skip adding husky commit hooks

generators/app/command.ts

@@ -71,7 +71,7 @@ const command = {
   import: [
     'base',
     'bootstrap',
-    'bootstrap-application-base',
+    'jhipster:base-application:bootstrap',
     'jhipster:jdl:bootstrap',
     'common',
     'server',

generators/app/generators/bootstrap/generator.spec.ts

@@ -71,6 +71,11 @@ describe(`generator - ${generator}`, () => {
   shouldSupportFeatures(Generator);
   // describe('blueprint support', () => testBlueprintSupport(generator, { bootstrapGenerator: true }));
 
+  it('bootstrap migration', async () => {
+    await helpers.runJHipster('jhipster:bootstrap-application').prepareEnvironment().withMockedGenerators(['jhipster:app:bootstrap']);
+    expect(runResult.getComposedGenerators()).toContain('jhipster:app:bootstrap');
+  });
+
   describe('with', () => {
     describe('default config', () => {
       before(async () => {

generators/base-application/generator.spec.ts

@@ -68,7 +68,7 @@ describe(`generator - ${generator}`, () => {
 
     class CustomGenerator extends Generator {
       async beforeQueue() {
-        await this.dependsOnJHipster('bootstrap-application');
+        await this.dependsOnBootstrap('app');
       }
 
       get [Generator.INITIALIZING]() {
@@ -313,7 +313,7 @@ describe(`generator - ${generator}`, () => {
 
     class CustomGenerator extends Generator {
       async beforeQueue() {
-        await this.dependsOnJHipster('bootstrap-application');
+        await this.dependsOnBootstrap('app');
       }
 
       get [Generator.INITIALIZING]() {

generators/base-application/generators/bootstrap/generator.spec.ts

@@ -30,6 +30,14 @@ describe(`generator - ${generator}`, () => {
   shouldSupportFeatures(Generator);
   // describe('blueprint support', () => testBlueprintSupport(generator, { bootstrapGenerator: true }));
 
+  it('bootstrap migration', async () => {
+    await helpers
+      .runJHipster('jhipster:bootstrap-application-base')
+      .prepareEnvironment()
+      .withMockedGenerators(['jhipster:base-application:bootstrap']);
+    expect(result.getComposedGenerators()).toContain('jhipster:base-application:bootstrap');
+  });
+
   describe('with defaults options', () => {
     before(async () => {
       await helpers.runJHipster(generator).withMockedJHipsterGenerators().withMockedSource().withSharedApplication({}).withJHipsterConfig();

generators/base-simple-application/generator.spec.ts

@@ -59,7 +59,7 @@ describe(`generator - ${generator}`, () => {
 
     class CustomGenerator extends Generator {
       async beforeQueue() {
-        await this.dependsOnJHipster('bootstrap-application');
+        await this.dependsOnBootstrap('app');
       }
 
       get [Generator.INITIALIZING]() {
@@ -193,7 +193,7 @@ describe(`generator - ${generator}`, () => {
 
     class CustomGenerator extends Generator {
       async beforeQueue() {
-        await this.dependsOnJHipster('bootstrap-application');
+        await this.dependsOnBootstrap('app');
       }
 
       get [Generator.INITIALIZING]() {