generator-confit/lib/core/ConfitGenerator.js

Yeoman generator for creating the development process, tools and a sample project for current-generation web applications

'use strict';
/*
  This is the factory for all Confit generators.
  Each generator instance calls factory.create(extraConfig), which returns
  an instance of a Yeoman generator, overriding the default Confit config
  with the specific generator config.

  A generator does not need to provide extraConfig.
 */
const Base = require('yeoman-generator').Base;
const _ = require('lodash');
const chalk = require('chalk');
const path = require('path');
const parseRepo = require('parse-repo');

const MAX_EVENT_LISTENERS = 20;


// Extend the Base prototype
_.extend(Base.prototype,
  require('./StorageAdapter.js'),
  require('./buildToolUtils.js'),
  require('./fileUtils.js'),
  require('./npm.js'),
  require('./markdownUtils.js'),
  require('./resources.js'),
  require('./utils.js')
);

let hasGreeted = process.argv.indexOf('--no-logo') !== -1 || process.argv.indexOf('--help') !== -1;

module.exports = {

  create: function(extraConfig) {
    if (!hasGreeted) {
      confitGreet();
      hasGreeted = true;
    }

    let confitConfig = Object.assign(
      {
        constructor: function() {
          Base.apply(this, arguments);    // eslint-disable-line
          // Define options
          this.option('skip-run', {desc: 'Do not run the project after installation', defaults: false});

          // Avoid http://stackoverflow.com/questions/9768444/possible-eventemitter-memory-leak-detected
          this.env.sharedFs.setMaxListeners(MAX_EVENT_LISTENERS);

          // Extend the object *instance* with the methods in common.js
          require('./common.js').apply(this);

          // Initialise the project-type specific resources
          this.projectType = this.getGlobalConfig().app.projectType;
          let projectTypeChanged = !this.isCurrentProjectType(this.projectType);
          // console.log('projectTypeChanged', projectTypeChanged, this.projectType);

          // These functions are guarded to try to prevent expensive re-initialisation.
          this.initResources(this.projectType, projectTypeChanged);
          this.getBuildProfiles(this.projectType);
          this.updateBuildTool();

          // Set the repository information for use in other places
          this.repoConfig = parseRepo(this.readPackageJson().repository.url);
        },

        // Base implementation of initializing, configuring, writing and installing methods...
        initializing: function() {
          // Check if this component has an existing config. If it doesn't even if we are asked to rebuild, don't rebuild
          this.rebuildFromConfig = Boolean(this.options.rebuildFromConfig) && this.hasExistingConfig();
        },

        configuring: function() {
          this.buildTool.configure.apply(this);
        },

        writing: function() {
          let resources = this.getResources()[this.name];

          this.writeGeneratorConfig(resources);
          this.buildTool.write.apply(this);
        },

        install: function() {
          // InstallDependencies runs 'npm install' and 'bower install'
          this.installDependencies({
            skipInstall: this.options['skip-install'],
            skipMessage: true,
            bower: false,
          });
        },

      },
      extraConfig
    );

    return Base.extend(confitConfig);
  },
};

/**
 * Displays the Confit greeting
 */
function confitGreet() {
  // Great the user
  let generatorVersion = require('fs-extra').readJsonSync(path.join(__dirname, '/../../package.json')).version;

  let welcome =
    '\n' +
    chalk.cyan.bold('\n                                                                      ') + chalk.white.bold('╓╗╗') +
    chalk.cyan.bold('\n                                                                 ') + chalk.white.bold('╗╣╣╣╣╣╣╣╗') +
    chalk.cyan.bold('\n                                                                ') + chalk.white.bold('╠╣╣╣╣╣╣╣╣╣') + chalk.yellow.bold('╣╗╗╗') +
    chalk.cyan.bold('\n                                                                ') + chalk.white.bold('╚╣╣╣╣╣╣╣╣') + chalk.yellow.bold('╣╣╣╣╝') +
    chalk.cyan.bold('\n ╓╣╣╣╣╣╣╣╗  ╔╣╣╣╣╣╣╣  ╞╣╣╣  ╣╣╣  ╣╣╣╣╣╣╣ ╣╣╣╣ ╣╣╣╣╣╣╣╣╣ ') + chalk.white.bold('╣╣╗      ╙╣╣╣╣╣╣╣╣╜') +
    chalk.cyan.bold('\n ╣╣╣╣ ╠╣╣╣  ╣╣╣╣ ╣╣╣╣ ╞╣╣╣╣ ╣╣╣  ╣╣╣╣    ╣╣╣╣   ╠╣╣╣   ') + chalk.white.bold('╣╣╣╣╣╣╗╗╗╗╣╣╣╣╣╣╣╣╣╣╗ ') +
    chalk.cyan.bold('\n ╣╣╣╣ ╠╣╣╣  ╣╣╣╣ ╣╣╣╣ ╞╣╣╣╣╗╣╣╣  ╣╣╣╣╗╗╗ ╣╣╣╣   ╠╣╣╣   ') + chalk.white.bold('╣╣╣╣╣╣╣╣╣╣╣╣╣╣╣╣╣╣╣╣╣╣╕') +
    chalk.cyan.bold('\n ╣╣╣╣       ╣╣╣╣ ╣╣╣╣ ╞╣╣╣╣╣╣╣╣  ╣╣╣╣╣╣╣ ╣╣╣╣   ╠╣╣╣   ') + chalk.white.bold('╣╣╣╣╣╣╣╣╣╣╣╣╣╣╣╣╣╣╣╣╣╣╣') +
    chalk.cyan.bold('\n ╣╣╣╣ ╠╣╣╣  ╣╣╣╣ ╣╣╣╣ ╞╣╣╣╚╣╣╣╣  ╣╣╣╣    ╣╣╣╣   ╠╣╣╣   ') + chalk.white.bold('└╣╣╣╣╣╣╣╣╣╣╣╣╣╣╣╣╣╣╣╣╣╝') +
    chalk.cyan.bold('\n ╣╣╣╣ ╠╣╣╣  ╣╣╣╣ ╣╣╣╣ ╞╣╣╣ ╣╣╣╣  ╣╣╣╣    ╣╣╣╣   ╠╣╣╣     ') + chalk.white.bold('╚╣╣╣╣╣╣╣╣╣╣╣╣╣╣╣╣╣╣╝') +
    chalk.cyan.bold('\n └╝╣╣╣╣╣╝   └╝╣╣╣╣╣╝  ╞╣╣╣ ╘╣╣╣  ╣╣╣╣    ╣╣╣╣   ╠╣╣╣        ') + chalk.white.bold('╙╝╣╣╣╣╣╣╣╣╣╣╣╝╙ ') +
    chalk.white.bold('\n                                                                v' + generatorVersion) +
    '\n';

  console.log(welcome);
}