generator-laravel-5/generators/app/index.js

A yeoman generator for Laravel 5 applications where certain packages and BrowserSync are included.

'use strict';
const Generator = require('yeoman-generator');
const chalk = require('chalk');
const fs = require('fs');

module.exports = class extends Generator {
  /**
   * Ask the developer some questions that will define the build result.
   * @returns {Promise|*|PromiseLike<T | never>|Promise<T | never>}
   */
  prompting() {
    this.log("Let's create a new " + chalk.blue('Laravel 5') + ' application');

    const questions = [
      {
        type: 'input',
        name: 'appname',
        message: "What's the name of your application?",
        default: 'application'
      },
      {
        type: 'list',
        name: 'version',
        message: 'Which Laravel version do you want to use?',
        choices: ['5.7.*', '5.6.*', '5.5.*'],
        default: 0
      },
      {
        type: 'list',
        name: 'proxy',
        message: 'From where do you serve your application during development?',
        choices: ['php artisan serve (localhost:8000)', 'localhost'],
        default: 0
      },
      {
        when: answers => {
          return answers.proxy === 'localhost';
        },
        type: 'list',
        name: 'schema',
        message: 'Which schema do you want to use?',
        choices: ['http', 'https'],
        default: 'https'
      },
      {
        type: 'list',
        name: 'preset',
        message: 'Which laravel frontend preset do you want to use?',
        choices: ['none', 'bootstrap', 'vue', 'react'],
        default: 'none'
      },
      {
        type: 'confirm',
        name: 'enableAuth',
        message: "Do you want to create Laravel's auth layer?",
        default: false
      },
      {
        type: 'confirm',
        name: 'localGit',
        message: 'Do you want to init a local git repository?',
        default: true
      }
    ];

    return this.prompt(questions).then(answers => {
      // To access answers later use this.answers.someAnswer;
      this.answers = answers;
    });
  }

  /**
   * Given the appname and version let's create a new Laravel 5.* application
   */
  installLaravel() {
    this.spawnCommandSync('composer', [
      'create-project',
      '--prefer-dist',
      'laravel/laravel',
      this.answers.appname,
      this.answers.version
    ]);
  }

  /**
   * Define the destination root folder. This will be used in the following build steps.
   */
  setApplicationFolder() {
    this.destinationRoot(this.destinationPath(this.answers.appname));
  }

  /**
   * Install some third party laravel packages that might be useful for your application.
   */
  installLaravelPackages() {
    let composerDevPackages = [
      'require',
      '--dev',
      'doctrine/dbal',
      'barryvdh/laravel-ide-helper',
      'barryvdh/laravel-cors',
      'phpmetrics/phpmetrics',
      'beyondcode/laravel-self-diagnosis',
      'symplify/easy-coding-standard',
      'spatie/phpunit-watcher'
    ];
    if (this.answers.version === '5.7.*') {
      composerDevPackages.push('laravel/telescope');
    } else {
      composerDevPackages.push('barryvdh/laravel-debugbar');
    }
    this.spawnCommandSync('composer', composerDevPackages);
  }

  /**
   * Add additional composer scripts to composer.json. Composer.json is deleted and then written
   * with the new scripts definition.
   */
  composerScripts() {
    let data = fs.readFileSync('composer.json', 'utf8');
    let composer = JSON.parse(data);
    composer.scripts.analyze = ['phpmetrics --report-html=phpmetrics ./app'];
    composer.scripts.ecsCheck = ['vendor/bin/ecs check .'];
    composer.scripts.ecsFix = ['vendor/bin/ecs check . --fix'];

    fs.unlinkSync('composer.json');

    this.fs.write(
      this.destinationPath('composer.json'),
      JSON.stringify(composer, null, 2)
    );
  }

  /**
   * Run `php artisan preset` with the given preset. This will prepare the frontend files and structure.
   */
  preset() {
    this.spawnCommandSync('php', ['artisan', 'preset', this.answers.preset]);
  }

  /**
   * Remove certain files that will be created by the generator in the following build steps.
   */
  removeFiles() {
    fs.unlinkSync('webpack.mix.js');
    fs.unlinkSync('package.json');
    fs.unlinkSync('.gitignore');
  }

  /**
   * Create new files from templates.
   * - webpack.mix.ejs => webpack.mix.js
   * - package.ejs => package.js
   * - .gitignore => .gitignore
   */
  templates() {
    this.fs.write(this.destinationPath('database/database.sqlite'), '');
    let schema = this.answers.schema || 'http';
    let proxyHost =
      this.answers.proxy === 'localhost' ? this.answers.proxy : 'localhost:8000';
    let proxy = schema + '://' + proxyHost;

    let resourcesPath =
      this.answers.version === '5.7.*' ? 'resources' : 'resources/assets';
    this.fs.copyTpl(
      this.templatePath('webpack.mix.ejs'),
      this.destinationPath('webpack.mix.js'),
      {
        version: this.answers.version,
        preset: this.answers.preset,
        proxy: proxy,
        resourcesPath: resourcesPath
      }
    );

    this.fs.copyTpl(
      this.templatePath('package.ejs'),
      this.destinationPath('package.json'),
      {
        preset: this.answers.preset
      }
    );

    this.fs.copy(this.templatePath('gitignore'), this.destinationPath('.gitignore'));
    this.fs.copy(
      this.templatePath('easy-coding-standard.yml'),
      this.destinationPath('easy-coding-standard.yml')
    );
  }

  /**
   * Perform the frontend installation with NPM.
   * Yarn and bower are disabled.
   */
  install() {
    this.installDependencies({
      bower: false,
      yarn: false,
      npm: true
    });
  }

  /**
   * Finish the build by running php artisan commands and npm scripts.
   * After this step your new application is ready.
   */
  end() {
    if (this.answers.preset !== 'none') {
      this.spawnCommandSync('npm', ['run', 'dev']);
    }
    if (this.answers.enableAuth) {
      this.spawnCommandSync('php', ['artisan', 'make:auth']);
    }

    this.spawnCommandSync('php', ['artisan', 'storage:link']);
    this.spawnCommandSync('php', ['artisan', 'ide-helper:generate']);
    this.spawnCommandSync('php', ['artisan', 'ide-helper:meta']);
    if (this.answers.version === '5.7.*') {
      this.spawnCommandSync('php', ['artisan', 'telescope:install']);
    }
    if (this.answers.localGit) {
      this.spawnCommandSync('git', ['init']);
      this.spawnCommandSync('git', ['add', '.']);
      this.spawnCommandSync('git', [
        'commit',
        '-m',
        'Initial commit by yeoman laravel-5 generator'
      ]);
    }
    this.spawnCommandSync('php', ['artisan', 'self-diagnosis']);
  }
};