generator-pyhipster/generators/app/prompts.js

Python (Flask) + Angular/React/Vue in one handy generator

/**
 * 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.
 */
const chalk = require('chalk');
const statistics = require('../statistics');
const packagejs = require('../../package.json');
const { appDefaultConfig } = require('../generator-defaults');
const { GATEWAY, MONOLITH, MICROSERVICE } = require('../../jdl/jhipster/application-types');
const { GATLING, CUCUMBER, PROTRACTOR, CYPRESS } = require('../../jdl/jhipster/test-framework-types');

module.exports = {
  // askForInsightOptIn,
  // askForApplicationType,
  askForModuleName,
  // askForTestOpts,
  // askForMoreModules,
};

async function askForInsightOptIn() {
  if (!statistics.shouldWeAskForOptIn()) return;
  const answers = await this.prompt({
    type: 'confirm',
    name: 'insight',
    message: `May ${chalk.cyan('JHipster')} anonymously report usage statistics to improve the tool over time?`,
    default: true,
  });
  if (answers.insight !== undefined) {
    statistics.setOptOutStatus(!answers.insight);
  }
}

async function askForApplicationType() {
  if (this.existingProject) return;

  const applicationTypeChoices = [
    {
      value: MONOLITH,
      name: 'Monolithic application (recommended for simple projects)',
    },
    {
      value: GATEWAY,
      name: 'Gateway application',
    },
    {
      value: MICROSERVICE,
      name: 'Microservice application',
    },
  ];

  const answers = await this.prompt([
    {
      type: 'list',
      name: 'applicationType',
      message: `Which ${chalk.yellow('*type*')} of application would you like to create?`,
      choices: applicationTypeChoices,
      default: appDefaultConfig.applicationType,
    },
  ]);
  this.applicationType = this.jhipsterConfig.applicationType = answers.applicationType;
}

function askForModuleName() {
  if (this.existingProject || this.jhipsterConfig.baseName) return undefined;
  return this.askModuleName(this);
}

async function askForTestOpts() {
  if (this.existingProject) return undefined;

  const choices = [];
  if (!this.skipClient) {
    // all client side test frameworks should be added here
    choices.push({ name: 'Cypress', value: CYPRESS });
    // choices.push({ name: '[DEPRECATED] Protractor', value: PROTRACTOR });
  }
  if (!this.skipServer) {
    // all server side test frameworks should be added here
    choices.push({ name: 'Gatling', value: GATLING }, { name: 'Cucumber', value: CUCUMBER });
  }
  const PROMPT = {
    type: 'checkbox',
    name: 'testFrameworks',
    message: 'Besides unittest and Jest, which testing frameworks would you like to use?',
    choices,
    default: appDefaultConfig.testFrameworks,
  };

  const answers = await this.prompt(PROMPT);
  this.testFrameworks = this.jhipsterConfig.testFrameworks = answers.testFrameworks;
  return answers;
}

// FIXME: To be enabled in upcoming releases
function askForMoreModules() {
  if (this.existingProject) {
    return undefined;
  }

  return this.prompt({
    type: 'confirm',
    name: 'installModules',
    message: 'Would you like to install other generators from the JHipster Marketplace?',
    default: false,
  }).then(answers => {
    if (answers.installModules) {
      return new Promise(resolve => askModulesToBeInstalled(resolve, this));
    }
    return undefined;
  });
}

// FIXME: To be enabled in upcoming releases
function askModulesToBeInstalled(done, generator) {
  const jHipsterMajorVersion = packagejs.version.match(/^(\d+)/g);

  generator.httpsGet(
    `https://api.npms.io/v2/search?q=keywords:jhipster-module+jhipster-${jHipsterMajorVersion}&from=0&size=50`,
    body => {
      try {
        const moduleResponse = JSON.parse(body);
        const choices = [];
        moduleResponse.results.forEach(modDef => {
          choices.push({
            value: { name: modDef.package.name, version: modDef.package.version },
            name: `(${modDef.package.name}-${modDef.package.version}) ${modDef.package.description}`,
          });
        });
        if (choices.length > 0) {
          generator
            .prompt({
              type: 'checkbox',
              name: 'otherModules',
              message: 'Which other modules would you like to use?',
              choices,
              default: [],
            })
            .then(answers => {
              // [ {name: [moduleName], version:[version]}, ...]
              answers.otherModules.forEach(module => {
                generator.otherModules.push({ name: module.name, version: module.version });
              });
              generator.jhipsterConfig.otherModules = generator.otherModules;
              done();
            });
        } else {
          done();
        }
      } catch (err) {
        generator.warning(`Error while parsing. Please install the modules manually or try again later. ${err.message}`);
        generator.debug('Error:', err);
        done();
      }
    },
    error => {
      generator.warning(`Unable to contact server to fetch additional modules: ${error.message}`);
      generator.debug('Error:', error);
      done();
    }
  );
}