generator-folklore 3.0.5 → 3.0.7

package/lib/generators/laravel-project/index.js

@@ -0,0 +1,519 @@
+"use strict";
+
+var _chalk = _interopRequireDefault(require("chalk"));
+
+var _glob = _interopRequireDefault(require("glob"));
+
+var _lodash = _interopRequireDefault(require("lodash"));
+
+var _passwordGenerator = _interopRequireDefault(require("password-generator"));
+
+var _path = _interopRequireDefault(require("path"));
+
+var _yeomanRemote = _interopRequireDefault(require("yeoman-remote"));
+
+var _generator = _interopRequireDefault(require("../../lib/generator"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
+
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
+
+function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+
+module.exports = class LaravelProjectGenerator extends _generator.default {
+  static safeDbString(str) {
+    return str.replace(/[-s.]+/gi, '_').replace(/[^a-z0-9]+/gi, '');
+  }
+
+  static getPassword() {
+    return (0, _passwordGenerator.default)(20, false);
+  }
+
+  constructor(...args) {
+    super(...args);
+    this.argument('project-name', {
+      type: String,
+      required: false
+    });
+    this.argument('project-host', {
+      type: String,
+      required: false
+    });
+    this.option('laravel-version', {
+      type: String,
+      desc: 'Laravel version',
+      defaults: '9'
+    });
+    this.option('laravel-branch', {
+      type: String,
+      desc: 'Laravel repository branch'
+    });
+    this.option('url', {
+      type: String,
+      desc: 'Project url',
+      defaults: 'https://<%= project_host %>'
+    });
+    this.option('local-url', {
+      type: String,
+      desc: 'Project local url',
+      defaults: 'https://<%= project_host %>.test:8080'
+    });
+    this.option('proxy-url', {
+      type: String,
+      desc: 'Project proxy url',
+      defaults: 'https://<%= project_host %>.test'
+    });
+    this.option('assets-path', {
+      type: String,
+      desc: 'Path for assets',
+      defaults: 'resources/assets'
+    });
+    this.option('public-path', {
+      type: String,
+      desc: 'Path for build',
+      defaults: 'public'
+    });
+    this.option('js-path', {
+      type: String,
+      desc: 'Path for the javascript',
+      defaults: 'js'
+    });
+    this.option('styles-path', {
+      type: String,
+      desc: 'Path for the styles',
+      defaults: 'styles'
+    });
+    this.option('db-host', {
+      type: String,
+      desc: 'Database host',
+      defaults: 'localhost'
+    });
+    this.option('db-username', {
+      type: String,
+      desc: 'Database username',
+      defaults: 'homestead'
+    });
+    this.option('db-password', {
+      type: String,
+      desc: 'Database password',
+      defaults: 'secret'
+    });
+    this.option('db-name', {
+      type: String,
+      desc: 'Database name'
+    });
+    this.option('panneau', {
+      type: Boolean,
+      desc: 'Add panneau',
+      defaults: false
+    });
+    this.option('mediatheque', {
+      type: Boolean,
+      desc: 'Add mediatheque',
+      defaults: false
+    });
+    this.option('auth', {
+      type: Boolean,
+      desc: 'Add auth',
+      defaults: false
+    });
+  }
+
+  get prompting() {
+    return {
+      welcome() {
+        if (this.options.quiet) {
+          return;
+        }
+
+        console.log(_chalk.default.yellow('\n----------------------'));
+        console.log('Laravel Generator');
+        console.log(_chalk.default.yellow('----------------------\n'));
+      },
+
+      prompts() {
+        const prompts = [];
+
+        if (!this.options['project-name']) {
+          prompts.push(_generator.default.prompts.project_name);
+        }
+
+        if (!this.options['project-host']) {
+          prompts.push({
+            type: 'input',
+            name: 'project-host',
+            message: 'What is the host of the project?',
+            default: answers => {
+              const projectName = this.options['project-name'] || answers['project-name'];
+              return projectName.match(/.[^.]+$/) ? projectName : `${projectName}.com`;
+            }
+          });
+        }
+
+        if (!this.options['db-name']) {
+          prompts.push({
+            type: 'input',
+            name: 'db-name',
+            message: 'What is the name of the database?',
+            default: answers => {
+              const projectName = this.options['project-name'] || answers['project-name'];
+              return projectName.match(/^([^.]+)/)[1];
+            }
+          });
+        }
+
+        const featuresChoices = [!this.options.mediatheque && {
+          name: 'Mediatheque',
+          value: 'mediatheque',
+          checked: true
+        }, !this.options.panneau && {
+          name: 'Panneau',
+          value: 'panneau',
+          checked: false
+        }, !this.options.auth && {
+          name: 'Auth',
+          value: 'auth',
+          checked: false
+        }].filter(Boolean);
+
+        if (featuresChoices.length) {
+          prompts.push({
+            type: 'checkbox',
+            name: 'features',
+            choices: featuresChoices,
+            message: 'Which features?',
+            default: featuresChoices.filter(it => it.checked || false).map(it => it.name)
+          });
+        }
+
+        if (!prompts.length) {
+          return null;
+        }
+
+        return this.prompt(prompts).then(answers => {
+          if (answers['project-name']) {
+            this.options['project-name'] = answers['project-name'];
+          }
+
+          if (answers['project-host']) {
+            this.options['project-host'] = answers['project-host'];
+          }
+
+          if (answers['db-name']) {
+            this.options['db-name'] = answers['db-name'];
+          }
+
+          const features = answers.features || [];
+
+          if (features.indexOf('panneau') !== -1) {
+            this.options.panneau = true;
+          }
+
+          if (features.indexOf('auth') !== -1) {
+            this.options.auth = true;
+          }
+
+          if (features.indexOf('mediatheque') !== -1) {
+            this.options.mediatheque = true;
+          }
+        });
+      }
+
+    };
+  }
+
+  configuring() {
+    const assetsPath = _lodash.default.get(this.options, 'assets-path', '').replace(/\/$/, '');
+
+    const publicPath = _lodash.default.get(this.options, 'public-path');
+
+    const jsPath = _lodash.default.get(this.options, 'js-path');
+
+    const jsSrcPath = _path.default.join(assetsPath, jsPath);
+
+    const stylesPath = _lodash.default.get(this.options, 'styles-path');
+
+    const stylesSrcPath = _path.default.join(assetsPath, stylesPath);
+
+    this.composeWith('folklore:prettier', {
+      'skip-install': true,
+      quiet: true
+    });
+    this.composeWith('folklore:eslint', {
+      'skip-install': true,
+      quiet: true
+    });
+    this.composeWith('folklore:stylelint', {
+      'skip-install': true,
+      quiet: true
+    });
+    this.composeWith('folklore:browserslist', {
+      'skip-install': true,
+      quiet: true
+    });
+    this.composeWith('folklore:editorconfig', {
+      quiet: true,
+      'skip-install': true
+    });
+    this.composeWith('folklore:react-app', {
+      'project-name': this.options['project-name'],
+      path: jsSrcPath,
+      'styles-path': stylesSrcPath,
+      quiet: true,
+      'skip-install': true
+    });
+    this.composeWith('folklore:scss', {
+      'project-name': this.options['project-name'],
+      path: stylesSrcPath,
+      react: true,
+      quiet: true,
+      'skip-install': true
+    });
+    this.composeWith('folklore:build', {
+      'src-path': assetsPath,
+      'entry-path': _path.default.join(jsSrcPath, 'index.js'),
+      'build-path': publicPath,
+      quiet: true,
+      'skip-install': true
+    });
+    this.composeWith('folklore:intl', {
+      'translations-path': _path.default.join(jsSrcPath, '**/*.{js,jsx}'),
+      'output-path': './lang',
+      'without-id-only': true,
+      quiet: true,
+      'skip-install': true
+    });
+
+    if (this.options.mediatheque) {
+      this.composeWith('folklore:laravel-mediatheque', {
+        'project-name': this.options['project-name'],
+        'skip-install': true,
+        quiet: true
+      });
+    }
+
+    if (this.options.panneau) {
+      this.composeWith('folklore:laravel-panneau', {
+        'project-name': this.options['project-name'],
+        'skip-install': skipInstall,
+        quiet: true
+      });
+    } // if (this.options.auth) {
+    //     this.composeWith('folklore:laravel-auth', {
+    //         'project-name': this.options['project-name'],
+    //         'js-path': jsSrcPath,
+    //         'styles-path': stylesSrcPath,
+    //         'skip-install': skipInstall,
+    //         'install-npm': true,
+    //         quiet: true,
+    //     });
+    // }
+
+  }
+
+  get writing() {
+    return {
+      laravel() {
+        const done = this.async();
+        const {
+          'laravel-version': laravelVersion = null,
+          'laravel-branch': laravelBranch = null
+        } = this.options;
+        const versionBranch = laravelVersion !== 'latest' && laravelVersion !== null ? `${laravelVersion.indexOf('.') !== -1 ? laravelVersion : `${laravelVersion}.x`}` : null;
+        const branch = laravelBranch || versionBranch;
+
+        const remoteCallback = (err, cachePath) => {
+          const destinationPath = this.destinationPath();
+
+          const files = _glob.default.sync('**', {
+            dot: true,
+            nodir: true,
+            cwd: cachePath
+          });
+
+          let source;
+          let destination;
+          files.forEach(file => {
+            source = _path.default.join(cachePath, file);
+            destination = _path.default.join(destinationPath, file);
+
+            if (!this.fs.exists(destination)) {
+              this.fs.copy(source, destination);
+            }
+          });
+          done();
+        };
+
+        if (branch !== null) {
+          (0, _yeomanRemote.default)('laravel', 'laravel', branch, remoteCallback);
+        } else {
+          (0, _yeomanRemote.default)('laravel', 'laravel', remoteCallback);
+        }
+      },
+
+      removeFiles() {
+        const files = ['package.json', 'config/app.php', 'config/auth.php', 'routes/web.php', 'vite.config.js', 'resources/css', 'resources/js', 'resources/views/welcome.blade.php', 'app/Http/Controllers/HomeController.php', 'app/Http/Middleware/TrustProxies.php', 'app/Models/User.php'];
+        files.forEach(file => {
+          const filePath = this.destinationPath(file);
+          this.fs.delete(filePath);
+        });
+      },
+
+      composerJSON() {
+        this.composerJson.merge({
+          require: {
+            'folklore/laravel-folklore': 'v1.x-dev',
+            'folklore/laravel-locale': 'v8.x-dev',
+            'folklore/laravel-image': 'v1.x-dev'
+          },
+          'require-dev': {
+            'laravel/telescope': '^4.0.0'
+          },
+          extra: {
+            laravel: {
+              'dont-discover': ['laravel/telescope']
+            }
+          }
+        });
+      },
+
+      packageJSON() {
+        this.packageJson.merge({
+          scripts: {
+            clean: 'rm -rf public/static && rm -rf public/precache-*',
+            'build:scripts': 'flklr build --load-env ./resources/assets/js/index.js',
+            'build:views': 'php artisan assets:view',
+            build: 'npm run clean && npm run build:scripts && npm run build:views',
+            start: 'npm run server',
+            server: 'flklr serve --load-env ./resources/assets/js/index.js'
+          }
+        });
+      },
+
+      env() {
+        const url = _lodash.default.template(_lodash.default.get(this.options, 'url'))({
+          project_host: this.options['project-host'],
+          project_name: this.options['project-name']
+        }).replace(/^(http)?(s)?(:\/\/)?/, 'http$2://');
+
+        const urlLocal = _lodash.default.template(_lodash.default.get(this.options, 'local-url'))({
+          project_host: this.options['project-host'],
+          project_name: this.options['project-name']
+        }).replace(/^(http)?(s)?(:\/\/)?/, 'http$2://');
+
+        const urlProxy = _lodash.default.template(_lodash.default.get(this.options, 'proxy-url', _lodash.default.get(this.options, 'local-url')))({
+          project_host: this.options['project-host'],
+          project_name: this.options['project-name']
+        }).replace(/^(http)?(s)?(:\/\/)?/, 'http$2://');
+
+        const templateData = {
+          project_name: this.options['project-name'],
+          db_host: this.options['db-host'],
+          db_username: this.options['db-username'],
+          db_password: this.options['db-password'],
+          db_name: this.options['db-name'],
+          url: urlLocal,
+          proxy_url: urlProxy
+        };
+
+        const prodTemplateData = _objectSpread(_objectSpread({}, templateData), {}, {
+          url,
+          db_username: this.options['db-name']
+        });
+
+        const src = this.templatePath('env');
+        const dest = this.destinationPath('.env');
+        this.fs.copyTpl(src, dest, templateData);
+        const srcExample = this.templatePath('env');
+        const destExample = this.destinationPath('.env.example');
+        this.fs.copyTpl(srcExample, destExample, templateData); // const srcProd = this.templatePath('env.prod');
+        // const destProd = this.destinationPath('.env.prod');
+        // this.fs.copyTpl(srcProd, destProd, prodTemplateData);
+      },
+
+      files() {
+        const templatePath = this.templatePath('laravel');
+        const destinationPath = this.destinationPath();
+
+        const files = _glob.default.sync('**', {
+          dot: true,
+          nodir: true,
+          cwd: templatePath
+        });
+
+        files.forEach(file => {
+          const source = _path.default.join(templatePath, file);
+
+          const destination = _path.default.join(destinationPath, file);
+
+          if (file.match(/\.php$/i)) {
+            this.fs.copyTpl(source, destination, {
+              options: this.options
+            });
+          } else {
+            this.fs.copy(source, destination);
+          }
+        });
+      }
+
+    };
+  }
+
+  get install() {
+    return {
+      async npm() {
+        if (this.options['skip-install']) {
+          return;
+        }
+
+        await this.spawnCommand('npm', ['install']);
+      },
+
+      async composer() {
+        if (this.options['skip-install']) {
+          return;
+        }
+
+        await this.spawnCommand('composer', ['install']);
+      },
+
+      async keyGenerate() {
+        if (this.options['skip-install']) {
+          return;
+        }
+
+        await this.spawnCommand('php', ['artisan', 'key:generate']);
+      },
+
+      async vendorPublish() {
+        if (this.options['skip-install']) {
+          return;
+        }
+
+        await this.spawnCommand('php', ['artisan', 'vendor:publish', '--provider=Folklore\\ServiceProvider']);
+        await this.spawnCommand('php', ['artisan', 'vendor:publish', '--provider=Folklore\\Locale\\LocaleServiceProvider']);
+        await this.spawnCommand('php', ['artisan', 'vendor:publish', '--provider=Folklore\\Image\\ServiceProvider']);
+      },
+
+      async telescope() {
+        if (this.options['skip-install']) {
+          return;
+        }
+
+        await this.spawnCommand('php', ['artisan', 'telescope:install']);
+      },
+
+      async valet() {
+        if (this.options['skip-install']) {
+          return;
+        }
+
+        await this.spawnCommand('valet', ['link', '--secure', this.options['project-host']]);
+      }
+
+    };
+  }
+
+};

package/lib/generators/laravel-project/templates/env

@@ -0,0 +1,41 @@
+APP_NAME=Laravel
+APP_ENV=local
+APP_KEY=
+APP_DEBUG=true
+APP_URL=<%= url %>
+
+LOG_CHANNEL=stack
+LOG_DEPRECATIONS_CHANNEL=null
+LOG_LEVEL=debug
+
+DB_CONNECTION=mysql
+DB_HOST=127.0.0.1
+DB_PORT=3306
+DB_DATABASE=<%= db_name %>
+DB_USERNAME=<%= db_username %>
+DB_PASSWORD=<%= db_password %>
+
+BROADCAST_DRIVER=log
+CACHE_DRIVER=file
+FILESYSTEM_DISK=local
+QUEUE_CONNECTION=sync
+SESSION_DRIVER=file
+SESSION_LIFETIME=120
+
+MEMCACHED_HOST=127.0.0.1
+
+REDIS_HOST=127.0.0.1
+REDIS_PASSWORD=null
+REDIS_PORT=6379
+
+MAIL_MAILER=smtp
+MAIL_HOST=mailhog
+MAIL_PORT=1025
+MAIL_USERNAME=null
+MAIL_PASSWORD=null
+MAIL_ENCRYPTION=null
+MAIL_FROM_ADDRESS="dev@folklore.email"
+MAIL_FROM_NAME="${APP_NAME}"
+
+# react-scripts variables
+FLKLR_PROXY=<%= proxy_url %>

package/lib/generators/laravel-project/templates/laravel/app/Composers/AppComposer.php

@@ -0,0 +1,48 @@
+<?php
+
+namespace App\Composers;
+
+use Illuminate\Http\Request;
+use Illuminate\View\View;
+use App\Http\Resources\UserResource;
+
+class AppComposer
+{
+
+    /**
+     * The request
+     *
+     * @var \Illuminate\Http\Request
+     */
+    protected $request;
+
+    /**
+     * Create a new profile composer.
+     *
+     * @param  \Illuminate\Http\Request  $request
+     * @return void
+     */
+    public function __construct(Request $request)
+    {
+        $this->request = $request;
+    }
+
+    /**
+     * Bind data to the view.
+     *
+     * @param  View  $view
+     * @return void
+     */
+    public function compose(View $view)
+    {
+        $site = $this->request->site();
+        $user = $this->request->user();
+
+        $view->props = [
+            'routes' => $view->routes,
+            'intl' => $view->intl,
+            'user' => !is_null($user) ? new UserResource($user) : null,
+            'site' => $site,
+        ];
+    }
+}

package/lib/generators/laravel-project/templates/laravel/app/Composers/IntlComposer.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace App\Composers;
+
+use Folklore\Composers\IntlComposer as BaseIntlComposer;
+
+class IntlComposer extends BaseIntlComposer
+{
+    protected $namespaces = ['*'];
+}

package/lib/generators/laravel-project/templates/laravel/app/Composers/MetaComposer.php

@@ -0,0 +1,48 @@
+<?php
+
+namespace App\Composers;
+
+use Illuminate\Http\Request;
+use Illuminate\View\View;
+use Illuminate\Http\Resources\Json\JsonResource;
+
+class MetaComposer
+{
+    /**
+     * The request
+     *
+     * @var \Illuminate\Http\Request
+     */
+    protected $request;
+
+    /**
+     * Create a new profile composer.
+     *
+     * @param  \Illuminate\Http\Request  $request
+     * @return void
+     */
+    public function __construct(Request $request)
+    {
+        $this->request = $request;
+    }
+
+    /**
+     * Bind data to the view.
+     *
+     * @param  View  $view
+     * @return void
+     */
+    public function compose(View $view)
+    {
+        $locale = $this->request->locale();
+        $view->title = trans('meta.title');
+        $view->description = trans('meta.description');
+        $view->image = asset(trans('meta.image'));
+        $view->url = $this->request->url();
+        $view->canonical = $this->request->url();
+        $view->siteName = trans('meta.siteName');
+        $view->appId = config('services.facebook.client_id');
+
+        $page = $view->page instanceof JsonResource ? $view->page->resource : $view->page;
+    }
+}

package/lib/generators/laravel-project/templates/laravel/app/Composers/RoutesComposer.php

@@ -0,0 +1,19 @@
+<?php
+
+namespace App\Composers;
+
+use Illuminate\View\View;
+use Illuminate\Http\Request;
+use Illuminate\Routing\Router;
+use Folklore\Composers\RoutesComposer as BaseRoutesComposer;
+
+class RoutesComposer extends BaseRoutesComposer
+{
+    protected $routes = [];
+
+    protected $routesLocalized = [
+        'home',
+    ];
+
+    protected $withoutParametersPatterns = true;
+}

package/lib/generators/laravel-project/templates/laravel/app/Contracts/Repositories/Users.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace App\Contracts\Repositories;
+
+use Folklore\Contracts\Repositories\Users as BaseUsers;
+use App\Contracts\Resources\User as UserResource;
+
+interface Users extends BaseUsers
+{
+    public function findById(string $id): ?UserResource;
+
+    public function findByEmail(string $email): ?UserResource;
+
+    public function create($data): UserResource;
+
+    public function update(string $id, $data): ?UserResource;
+}