generator-jhipster 7.6.0 → 7.7.0

package/generators/generate-blueprint/generator.mjs

@@ -0,0 +1,363 @@
+/**
+ * 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';
+import lodash from 'lodash';
+import { readFile } from 'fs/promises';
+
+import BaseBlueprintGenerator from '../generator-base-blueprint.js';
+import {
+  PRIORITY_PREFIX,
+  INITIALIZING_PRIORITY,
+  PROMPTING_PRIORITY,
+  CONFIGURING_PRIORITY,
+  LOADING_PRIORITY,
+  PREPARING_PRIORITY,
+  WRITING_PRIORITY,
+  POST_WRITING_PRIORITY,
+  INSTALL_PRIORITY,
+  END_PRIORITY,
+} from '../../lib/constants/priorities.mjs';
+import {
+  options,
+  requiredConfig,
+  defaultConfig,
+  defaultSubGeneratorConfig,
+  allGeneratorsConfig,
+  prompts,
+  subGeneratorPrompts,
+  ALL_GENERATORS,
+  GENERATORS,
+  PRIORITIES,
+  SUB_GENERATORS,
+  WRITTEN,
+} from './constants.mjs';
+
+import GENERATOR_LIST from '../generator-list.js';
+import { files, generatorFiles } from './files.mjs';
+
+const { camelCase, upperFirst, snakeCase } = lodash;
+const { GENERATOR_INIT, GENERATOR_GENERATE_BLUEPRINT } = GENERATOR_LIST;
+
+export default class extends BaseBlueprintGenerator {
+  constructor(args, opts, features) {
+    super(args, opts, { jhipsterModular: true, taskPrefix: PRIORITY_PREFIX, unique: 'namespace', ...features });
+
+    // Register options available to cli.
+    if (!this.fromBlueprint) {
+      this.registerCommonOptions();
+    }
+
+    this.jhipsterOptions(options());
+
+    if (this.options.help) return;
+
+    if (this[ALL_GENERATORS]) {
+      this.config.set(allGeneratorsConfig());
+    }
+    if (this.options.defaults) {
+      this.config.defaults(defaultConfig());
+    }
+  }
+
+  /** @inheritdoc */
+  async getPossibleDependencies() {
+    return [GENERATOR_INIT];
+  }
+
+  async _beforeQueue() {
+    if (!this.fromBlueprint) {
+      const configure = this.options.configure || !this.shouldComposeModular();
+      await this.dependsOnJHipster(GENERATOR_INIT, [], { configure });
+      await this.composeWithBlueprints(GENERATOR_GENERATE_BLUEPRINT);
+    }
+  }
+
+  get initializing() {
+    return {
+      validateFromCli() {
+        this.checkInvocationFromCLI();
+      },
+      sayHello() {
+        if (!this.showHello()) return;
+        this.log(chalk.white('⬢ Welcome to the JHipster Generate Blueprint ⬢'));
+      },
+      loadRuntimeOptions() {
+        this.loadRuntimeOptions();
+      },
+    };
+  }
+
+  get [INITIALIZING_PRIORITY]() {
+    if (this.delegateToBlueprint) return {};
+    return this.initializing;
+  }
+
+  get prompting() {
+    return {
+      async prompting() {
+        await this.prompt(prompts(this), this.config);
+      },
+      async eachSubGenerator() {
+        const subGenerators = this.config.get(SUB_GENERATORS) || [];
+        for (const subGenerator of subGenerators) {
+          const subGeneratorStorage = this.getSubGeneratorStorage(subGenerator);
+          await this.prompt(subGeneratorPrompts(subGenerator), subGeneratorStorage);
+        }
+      },
+    };
+  }
+
+  get [PROMPTING_PRIORITY]() {
+    if (this.delegateToBlueprint) return {};
+    return this.prompting;
+  }
+
+  get configuring() {
+    return {
+      requiredConfig() {
+        this.config.defaults(requiredConfig());
+      },
+    };
+  }
+
+  get [CONFIGURING_PRIORITY]() {
+    if (this.delegateToBlueprint) return {};
+    return this.configuring;
+  }
+
+  get loading() {
+    return {
+      createContext() {
+        this.application = { ...defaultConfig(), ...this.config.getAll() };
+      },
+      async load() {
+        this.application.packagejs = JSON.parse(await readFile(new URL('../../package.json', import.meta.url)));
+      },
+    };
+  }
+
+  get [LOADING_PRIORITY]() {
+    if (this.delegateToBlueprint) return {};
+    return this.loading;
+  }
+
+  get preparing() {
+    return {
+      prepareCommands() {
+        this.application.commands = [];
+        for (const generator of this.application[SUB_GENERATORS]) {
+          const subGeneratorConfig = this.getSubGeneratorStorage(generator).getAll();
+          if (subGeneratorConfig.command) {
+            this.application.commands.push(generator);
+          }
+        }
+      },
+    };
+  }
+
+  get [PREPARING_PRIORITY]() {
+    if (this.delegateToBlueprint) return {};
+    return this.preparing;
+  }
+
+  get writing() {
+    return {
+      async writing() {
+        if (this.shouldSkipFiles()) return;
+        await this.writeFiles({
+          sections: files,
+          context: this.application,
+        });
+        // function to use directly template
+        for (const generator of this.jhipsterConfig[SUB_GENERATORS] || []) {
+          const subGeneratorStorage = this.getSubGeneratorStorage(generator);
+          const subGeneratorConfig = subGeneratorStorage.getAll();
+          const priorities = (subGeneratorConfig[PRIORITIES] || []).map(priority => ({
+            name: priority,
+            constant: `${snakeCase(priority).toUpperCase()}_PRIORITY`,
+          }));
+          const customGenerator = !Object.values(GENERATOR_LIST).includes(generator);
+          const jhipsterGenerator = customGenerator ? 'base' : generator;
+          const subTemplateData = {
+            application: this.application,
+            ...defaultSubGeneratorConfig(),
+            ...subGeneratorConfig,
+            generator,
+            jhipsterGenerator,
+            subGenerator: generator,
+            generatorClass: upperFirst(camelCase(jhipsterGenerator)),
+            priorities,
+          };
+          await this.writeFiles({
+            sections: generatorFiles,
+            context: subTemplateData,
+          });
+          subGeneratorStorage.set(WRITTEN, true);
+        }
+      },
+    };
+  }
+
+  get [WRITING_PRIORITY]() {
+    if (this.delegateToBlueprint) return {};
+    return this.writing;
+  }
+
+  get postWriting() {
+    return {
+      postWriting() {
+        if (this.shouldSkipFiles()) return;
+        const { packagejs } = this.application;
+        this.packageJson.merge({
+          name: `generator-jhipster-${this.jhipsterConfig.baseName}`,
+          keywords: ['yeoman-generator', 'jhipster-blueprint', 'jhipster-7'],
+          type: 'module',
+          files: ['generators'],
+          scripts: {
+            ejslint: "ejslint generators/**/*.ejs && ejslint generators/**/*.ejs -d '&'",
+            lint: 'eslint .',
+            'lint-fix': 'npm run ejslint && npm run lint -- --fix',
+            mocha: 'mocha generators --no-insight --forbid-only',
+            'prettier-format': 'prettier --write "{,**/}*.{js,cjs,mjs,json,md,yml}"',
+            pretest: 'npm run lint',
+            test: 'npm run mocha --',
+            'update-snapshot': 'npm run mocha -- --no-parallel --updateSnapshot',
+          },
+          dependencies: {
+            chalk: `${packagejs.dependencies.chalk}`,
+          },
+          devDependencies: {
+            'ejs-lint': `${packagejs.devDependencies['ejs-lint']}`,
+            eslint: `${packagejs.devDependencies.eslint}`,
+            'eslint-config-airbnb-base': `${packagejs.devDependencies['eslint-config-airbnb-base']}`,
+            'eslint-config-prettier': `${packagejs.devDependencies['eslint-config-prettier']}`,
+            'eslint-plugin-import': `${packagejs.devDependencies['eslint-plugin-import']}`,
+            'eslint-plugin-mocha': `${packagejs.devDependencies['eslint-plugin-mocha']}`,
+            'eslint-plugin-prettier': `${packagejs.devDependencies['eslint-plugin-prettier']}`,
+            expect: `${packagejs.devDependencies.expect}`,
+            mocha: `${packagejs.devDependencies.mocha}`,
+            'mocha-expect-snapshot': `${packagejs.devDependencies['mocha-expect-snapshot']}`,
+            prettier: `${packagejs.dependencies.prettier}`,
+            'yeoman-test': `${packagejs.devDependencies['yeoman-test']}`,
+          },
+          engines: {
+            node: '>=16.13.0',
+          },
+          imports: {
+            '#test-utils': './test/utils.mjs',
+          },
+        });
+      },
+      addCliToPackageJson() {
+        if (this.shouldSkipFiles() || !this.jhipsterConfig.cli) return;
+        const { baseName, cliName = `jhipster-${baseName}` } = this.application;
+        this.packageJson.merge({
+          bin: {
+            [cliName]: `cli/cli.${this.jhipsterConfig.js ? '' : 'm'}js`,
+          },
+          files: ['cli', 'generators'],
+        });
+      },
+      addGeneratorJHipsterDependency() {
+        if (this.shouldSkipFiles()) return;
+        const { packagejs } = this.application;
+        if (this.jhipsterConfig.dynamic) {
+          this.packageJson.merge({
+            devDependencies: {
+              'generator-jhipster': `${packagejs.version}`,
+            },
+            peerDependencies: {
+              'generator-jhipster': `^${packagejs.version}`,
+            },
+          });
+        } else {
+          this.packageJson.merge({
+            dependencies: {
+              'generator-jhipster': `${packagejs.version}`,
+            },
+          });
+        }
+      },
+    };
+  }
+
+  get [POST_WRITING_PRIORITY]() {
+    if (this.delegateToBlueprint) return {};
+    return this.postWriting;
+  }
+
+  get install() {
+    return {
+      async addSnapshot() {
+        if (this.options.skipInstall || this.options.skipGit || this.config.existed) return;
+        // Generate snapshots to add to git.
+        this.log(`
+This is a new blueprint, executing '${chalk.yellow('npm run update-snapshot')}' to generate snapshots and commit to git.`);
+        try {
+          await this.spawnCommand('npm', ['run', 'update-snapshot']);
+        } catch (error) {
+          this.log('Fail to generate snapshots');
+        }
+      },
+    };
+  }
+
+  get [INSTALL_PRIORITY]() {
+    if (this.delegateToBlueprint) return {};
+    return this.install;
+  }
+
+  get end() {
+    return {
+      end() {
+        this.log(`${chalk.bold.green('##### USAGE #####')}
+To begin to work:
+- launch: ${chalk.yellow.bold('npm install')}
+- link: ${chalk.yellow.bold('npm link')}
+- link JHipster: ${chalk.yellow.bold('npm link generator-jhipster')}
+- test your module in a JHipster project: 
+    - create a new directory and go into it
+    - link the blueprint: ${chalk.yellow.bold(`npm link generator-jhipster-${this.moduleName}`)}
+    - launch JHipster with flags: ${chalk.yellow.bold(`jhipster --blueprints ${this.moduleName}`)}
+- then, come back here, and begin to code!
+`);
+      },
+    };
+  }
+
+  get [END_PRIORITY]() {
+    if (this.delegateToBlueprint) return {};
+    return this.end;
+  }
+
+  getSubGeneratorStorage(subGenerator) {
+    return this.config.createStorage(`${GENERATORS}.${subGenerator}`);
+  }
+
+  validateGitHubName(input) {
+    if (/^([a-zA-Z0-9]+)(-([a-zA-Z0-9])+)*$/.test(input) && input !== '') return true;
+    return 'Your username is mandatory, cannot contain special characters or a blank space';
+  }
+
+  validateModuleName(input) {
+    return /^[a-zA-Z0-9-]+$/.test(input)
+      ? true
+      : 'Your blueprint name is mandatory, cannot contain special characters or a blank space, using the default name instead';
+  }
+}

package/generators/generate-blueprint/index.mjs

@@ -0,0 +1,20 @@
+/**
+ * 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';
+export { files, generatorFiles } from './files.mjs';

package/generators/generate-blueprint/templates/.eslintrc.json.ejs

@@ -0,0 +1,41 @@
+{
+  "env": {
+    "node": true,
+    "es2020": true
+  },
+  "extends": ["airbnb-base", "plugin:mocha/recommended", "plugin:prettier/recommended"],
+  "parserOptions": {
+    "ecmaVersion": 11,
+    "sourceType": "module"
+  },
+  "overrides": [
+    {
+      "files": ["**/*.spec.{c,m,}js", "test/**/*.{c,m,}js"],
+      "env": {
+        "mocha": true
+      }
+    }
+  ],
+  "rules": {
+    "mocha/no-mocha-arrows": "off",
+    "func-names": "off",
+    "import/no-extraneous-dependencies": ["error", { "devDependencies": true }],
+    "import/no-unresolved": [2, { "ignore": ["^#[\\w\\d/\\-]+$"] }],
+    "no-restricted-syntax": [
+      "error",
+      {
+        "selector": "ForInStatement",
+        "message": "for..in loops iterate over the entire prototype chain, which is virtually never what you want. Use Object.{keys,values,entries}, and iterate over the resulting array."
+      },
+      {
+        "selector": "LabeledStatement",
+        "message": "Labels are a form of GOTO; using them makes code confusing and hard to maintain and understand."
+      },
+      {
+        "selector": "WithStatement",
+        "message": "`with` is disallowed in strict mode because it makes code impossible to predict and optimize."
+      }
+    ],
+    "no-shadow": "off"
+  }
+}

package/generators/generate-blueprint/templates/.github/workflows/generator.yml.ejs

@@ -0,0 +1,32 @@
+<%#
+ 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.
+-%>
+name: Generator
+on: [push, pull_request]
+jobs:
+  <%= baseName %>:
+    name: npm-test
+    runs-on: ubuntu-20.04
+    timeout-minutes: 10
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v2
+        with:
+          node-version: '16'
+      - run: npm ci
+      - run: npm run test

package/generators/generate-blueprint/templates/.mocharc.cjs.ejs

@@ -0,0 +1,29 @@
+<%#
+ 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.
+-%>
+module.exports = {
+  recursive: true,
+  reporter: 'spec',
+  slow: 0,
+  timeout: 30000,
+  ui: 'bdd',
+  extension: ['spec.js', 'spec.cjs', 'spec.mjs'],
+  exclude: ['**/resources/**', '**/node_modules/**'],
+  require: 'mocha-expect-snapshot',
+  parallel: true,
+};

package/generators/{server/templates/couchbase/src/main/java/package/config/couchbase/package-info.java.ejs → generate-blueprint/templates/.prettierignore.jhi.blueprint.ejs}

@@ -16,10 +16,7 @@
  See the License for the specific language governing permissions and
  limitations under the License.
 -%>
-/**
- * Classes in this package are meant to extend Spring Data Couchbase
- * and fix some of the issues encountered during integration.
- */
-package <%= packageName %>.config.couchbase;
-
-
+<&_ if (!fragment.section) { -&>
+# blueprint rules:
+**/templates/**/
+<&_ } -&>

package/generators/generate-blueprint/templates/README.md.ejs

@@ -0,0 +1,75 @@
+<%#
+ 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.
+-%>
+# generator-jhipster-<%= baseName %>
+
+> JHipster blueprint, <%= baseName %> blueprint for JHipster
+
+[![NPM version][npm-image]][npm-url]
+[![Generator][github-generator-image]][github-generator-url]
+[![Integration Test][github-integration-image]][github-integration-url]
+
+# Introduction
+
+This is a [JHipster](https://www.jhipster.tech/) blueprint, that is meant to be used in a JHipster application.
+
+# Prerequisites
+
+As this is a [JHipster](https://www.jhipster.tech/) blueprint, we expect you have JHipster and its related tools already installed:
+
+- [Installing JHipster](https://www.jhipster.tech/installation/)
+
+# Installation
+
+To install or update this blueprint:
+
+```bash
+npm install -g generator-jhipster-<%= baseName %>
+```
+
+# Usage
+
+To use this blueprint, run the below command
+
+```bash
+jhipster --blueprints <%= baseName %>
+```
+
+You can look for updated <%= baseName %> blueprint specific options by running
+
+```bash
+jhipster app --blueprints <%= baseName %> --help
+```
+
+And looking for `(blueprint option: <%= baseName %>)` like
+
+## Pre-release
+
+To use an unreleased version, install it using git.
+
+```bash
+npm install -g jhipster/generator-jhipster-<%= baseName %>#main
+jhipster --blueprints <%= baseName %> --skip-jhipster-dependencies
+```
+
+[npm-image]: https://img.shields.io/npm/v/generator-jhipster-<%= baseName %>.svg
+[npm-url]: https://npmjs.org/package/generator-jhipster-<%= baseName %>
+[github-generator-image]: https://github.com/jhipster/generator-jhipster-<%= baseName %>/actions/workflows/generator.yml/badge.svg
+[github-generator-url]: https://github.com/jhipster/generator-jhipster-<%= baseName %>/actions/workflows/generator.yml
+[github-integration-image]: https://github.com/jhipster/generator-jhipster-<%= baseName %>/actions/workflows/integration.yml/badge.svg
+[github-integration-url]: https://github.com/jhipster/generator-jhipster-<%= baseName %>/actions/workflows/integration.yml

package/generators/generate-blueprint/templates/cli/cli.mjs.ejs

@@ -0,0 +1,35 @@
+#!/usr/bin/env node
+
+import { runJHipster, done, logger } from 'generator-jhipster/esm/cli';
+import { readFile } from 'fs/promises';
+import { fileURLToPath } from 'url';
+import { dirname, basename } from 'path';
+
+// Get package name to use as namespace.
+// Allows blueprints to be aliased.
+const packagePath = dirname(dirname(fileURLToPath(import.meta.url)));
+const packageFolderName = basename(packagePath);
+
+(async () => {
+  const { version, bin } = JSON.parse(await readFile(new URL('../package.json', import.meta.url)));
+  const executableName = Object.keys(bin)[0];
+
+  runJHipster({
+    executableName,
+    executableVersion: version,
+    defaultCommand: 'app',
+    blueprints: {
+      [packageFolderName]: version,
+    },
+    printBlueprintLogo: () => {
+      console.log('===================== JHipster <%= baseName %> =====================');
+      console.log('');
+    },
+    lookups: [{ packagePaths: [packagePath], lookups: ['generators'] }],
+  }).catch(done);
+})();
+
+process.on('unhandledRejection', up => {
+  logger.error('Unhandled promise rejection at:');
+  logger.fatal(up);
+});

package/generators/generate-blueprint/templates/cli/commands.cjs.ejs

@@ -0,0 +1,25 @@
+<%#
+ 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.
+-%>
+module.exports = {
+<% for (const command of commands) { %>
+  '<%= command %>': {
+    desc: 'Run <%= command %>',
+  },
+<% } %>
+};