WIP: Add setup wizard? #384

webflo · 2018-04-13T20:27:00Z

I wrote a setup class, which provides some configuration options prior project initialization and deletes itself afterwards. This could be interesting for the composer initiative, or evaluator experience. We could add more features to this template without enforcing every feature.

The code is not pretty, but it does the job.

Current features:

Change drupal root? web => docroot
Remove drupal-console / drush / dotenv
Remove setup wizard itself
Remove default .travis config and phpunit

Possible features:

Configure dev env? Lando / ddev / etc.
Add webflo/drupal-core-strict?

Command for evaluation:

composer create-project --repository '{"type": "git", "url": "git@github.com:webflo/drupal-project.git"}' drupal-composer/drupal-project my-project dev-setup -vvv

Related issues:

jcnventura · 2018-04-16T12:39:21Z

Would make sense to also remove ~~LICENSE and~~ README.md.

~~Sites that are not distributed may not need to be GPL-licensed.~~

pfrenssen · 2018-04-19T10:22:34Z

Sites that are not distributed may not need to be GPL-licensed.

They still need to be GPL-licensed even if you don't intend to distribute them to a client.

jcnventura · 2018-04-23T16:05:21Z

@pfrenssen Yes, you're right. I got confused. Of course the site is GPL-licensed even in that case. What happens when you don't distribute the site is that you're not forced to provide the site user with a copy of it's source code.

Still, the drupal-project README.md should be removed from the created project.

jcnventura · 2018-04-23T16:12:57Z

scripts/composer/Setup.php

+        }
+        $config['extra']['installer-paths'] = $installer_paths;
+      }
+      $fs->dumpFile('.gitignore', $gitIgnore);


Move this before line 23. The logical flow would be to save the new gitignore just after the preg_replace on the gitIgnore lines, and not after the installer_paths block.

jcnventura · 2018-04-23T16:15:42Z

scripts/composer/Setup.php

+      }
+      $fs->dumpFile('.gitignore', $gitIgnore);
+    }
+    if ($event->getIO()->askConfirmation('<info>Remove dotenv?</info> [<comment>y,N</comment>]? ', TRUE)) {


Since default is true, it should be 'Y,n'.

Also, remove the .env.example and load.environment.php files (same as other scaffold files below).

jcnventura · 2018-04-23T16:17:46Z

scripts/composer/Setup.php

+      unset($config['require']['vlucas/phpdotenv']);
+      unset($config['require-dev']['vlucas/phpdotenv']);
+    }
+    if ($event->getIO()->askConfirmation('<info>Remove drush?</info> [<comment>y,N</comment>]? ', FALSE)) {


In this case, also remove the drush/Commands/PolicyCommands.php, drush/README.md, drush/drush.yml and drush/sites/self.site.yml files (same as other scaffold files below).

jcnventura · 2018-04-23T16:20:37Z

scripts/composer/Setup.php

+        '.travis.yml',
+        'phpunit.xml.dist',
+        'scripts/composer/Setup.php',
+      ]);


Remove also the drupal-composer README.md file.

jcnventura · 2018-04-23T16:22:31Z

scripts/composer/Setup.php

+      unset($config['require']['drupal/console']);
+      unset($config['require-dev']['drupal/console']);
+    }
+    if ($event->getIO()->askConfirmation('<info>Remove the installer and other scaffold files?</info> [<comment>y,N</comment>]? ', FALSE)) {


Project would be more user friendly if this option was TRUE by default. In which case, make the comment text 'Y,n'.

jcnventura · 2018-04-23T16:40:46Z

scripts/composer/Setup.php

+        }
+      }
+      unset($config['require']['vlucas/phpdotenv']);
+      unset($config['require-dev']['vlucas/phpdotenv']);


There is no phpdotenv in the require-dev section of composer.json.

pfrenssen · 2018-07-25T11:15:32Z

This works great but it throws an error when it starts installing dependencies because the altered composer.json file is not reloaded and it still tries to load the Setup.php file which has in the meantime been deleted.

I have been looking through the code if it is possible to trigger a reload of the composer.json file (it is tracked in Config::$configSource) but I couldn't find any code that allows to do this.

In my own project I solved it by implementing post-create-project-cmd hook and delaying the deletion of the file until this hook fires.

Here's the patch I used in my project to fix this, it might help you:

diff --git a/composer.json b/composer.json
index 969d52c..38670cb 100644
--- a/composer.json
+++ b/composer.json
@@ -31,9 +31,13 @@
         "post-root-package-install": [
             "@setup"
         ],
+        "post-create-project-cmd": [
+            "@cleanup"
+        ],
         "post-update-cmd": [
             "./vendor/bin/run drupal:site-setup"
         ],
+        "cleanup": "DrupalSiteTemplate\\composer\\Setup::cleanup",
         "setup": "DrupalSiteTemplate\\composer\\Setup::setup"
     },
     "extra": {
diff --git a/scripts/composer/Setup.php b/scripts/composer/Setup.php
index e59d29d..30592ab 100644
--- a/scripts/composer/Setup.php
+++ b/scripts/composer/Setup.php
@@ -75,25 +75,31 @@ class Setup {
       file_put_contents($filename, $file);
     }
 
-    // Remove the setup wizard.
-    unlink('scripts/composer/Setup.php');
-
+    // Remove the configuration related to the setup wizard.
+    unset($config['scripts']['cleanup']);
     unset($config['scripts']['setup']);
     $config['autoload']['classmap'] = array_diff($config['autoload']['classmap'], ['scripts/composer/Setup.php']);
     if (empty($config['autoload']['classmap'])) {
       unset($config['autoload']['classmap']);
     }
+    $config['scripts']['post-create-project-cmd'] = array_diff($config['scripts']['post-create-project-cmd'], ['@cleanup']);
+    if (empty($config['scripts']['post-create-project-cmd'])) {
+      unset($config['scripts']['post-create-project-cmd']);
+    }
     $config['scripts']['post-root-package-install'] = array_diff($config['scripts']['post-root-package-install'], ['@setup']);
     if (empty($config['scripts']['post-root-package-install'])) {
       unset($config['scripts']['post-root-package-install']);
     }
 
     $composer_json->write($config);
 
     return TRUE;
   }
+
+  /**
+   * Removes the setup wizard.
+   */
+  public static function cleanup(): void {
+    unlink('scripts/composer/Setup.php');
+  }
 }

FatherShawn · 2018-07-25T13:18:48Z

I added a lot of wizard-like behavior in digitalpulp/ballast which is downstream to this project. post-create-command-project-cmd is a great event - I should have looked at the event list. I'll move some of my tasks to more appropriate events- thanks for the tip @pfrenssen !

pfrenssen · 2018-07-26T09:11:36Z

I'm also having another problem related to modifying the composer.json file: the autoloader is generated using the original file, so I need to execute $ composer dump-autoload after running the wizard. I have no time unfortunately right now to look into a structural solution for this.

We are also working on a downstream variant of this, it might serve as inspiration: openeuropa/drupal-site-template#1

hansfn · 2018-08-03T12:14:03Z

Are we about to recreate drupal-init from hussainweb/drupal-composer-init. Probably not :-)

RaphTbm · 2018-08-17T02:02:46Z

Hi!

Is the current whole code in ScriptHandler.php should be moved in this initial setup too?

I don't have a full scope of it, but the only necessity for ScriptHandler.php to be in the post-install/update commands seems to be relative to the "Prepare the settings file for installation" part which is dependent of drupal/core and what is retrieved by drupal/scaffold.
But to the end, drupal/core and the drupal scaffolded files (as sites/default/default.settings.php) are installed during the create-project process and the files created/updated in ScriptHandler.php seems to be related to a need on the initial install/setup only.

I supposed that post-create-project-cmd was not knew previously (?)

edit: for ScriptHandler.php, it's not the whole code of the file, but the whole code of createRequiredFiles() function!

Cheers!

Chi-teck · 2019-05-21T08:16:14Z

DCG has got similar wizard recently.
drush generate project --directory=/path/to/project

leymannx · 2019-05-21T12:13:33Z

What's DCG?

Chi-teck · 2019-05-21T12:31:11Z

What's DCG?

https://github.com/Chi-teck/drupal-code-generator

I think the approach with script handlers in Composer template will always be tricky because of the need to update/remove existing files.

AlexSkrypnyk · 2024-05-12T20:11:48Z

This pull request/issue has been inactive for over a year and is being closed due to inactivity. If the issue still persists or the contribution is still relevant, please feel free to reopen it or create a new one.

Thank you for your understanding and your contributions to the project!

Setup wizard poc

7808a6d

jcnventura reviewed Apr 23, 2018

View reviewed changes

This was referenced Jun 26, 2018

Suggest to install Drupal Console #353

Closed

Move drupal/console from a required dependency to a dev dependency #352

Closed

AlexSkrypnyk closed this May 12, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

WIP: Add setup wizard? #384

WIP: Add setup wizard? #384

webflo commented Apr 13, 2018 •

edited

jcnventura commented Apr 16, 2018 •

edited

pfrenssen commented Apr 19, 2018

jcnventura commented Apr 23, 2018

jcnventura Apr 23, 2018

jcnventura Apr 23, 2018

jcnventura Apr 23, 2018

jcnventura Apr 23, 2018

jcnventura Apr 23, 2018

jcnventura Apr 23, 2018

jcnventura Apr 23, 2018

pfrenssen commented Jul 25, 2018

FatherShawn commented Jul 25, 2018

pfrenssen commented Jul 26, 2018

hansfn commented Aug 3, 2018

RaphTbm commented Aug 17, 2018 •

edited

Chi-teck commented May 21, 2019

leymannx commented May 21, 2019

Chi-teck commented May 21, 2019

AlexSkrypnyk commented May 12, 2024

WIP: Add setup wizard? #384

WIP: Add setup wizard? #384

Conversation

webflo commented Apr 13, 2018 • edited

jcnventura commented Apr 16, 2018 • edited

pfrenssen commented Apr 19, 2018

jcnventura commented Apr 23, 2018

jcnventura Apr 23, 2018

Choose a reason for hiding this comment

jcnventura Apr 23, 2018

Choose a reason for hiding this comment

jcnventura Apr 23, 2018

Choose a reason for hiding this comment

jcnventura Apr 23, 2018

Choose a reason for hiding this comment

jcnventura Apr 23, 2018

Choose a reason for hiding this comment

jcnventura Apr 23, 2018

Choose a reason for hiding this comment

jcnventura Apr 23, 2018

Choose a reason for hiding this comment

pfrenssen commented Jul 25, 2018

FatherShawn commented Jul 25, 2018

pfrenssen commented Jul 26, 2018

hansfn commented Aug 3, 2018

RaphTbm commented Aug 17, 2018 • edited

Chi-teck commented May 21, 2019

leymannx commented May 21, 2019

Chi-teck commented May 21, 2019

AlexSkrypnyk commented May 12, 2024

webflo commented Apr 13, 2018 •

edited

jcnventura commented Apr 16, 2018 •

edited

RaphTbm commented Aug 17, 2018 •

edited