generator-jhipster 7.5.0 → 7.8.0

package/generators/generate-blueprint/templates/generators/generator/generator.mjs.jhi.ejs

@@ -0,0 +1,98 @@
+<%#
+ Copyright 2013-2022 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 chalk from 'chalk';
+<&_
+ // Register sections and max allowed fragments, 0 for unlimited.
+  fragments.registerSections({
+<%_ for (const priority of priorities) { _%>
+    <%- priority.name %>Section: 1,
+<%_ } _%>
+  });
+-&>
+<%_ if (!application.dynamic) { _%>
+import <%= generatorClass %>Generator from 'generator-jhipster/esm/generators/<%= jhipsterGenerator %>';
+import {
+  PRIORITY_PREFIX,
+  <%_ for (const priority of priorities) { _%>
+  <%= priority.constant %>,
+  <%_ } _%>
+} from 'generator-jhipster/esm/priorities';
+<%_ } _%>
+
+
+<%_ if (application.dynamic) { _%>
+// eslint-disable-next-line import/prefer-default-export
+export async function createGenerator(env) {
+  const jhipsterGenerator = 'jhipster:<%= generator %>';
+  const jhipsterPath = env.getPackagePath(jhipsterGenerator);
+  const constants = (await import(`${jhipsterPath}/generators/generator-constants.js`)).default;
+  const {
+    PRIORITY_PREFIX,
+  <%_ for (const priority of priorities) { _%>
+    <%= priority.constant %>,
+  <%_ } _%>
+  } = await import(`${jhipsterPath}/lib/constants/priorities.mjs`);
+  const ParentClass = await env.requireGenerator(jhipsterGenerator);
+  return class <%= generatorClass %>Generator extends ParentClass {
+<%_ } else { _%>
+export default class extends <%= generatorClass %>Generator {
+<%_ } _%>
+  constructor(args, opts, features) {
+    super(args, opts, { taskPrefix: PRIORITY_PREFIX, ...features });
+
+    if (this.options.help) return;
+
+    if (!this.options.jhipsterContext) {
+      throw new Error(`This is a JHipster blueprint and should be used only like ${chalk.yellow('jhipster --blueprints <%= application.baseName %>')}`);
+    }
+<%_ if (sbs) { _%>
+
+    this.sbsBlueprint = true
+<%_ } _%>
+  }
+
+<% for (const priority of priorities) { %>
+<&- fragments.<%- priority.name %>Section() -&>
+<& if (!fragments.<%- priority.name %>Section()) { -&>
+
+  get [<%= priority.constant %>]() {
+    return {
+      async <%= priority.name %>TemplateTask() {
+  <%_ if (priority.name == 'writing') { %>
+        await this.writeFiles({
+          sections: {
+            files: [
+              { templates: ['template-file-<%= jhipsterGenerator %>'] },
+            ],
+          },
+          context: this,
+        });
+  <%_ } %>
+      },
+  <%_ if (!sbs) { _%>
+      ...super._<%= priority.name %>(),
+  <%_ } _%>
+    };
+  }
+<& } -&>
+<% } %>
+};
+<%_ if (application.dynamic) { _%>
+}
+<%_ } _%>

package/generators/generate-blueprint/templates/generators/generator/generator.spec.mjs.ejs

@@ -0,0 +1,42 @@
+<%#
+ Copyright 2013-2022 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 expect from 'expect';
+
+import { helpers, lookups } from '#test-utils';
+
+describe('SubGenerator <%= subGenerator %> of <%= application.baseName %> JHipster blueprint', () => {
+  describe('run', () => {
+    let result;
+    before(async function() {
+      result = await helpers
+        .create('jhipster:<%= subGenerator %>')
+        .withOptions({
+          reproducible: true,
+          defaults: true,
+          blueprint: '<%= application.baseName %>',
+        })
+        .withLookups(lookups)
+        .run();
+    });
+
+    it('should succeed', () => {
+      expect(result.getStateSnapshot()).toMatchSnapshot();
+    });
+  });
+});

package/generators/generate-blueprint/templates/generators/generator/index.mjs.ejs

@@ -0,0 +1,19 @@
+<%#
+ Copyright 2013-2022 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.
+-%>
+export { default } from './generator.mjs';

package/generators/generate-blueprint/templates/test/utils.mjs.ejs

@@ -0,0 +1,17 @@
+import yeomanTest from 'yeoman-test';
+import { join, dirname } from 'path';
+import { fileURLToPath } from 'url';
+// eslint-disable-next-line import/no-unresolved
+import { EnvironmentBuilder } from 'generator-jhipster/esm/cli';
+
+const { createHelpers } = yeomanTest;
+const packageRoot = join(dirname(fileURLToPath(import.meta.url)), '..');
+const jhipsterPath = join(packageRoot, 'node_modules', 'generator-jhipster');
+
+export function createTestHelpers(options = {}) {
+  return createHelpers({ ...options, createEnv: EnvironmentBuilder.createEnv });
+}
+
+export const helpers = createTestHelpers();
+
+export const lookups = { packagePaths: [packageRoot, jhipsterPath], lookups: ['generators'] };

package/generators/generator-base-blueprint.js

@@ -1,5 +1,5 @@
 /**
- * Copyright 2013-2021 the original author or authors from the JHipster project.
+ * Copyright 2013-2022 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.
@@ -27,9 +27,21 @@ const BaseGenerator = require('./generator-base');
 const { mergeBlueprints, parseBluePrints, loadBlueprintsFromConfiguration, normalizeBlueprintName } = require('../utils/blueprint');
 
 /**
- * This is the base class for a generator that can be extended through a blueprint.
+ * Basic task definition
  *
- * The method signatures in public API should not be changed without a major version change
+ * @async
+ * @function YeomanTask
+ * @param {...string} cliArgs - Arguments passed to cli.
+ * @return {Promise<any>}.
+ */
+
+/**
+ * Base class for a generator that can be extended through a blueprint.
+ *
+ * @class
+ * @property {import('yeoman-generator/lib/util/storage')} blueprintStorage - Storage for blueprint config (Blueprints only).
+ * @property {object} blueprintConfig - Proxy object for blueprintStorage (Blueprints only).
+ * @property {import('yeoman-generator')} jhipsterContext - JHipster parent generator (Blueprints only).
  */
 module.exports = class JHipsterBaseBlueprintGenerator extends BaseGenerator {
   constructor(args, options, features) {
@@ -45,7 +57,7 @@ module.exports = class JHipsterBaseBlueprintGenerator extends BaseGenerator {
     this.fromBlueprint = this.rootGeneratorName() !== 'generator-jhipster';
 
     if (this.fromBlueprint) {
-      this.blueprintStorage = this._getStorage();
+      this.blueprintStorage = this._getStorage({ sorted: true });
       this.blueprintConfig = this.blueprintStorage.createProxy();
 
       // jhipsterContext is the original generator
@@ -61,6 +73,17 @@ module.exports = class JHipsterBaseBlueprintGenerator extends BaseGenerator {
     }
   }
 
+  /**
+   * Priority API stub for blueprints.
+   *
+   * Initializing priority is used to show logo and tasks related to preparing for prompts, like loading constants.
+   *
+   * @returns {Object.<string, YeomanTask>} generator tasks
+   */
+  get initializing() {
+    return this._initializing();
+  }
+
   /**
    * Public API method used by the getter and also by Blueprints
    * @returns {Object} tasks
@@ -69,6 +92,17 @@ module.exports = class JHipsterBaseBlueprintGenerator extends BaseGenerator {
     return {};
   }
 
+  /**
+   * Priority API stub for blueprints.
+   *
+   * Prompting priority is used to prompt users for configuration values.
+   *
+   * @returns {Object.<string, YeomanTask>} generator tasks
+   */
+  get prompting() {
+    return this._prompting();
+  }
+
   /**
    * Public API method used by the getter and also by Blueprints
    * @returns {Object} tasks
@@ -77,6 +111,17 @@ module.exports = class JHipsterBaseBlueprintGenerator extends BaseGenerator {
     return {};
   }
 
+  /**
+   * Priority API stub for blueprints.
+   *
+   * Configuring priority is used to customize and validate the configuration.
+   *
+   * @returns {Object.<string, YeomanTask>} generator tasks
+   */
+  get configuring() {
+    return this._configuring();
+  }
+
   /**
    * Public API method used by the getter and also by Blueprints
    * @returns {Object} tasks
@@ -85,6 +130,46 @@ module.exports = class JHipsterBaseBlueprintGenerator extends BaseGenerator {
     return {};
   }
 
+  /**
+   * Configuring entities task argument
+   *
+   * @typedef {object} ConfiguringEntityArgument
+   * @property {string} entityName - Entity name.
+   * @property {import('yeoman-generator/lib/util/storage')} entityStorage - Storage for entity.
+   * @property {object} entityConfig - Proxy object for entityStorage.
+   */
+
+  /**
+   * Configuring entities task definition
+   *
+   * @async
+   * @function ConfiguringEntityTask
+   * @param {ConfiguringEntityArgument} taskData
+   * @return {Promise<any>}.
+   */
+
+  /**
+   * Priority API stub for blueprints.
+   *
+   * Configuring each entity priority is used to customize and validate the entity configuration.
+   *
+   * @returns {Object.<string, ConfiguringEntityTask>} taskGroup
+   */
+  get configuringEachEntity() {
+    return {};
+  }
+
+  /**
+   * Priority API stub for blueprints.
+   *
+   * Composing should be used to compose with others generators.
+   *
+   * @returns {Object.<string, requestCallback>} taskGroup
+   */
+  get composing() {
+    return this._composing();
+  }
+
   /**
    * Public API method used by the getter and also by Blueprints
    * @returns {Object} tasks
@@ -93,6 +178,18 @@ module.exports = class JHipsterBaseBlueprintGenerator extends BaseGenerator {
     return {};
   }
 
+  /**
+   * Priority API stub for blueprints.
+   *
+   * Loading should be used to load application configuration from jhipster configuration.
+   * Before this priority the configuration should be considered dirty, while each generator configures itself at configuring priority, another generator composed at composing priority can still change it.
+   *
+   * @returns {Object.<string, YeomanTask>} taskGroup
+   */
+  get loading() {
+    return this._loading();
+  }
+
   /**
    * Public API method used by the getter and also by Blueprints
    * @returns {Object} tasks
@@ -101,6 +198,17 @@ module.exports = class JHipsterBaseBlueprintGenerator extends BaseGenerator {
     return {};
   }
 
+  /**
+   * Priority API stub for blueprints.
+   *
+   * Preparing should be used to generate derived properties.
+   *
+   * @returns {Object.<string, YeomanTask>} taskGroup
+   */
+  get preparing() {
+    return this._preparing();
+  }
+
   /**
    * Public API method used by the getter and also by Blueprints
    * @returns {Object} tasks
@@ -153,6 +261,17 @@ module.exports = class JHipsterBaseBlueprintGenerator extends BaseGenerator {
     return tasks;
   }
 
+  /**
+   * Priority API stub for blueprints.
+   *
+   * Default priority should used as misc customizations.
+   *
+   * @returns {Object.<string, YeomanTask>} generator tasks
+   */
+  get default() {
+    return this._default();
+  }
+
   /**
    * Public API method used by the getter and also by Blueprints
    * @returns {Object} tasks
@@ -161,6 +280,17 @@ module.exports = class JHipsterBaseBlueprintGenerator extends BaseGenerator {
     return {};
   }
 
+  /**
+   * Priority API stub for blueprints.
+   *
+   * Writing priority should used to write files.
+   *
+   * @returns {Object.<string, YeomanTask>} generator tasks
+   */
+  get writing() {
+    return this._writing();
+  }
+
   /**
    * Public API method used by the getter and also by Blueprints
    * @returns {Object} tasks
@@ -185,6 +315,17 @@ module.exports = class JHipsterBaseBlueprintGenerator extends BaseGenerator {
     return tasks;
   }
 
+  /**
+   * Priority API stub for blueprints.
+   *
+   * PostWriting priority should used to customize files.
+   *
+   * @returns {Object.<string, YeomanTask>} generator tasks
+   */
+  get postWriting() {
+    return this._postWriting();
+  }
+
   /**
    * Public API method used by the getter and also by Blueprints
    */
@@ -192,6 +333,17 @@ module.exports = class JHipsterBaseBlueprintGenerator extends BaseGenerator {
     return {};
   }
 
+  /**
+   * Priority API stub for blueprints.
+   *
+   * Install priority should used to prepare the project.
+   *
+   * @returns {Object.<string, YeomanTask>} generator tasks
+   */
+  get install() {
+    return this._install();
+  }
+
   /**
    * Public API method used by the getter and also by Blueprints
    * @returns {Object} tasks
@@ -200,6 +352,17 @@ module.exports = class JHipsterBaseBlueprintGenerator extends BaseGenerator {
     return {};
   }
 
+  /**
+   * Priority API stub for blueprints.
+   *
+   * End priority should used to say good bye and print instructions.
+   *
+   * @returns {Object.<string, YeomanTask>} generator tasks
+   */
+  get end() {
+    return this._end();
+  }
+
   /**
    * Public API method used by the getter and also by Blueprints
    * @returns {Object} tasks
@@ -219,9 +382,11 @@ module.exports = class JHipsterBaseBlueprintGenerator extends BaseGenerator {
    */
   _isPriorityMissing(priorityName, destPriority = 'related') {
     const ownPrototype = Object.getPrototypeOf(this);
+    const parentPrototype = Object.getPrototypeOf(ownPrototype);
     if (
+      parentPrototype !== JHipsterBaseBlueprintGenerator.prototype &&
       !Object.getOwnPropertyDescriptor(ownPrototype, priorityName) &&
-      Object.getOwnPropertyDescriptor(Object.getPrototypeOf(ownPrototype), priorityName)
+      Object.getOwnPropertyDescriptor(parentPrototype, priorityName)
     ) {
       this.warning(`Priority ${priorityName} is missing for generator ${this.options.namespace}. Merging into ${destPriority} priority.`);
       return true;

package/generators/generator-base-docker.js

@@ -1,5 +1,5 @@
 /**
- * Copyright 2013-2021 the original author or authors from the JHipster project.
+ * Copyright 2013-2022 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.
@@ -85,6 +85,7 @@ module.exports = class extends BlueprintBaseGenerator {
         this.DOCKER_ELASTICSEARCH = constants.DOCKER_ELASTICSEARCH;
         this.DOCKER_PROMETHEUS_OPERATOR = constants.DOCKER_PROMETHEUS_OPERATOR;
         this.DOCKER_GRAFANA_WATCHER = constants.DOCKER_GRAFANA_WATCHER;
+        this.DOCKER_ZIPKIN = constants.DOCKER_ZIPKIN;
 
         this.DOCKER_CASSANDRA = constants.DOCKER_CASSANDRA;
         this.DOCKER_GRAFANA = constants.DOCKER_GRAFANA;