generator-jhipster 8.7.0 → 8.7.2

package/README.md

@@ -6,7 +6,7 @@
 
 Greetings, Java Hipster!
 
-Full documentation and information is available on our website at [https://www.jhipster.tech/][jhipster-url]
+Full documentation and information is available on our website at [https://www.jhipster.tech][jhipster-url].
 
 Please read our [guidelines](/CONTRIBUTING.md#submitting-an-issue) before submitting an issue. If your issue is a bug, please use the bug template pre-populated [here][issue-template]. For feature requests and queries you can use [this template][feature-template]. If you have found a potential security issue, please read our security policy and contact us privately first: https://github.com/jhipster/generator-jhipster/security/policy
 
@@ -20,7 +20,7 @@ The following Java and Node combinations are tested and verified by GitHub Actio
 
 | Java     | Node  | Status |
 | -------- | ----- | ------ |
-| 17/21/22 | 18/20 | ✅     |
+| 17/21/23 | 18/20 | ✅     |
 
 ## Sponsors
 

package/dist/cli/commands.d.mts

@@ -0,0 +1,125 @@
+declare const defaultCommands: {
+    readonly add: {
+        readonly desc: "Add a feature to current project";
+        readonly removed: string;
+    };
+    readonly app: {
+        readonly desc: "[Default] Create a new JHipster application based on the selected options";
+    };
+    readonly aws: {
+        readonly desc: "Deploy the current application to Amazon Web Services";
+        readonly removed: string;
+    };
+    readonly 'azure-app-service': {
+        readonly desc: "Deploy the current application to Azure App Service";
+        readonly removed: string;
+    };
+    readonly 'azure-spring-cloud': {
+        readonly desc: "Deploy the current application to Azure Spring Cloud";
+        readonly removed: string;
+    };
+    readonly 'ci-cd': {
+        readonly desc: "Create pipeline scripts for popular Continuous Integration/Continuous Deployment tools";
+    };
+    readonly cloudfoundry: {
+        readonly desc: "Generate a `deploy/cloudfoundry` folder with a specific manifest.yml to deploy to Cloud Foundry";
+        readonly removed: string;
+    };
+    readonly 'docker-compose': {
+        readonly desc: "Create all required Docker deployment configuration for the selected applications";
+    };
+    readonly download: {
+        readonly desc: "Download jdl file from template repository";
+        readonly cliOnly: true;
+        readonly argument: ["<jdlFiles...>"];
+    };
+    readonly entity: {
+        readonly desc: "Create a new JHipster entity: JPA entity, Spring server-side components and Angular client-side components";
+    };
+    readonly entities: {
+        readonly desc: "Regenerate entities";
+    };
+    readonly 'export-jdl': {
+        readonly desc: "Create a JDL file from the existing entities";
+    };
+    readonly gae: {
+        readonly desc: "Deploy the current application to Google App Engine";
+        readonly removed: string;
+    };
+    readonly 'generate-blueprint': {
+        readonly desc: "Generate a blueprint";
+    };
+    readonly gradle: {
+        readonly desc: "Create Gradle project (alpha)";
+    };
+    readonly heroku: {
+        readonly desc: "Deploy the current application to Heroku";
+    };
+    readonly info: {
+        readonly desc: "Display information about your current project and system";
+    };
+    readonly init: {
+        readonly desc: "Init project (alpha)";
+    };
+    readonly java: {
+        readonly desc: "Run java generator (alpha)";
+    };
+    readonly jdl: {
+        readonly alias: "import-jdl";
+        readonly desc: "Create entities from the JDL file/URL/content passed in argument.\n    Use the '--interactive' flag to generate multiple applications in series.";
+        readonly help: "\n    Arguments:\n    jdlFiles # The JDL file names or URL Type: String[] Required: true if --inline is not set\n\n    Example:\n    jhipster jdl myfile.jdl\n    jhipster jdl myfile1.jdl myfile2.jdl\n    jhipster jdl https://gist.githubusercontent.com/user/path/app.jdl\n    jhipster jdl jdl-name-from-jdl-samples-repo.jdl (just pass any file name from https://github.com/jhipster/jdl-samples)\n    jhipster jdl --inline \"application { config { baseName jhapp, testFrameworks [cypress] }}\"\n    jhipster jdl --inline \\\n        \"application {\n            config {\n                baseName jhapp,\n                testFrameworks [cypress]\n            }\n        }\"\n    ";
+    };
+    readonly kubernetes: {
+        readonly alias: "k8s";
+        readonly desc: "Deploy the current application to Kubernetes";
+    };
+    readonly 'kubernetes-helm': {
+        readonly alias: "helm";
+        readonly desc: "Deploy the current application to Kubernetes using Helm package manager";
+    };
+    readonly 'kubernetes-knative': {
+        readonly alias: "knative";
+        readonly desc: "Deploy the current application to Kubernetes using knative constructs";
+    };
+    readonly languages: {
+        readonly desc: "Select languages from a list of available languages. The i18n files will be copied to the /webapp/i18n folder";
+    };
+    readonly maven: {
+        readonly desc: "Create Maven project (alpha)";
+    };
+    readonly openshift: {
+        readonly desc: "Deploy the current application to OpenShift";
+        readonly removed: string;
+    };
+    readonly page: {
+        readonly desc: "Create a new page. (Supports vue clients)";
+        readonly removed: string;
+    };
+    readonly 'project-name': {
+        readonly desc: "Configure project name (alpha)";
+    };
+    readonly run: {
+        readonly desc: "Run a module or custom generator";
+        readonly argument: ["[generator]"];
+    };
+    readonly 'spring-service': {
+        readonly alias: "service";
+        readonly desc: "Create a new Spring service bean";
+        readonly removed: string;
+    };
+    readonly 'spring-controller': {
+        readonly desc: "Create a new Spring controller";
+        readonly removed: string;
+    };
+    readonly 'openapi-client': {
+        readonly desc: "Generates java client code from an OpenAPI/Swagger definition";
+        readonly removed: string;
+    };
+    readonly upgrade: {
+        readonly desc: "Upgrade the JHipster version, and upgrade the generated application";
+    };
+    readonly workspaces: {
+        readonly desc: "Add workspaces configuration";
+    };
+};
+export default defaultCommands;

package/dist/cli/environment-builder.d.mts

@@ -0,0 +1,146 @@
+export default class EnvironmentBuilder {
+    /**
+     * Creates a new EnvironmentBuilder with a new Environment.
+     *
+     * @param {any} [args] - Arguments passed to Environment.createEnv().
+     * @param {Object} [options] - options passed to Environment.createEnv().
+     * @param [adapter] - adapter passed to Environment.createEnv().
+     * @return {EnvironmentBuilder} envBuilder
+     */
+    static create(options?: any): EnvironmentBuilder;
+    /**
+     * Creates a new Environment with blueprints.
+     *
+     * Can be used to create a new test environment (requires yeoman-test >= 2.6.0):
+     * @example
+     * const promise = require('yeoman-test').create('jhipster:app', {}, {createEnv: EnvironmentBuilder.createEnv}).run();
+     *
+     * @param {...any} args - Arguments passed to Environment.createEnv().
+     * @return {Promise<Environment>} envBuilder
+     */
+    static createEnv(...args: any[]): Promise<Environment>;
+    /**
+     * Creates a new EnvironmentBuilder with a new Environment and load jhipster, blueprints and sharedOptions.
+     *
+     * @param {...any} args - Arguments passed to Environment.createEnv().
+     * @return {EnvironmentBuilder} envBuilder
+     */
+    static createDefaultBuilder(...args: any[]): EnvironmentBuilder;
+    static run(args: any, generatorOptions?: {}, envOptions?: {}): Promise<void>;
+    /**
+     * Class to manipulate yeoman environment for jhipster needs.
+     * - Registers jhipster generators.
+     * - Loads blueprints from argv and .yo-rc.json.
+     * - Installs blueprints if not found.
+     * - Loads sharedOptions.
+     */
+    constructor(env: any);
+    /** @type {Environment} */
+    env: Environment;
+    devBlueprintPath: any;
+    localBlueprintPath: any;
+    localBlueprintExists: any;
+    prepare({ blueprints, lookups, devBlueprintPath }?: {
+        blueprints: any;
+        lookups: any;
+        devBlueprintPath?: string | undefined;
+    }): Promise<this>;
+    getBlueprintsNamespaces(): any[];
+    /**
+     * Construct blueprint option value.
+     *
+     * @return {String}
+     */
+    getBlueprintsOption(): string;
+    /**
+     * @private
+     * Lookup current jhipster generators.
+     *
+     * @return {EnvironmentBuilder} this for chaining.
+     */
+    private _lookupJHipster;
+    _lookupLocalBlueprint(): Promise<this>;
+    _lookupDevBlueprint(): Promise<this>;
+    _lookups(lookups?: any[]): Promise<this>;
+    /**
+     * @private
+     * Load blueprints from argv, .yo-rc.json.
+     *
+     * @return {EnvironmentBuilder} this for chaining.
+     */
+    private _loadBlueprints;
+    _blueprintsWithVersion: any;
+    /**
+     * @private
+     * Lookup current loaded blueprints.
+     *
+     * @param {Object} [options] - forwarded to Environment lookup.
+     * @return {EnvironmentBuilder} this for chaining.
+     */
+    private _lookupBlueprints;
+    /**
+     * Lookup for generators.
+     *
+     * @param {string[]} [generators] - generators to lookup.
+     * @param {Object} [options] - forwarded to Environment lookup.
+     * @return {EnvironmentBuilder} this for chaining.
+     */
+    lookupGenerators(generators?: string[] | undefined, options?: any): EnvironmentBuilder;
+    /**
+     * @private
+     * Load sharedOptions from jhipster and blueprints.
+     *
+     * @return {Promise<EnvironmentBuilder>} this for chaining.
+     */
+    private _loadSharedOptions;
+    /**
+     * Get blueprints commands.
+     *
+     * @return {Record<string, import('./types.js').CliCommand>} blueprint commands.
+     */
+    getBlueprintCommands(): Record<string, import("./types.js").CliCommand>;
+    /**
+     * Get the environment.
+     *
+     * @return {Environment} the yeoman environment.
+     */
+    getEnvironment(): Environment;
+    /**
+     * @private
+     * Load blueprints from argv.
+     * At this point, commander has not parsed yet because we are building it.
+     * @returns {Blueprint[]}
+     */
+    private _getBlueprintsFromArgv;
+    /**
+     * @private
+     * Load blueprints from .yo-rc.json.
+     * @returns {Blueprint[]}
+     */
+    private _getBlueprintsFromYoRc;
+    /**
+     * @private
+     * Creates a 'blueprintName: blueprintVersion' object from argv and .yo-rc.json blueprints.
+     */
+    private _getAllBlueprintsWithVersion;
+    /**
+     * @private
+     * Get packagePaths from current loaded blueprints.
+     */
+    private _getBlueprintPackagePaths;
+    /**
+     * @private
+     * Get blueprints commands.
+     *
+     * @return {Record<string, import('./types.js').CliCommand>} commands.
+     */
+    private _getBlueprintCommands;
+    /**
+     * @private
+     * Get blueprints sharedOptions.
+     *
+     * @return {Object} sharedOptions.
+     */
+    private _getSharedOptions;
+}
+import Environment from 'yeoman-environment';

package/dist/cli/environment-builder.mjs

@@ -17,7 +17,7 @@
  * limitations under the License.
  */
 import assert from 'assert';
-import { existsSync, readFileSync } from 'fs';
+import { existsSync } from 'fs';
 import path, { dirname, resolve } from 'path';
 import { fileURLToPath, pathToFileURL } from 'url';
 import chalk from 'chalk';
@@ -26,6 +26,7 @@ import Environment from 'yeoman-environment';
 import { QueuedAdapter } from '@yeoman/adapter';
 import { createJHipsterLogger, packageNameToNamespace } from '../generators/base/support/index.js';
 import { loadBlueprintsFromConfiguration, mergeBlueprints, parseBlueprintInfo } from '../generators/base/internal/index.js';
+import { readCurrentPathYoRcFile } from '../lib/utils/yo-rc.js';
 import { CLI_NAME, logger } from './utils.mjs';
 const __filename = fileURLToPath(import.meta.url);
 const __dirname = dirname(__filename);
@@ -36,17 +37,13 @@ const defaultLookupOptions = {
     lookups: ['generators', 'generators/*/generators'],
     customizeNamespace: ns => ns?.replaceAll(':generators:', ':'),
 };
-function loadYoRc(filePath = '.yo-rc.json') {
-    if (!existsSync(filePath)) {
-        return undefined;
-    }
-    return JSON.parse(readFileSync(filePath, { encoding: 'utf-8' }));
-}
 const createEnvironment = (options = {}) => {
     options.adapter = options.adapter ?? new QueuedAdapter({ log: createJHipsterLogger() });
     return new Environment({ newErrorHandler: true, ...options });
 };
 export default class EnvironmentBuilder {
+    /** @type {Environment} */
+    env;
     devBlueprintPath;
     localBlueprintPath;
     localBlueprintExists;
@@ -71,7 +68,7 @@ export default class EnvironmentBuilder {
      * const promise = require('yeoman-test').create('jhipster:app', {}, {createEnv: EnvironmentBuilder.createEnv}).run();
      *
      * @param {...any} args - Arguments passed to Environment.createEnv().
-     * @return {EnvironmentBuilder} envBuilder
+     * @return {Promise<Environment>} envBuilder
      */
     static async createEnv(...args) {
         const builder = await EnvironmentBuilder.createDefaultBuilder(...args);
@@ -253,7 +250,7 @@ export default class EnvironmentBuilder {
     /**
      * Get blueprints commands.
      *
-     * @return {Object[]} blueprint commands.
+     * @return {Record<string, import('./types.js').CliCommand>} blueprint commands.
      */
     async getBlueprintCommands() {
         let blueprintsPackagePath = await this._getBlueprintPackagePaths();
@@ -301,8 +298,8 @@ export default class EnvironmentBuilder {
      * @returns {Blueprint[]}
      */
     _getBlueprintsFromYoRc() {
-        const yoRc = loadYoRc();
-        if (!yoRc || !yoRc['generator-jhipster']) {
+        const yoRc = readCurrentPathYoRcFile();
+        if (!yoRc?.['generator-jhipster']) {
             return [];
         }
         return loadBlueprintsFromConfiguration(yoRc['generator-jhipster']);
@@ -354,7 +351,7 @@ export default class EnvironmentBuilder {
      * @private
      * Get blueprints commands.
      *
-     * @return {Object[]} commands.
+     * @return {Record<string, import('./types.js').CliCommand>} commands.
      */
     async _getBlueprintCommands(blueprintPackagePaths) {
         if (!blueprintPackagePaths) {
@@ -364,7 +361,7 @@ export default class EnvironmentBuilder {
         for (const [blueprint, packagePath] of blueprintPackagePaths) {
             let blueprintCommand;
             const blueprintCommandFile = `${packagePath}/cli/commands`;
-            const blueprintCommandExtension = ['.js', '.cjs', '.mjs'].find(extension => existsSync(`${blueprintCommandFile}${extension}`));
+            const blueprintCommandExtension = ['.js', '.cjs', '.mjs', '.ts', '.cts', '.mts'].find(extension => existsSync(`${blueprintCommandFile}${extension}`));
             if (blueprintCommandExtension) {
                 const blueprintCommandsUrl = pathToFileURL(resolve(`${blueprintCommandFile}${blueprintCommandExtension}`));
                 try {

package/dist/cli/jhipster-command.d.mts

@@ -0,0 +1,74 @@
+export default class JHipsterCommand extends Command {
+    configs: {};
+    blueprintConfigs: {};
+    createCommand(name: any): JHipsterCommand;
+    /**
+     * Alternative for alias() accepting chaining with undefined value.
+     * @param {String} alias
+     * @return {JHipsterCommand} this;
+     */
+    addAlias(alias: string): JHipsterCommand;
+    /**
+     * Register a callback to be executed before _parseCommand.
+     * Used to lazy load options.
+     * @param {Function} lazyBuildCommandCallBack
+     * @return {JHipsterCommand} this;
+     */
+    lazyBuildCommand(lazyBuildCommandCallBack: Function): JHipsterCommand;
+    _lazyBuildCommandCallBack: Function | undefined;
+    /**
+     * Register callback to customize _excessArguments behavior.
+     * @param {Function} excessArgumentsCallback
+     * @return {JHipsterCommand} this;
+     */
+    excessArgumentsCallback(excessArgumentsCallback: Function): JHipsterCommand;
+    _excessArgumentsCallback: Function | undefined;
+    /**
+     * @private
+     * Override _excessArguments to customize behavior.
+     */
+    private _excessArguments;
+    /**
+     * @private
+     * Override _parseCommand to execute a callback before parsing.
+     */
+    private _parseCommand;
+    /**
+     * Override addOption to register a negative alternative for every option.
+     * @param {Option} option
+     * @return {JHipsterCommand} this;
+     */
+    addOption(option: Option): JHipsterCommand;
+    /**
+     * Register arguments using cli/commands.js structure.
+     * @param {String[]} args
+     * @return {JHipsterCommand} this;
+     */
+    addCommandArguments(args: string[]): JHipsterCommand;
+    /**
+     * Register options using cli/commands.js structure.
+     * @param {object[]} [opts]
+     * @return {JHipsterCommand} this;
+     */
+    addCommandOptions(opts?: any[] | undefined): JHipsterCommand;
+    _addCommandOption(opt: any): JHipsterCommand;
+    /**
+     * Register arguments using generator._arguments structure.
+     * @param {object[]} generatorArgs
+     * @return {JHipsterCommand} this;
+     */
+    addGeneratorArguments(generatorArgs?: object[]): JHipsterCommand;
+    /**
+     * Register options using generator._options structure.
+     * @param {object} options
+     * @param {string} [blueprintOptionDescription] - description of the blueprint that adds the option
+     * @return {JHipsterCommand} this;
+     */
+    addGeneratorOptions(options: object, blueprintOptionDescription?: string | undefined): JHipsterCommand;
+    addJHipsterArguments(jhipsterArguments: any): this;
+    addJHipsterOptions(options: any, blueprintOptionDescription: any): this;
+    addJHipsterConfigs(configs: {} | undefined, blueprintOptionDescription: any): this;
+    _addGeneratorOption(optionName: any, optionDefinition: any, additionalDescription?: string): any;
+}
+import { Command } from 'commander';
+import { Option } from 'commander';

package/dist/cli/jhipster-command.mjs

@@ -17,10 +17,12 @@
  * limitations under the License.
  */
 import chalk from 'chalk';
-import { Command, Option } from 'commander';
+import { Argument, Command, Option } from 'commander';
 import { kebabCase } from 'lodash-es';
-import { convertConfigToOption } from '../lib/internal/index.js';
+import { convertConfigToOption } from '../lib/command/index.js';
 export default class JHipsterCommand extends Command {
+    configs = {};
+    blueprintConfigs = {};
     createCommand(name) {
         return new JHipsterCommand(name);
     }
@@ -139,7 +141,7 @@ export default class JHipsterCommand extends Command {
     /**
      * Register options using generator._options structure.
      * @param {object} options
-     * @param {string} blueprintOptionDescription - description of the blueprint that adds the option
+     * @param {string} [blueprintOptionDescription] - description of the blueprint that adds the option
      * @return {JHipsterCommand} this;
      */
     addGeneratorOptions(options, blueprintOptionDescription) {
@@ -152,7 +154,11 @@ export default class JHipsterCommand extends Command {
         Object.entries(jhipsterArguments ?? {}).forEach(([key, value]) => {
             let argName = value.type === Array ? `${key}...` : key;
             argName = value.required ? `<${argName}>` : `[${argName}]`;
-            this.argument(argName, value.description);
+            const argument = new Argument(argName, value.description);
+            if (value.choices) {
+                argument.choices(value.choices.map(choice => (typeof choice === 'string' ? choice : choice.value)));
+            }
+            this.addArgument(argument);
         });
         return this;
     }
@@ -163,7 +169,10 @@ export default class JHipsterCommand extends Command {
         return this;
     }
     addJHipsterConfigs(configs = {}, blueprintOptionDescription) {
-        Object.entries(configs).forEach(([name, config]) => {
+        Object.assign(blueprintOptionDescription ? this.blueprintConfigs : this.configs, configs);
+        Object.entries(configs)
+            .filter(([_name, config]) => config.cli)
+            .forEach(([name, config]) => {
             const option = convertConfigToOption(name, config);
             if (option) {
                 this._addGeneratorOption(kebabCase(option.name), option, blueprintOptionDescription);
@@ -204,6 +213,9 @@ export default class JHipsterCommand extends Command {
         if (optionDefinition.choices && optionDefinition.choices.length > 0) {
             option.choices(optionDefinition.choices);
         }
+        if (optionDefinition.implies) {
+            option.implies(optionDefinition.implies);
+        }
         return this.addOption(option);
     }
 }

package/dist/cli/program.d.mts

@@ -0,0 +1,55 @@
+/**
+ * Copyright 2013-2024 the original author or authors from the JHipster project.
+ *
+ * This file is part of the JHipster project, see https://www.jhipster.tech/
+ * for more information.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import type Environment from 'yeoman-environment';
+import type { BaseEnvironmentOptions } from '@yeoman/types';
+import EnvironmentBuilder from './environment-builder.mjs';
+import JHipsterCommand from './jhipster-command.mjs';
+import { done } from './utils.mjs';
+import type { CliCommand } from './types.js';
+type BuildCommands = {
+    program: JHipsterCommand;
+    commands?: Record<string, CliCommand>;
+    envBuilder?: EnvironmentBuilder;
+    env: Environment;
+    loadCommand?: (key: string) => Promise<(...args: any[]) => Promise<any>>;
+    defaultCommand?: string;
+    entrypointGenerator?: string;
+    silent?: boolean;
+    printLogo?: () => void | Promise<void>;
+    printBlueprintLogo?: () => void | Promise<void>;
+    createEnvBuilder: (options?: BaseEnvironmentOptions) => Promise<EnvironmentBuilder>;
+};
+type BuildJHipsterOptions = Partial<BuildCommands> & {
+    executableName?: string;
+    executableVersion?: string;
+    blueprints?: Record<string, string>;
+    lookups?: any[];
+    devBlueprintPath?: string;
+};
+export declare const printJHipsterLogo: () => void;
+export declare const createProgram: ({ executableName, executableVersion, }?: {
+    executableName?: string;
+    executableVersion?: string;
+}) => JHipsterCommand;
+export declare const buildCommands: ({ program, commands, envBuilder, env, loadCommand, defaultCommand, entrypointGenerator, printLogo, printBlueprintLogo, createEnvBuilder, silent, }: BuildCommands) => void;
+export declare const buildJHipster: ({ executableName, executableVersion, program, blueprints, lookups, createEnvBuilder, envBuilder, commands, devBlueprintPath, env, ...buildOptions }?: BuildJHipsterOptions) => Promise<JHipsterCommand>;
+export declare const runJHipster: (args?: {
+    argv?: string[];
+} & BuildJHipsterOptions) => Promise<JHipsterCommand>;
+export { done };