Honor .env files and suggest usage (drupal-composer#351)

Author: weitzman

.env.example

@@ -0,0 +1,27 @@
+#
+# Copy and rename this file to .env at root of this project.
+#
+
+# A common use case is to supply database creds via the environment. Edit settings.php
+# like so:
+#
+# $databases['default']['default'] = [
+#   'database' =>  getenv('MYSQL_DATABASE'),
+#   'driver' => 'mysql',
+#   'host' => getenv('MYSQL_HOSTNAME'),
+#   'namespace' => 'Drupal\\Core\\Database\\Driver\\mysql',
+#   'password' => getenv('MYSQL_PASSWORD'),
+#   'port' => getenv('MYSQL_PORT'),
+#   'prefix' => '',
+#   'username' => getenv('MYSQL_USER'),
+# ];
+#
+# Uncomment and populate as needed.
+# MYSQL_DATABASE=
+# MYSQL_HOSTNAME=
+# MYSQL_PASSWORD=
+# MYSQL_PORT=
+# MYSQL_USER=
+
+# Another common use case is to set Drush's --uri via environment.
+# DRUSH_OPTIONS_URI=http://example.com

.gitignore

@@ -19,3 +19,6 @@
 
 # Ignore files generated by PhpStorm
 /.idea/
+
+# Ignore .env files as they are personal
+/.env

README.md

@@ -2,7 +2,7 @@
 
 [![Build Status](https://travis-ci.org/drupal-composer/drupal-project.svg?branch=8.x)](https://travis-ci.org/drupal-composer/drupal-project)
 
-This project template should provide a kickstart for managing your site
+This project template provides a starter kit for managing your site
 dependencies with [Composer](https://getcomposer.org/).
 
 If you want to know how to use it as replacement for
@@ -49,6 +49,7 @@ When installing the given `composer.json` some tasks are taken care of:
 * Creates `web/sites/default/files`-directory.
 * Latest version of drush is installed locally for use at `vendor/bin/drush`.
 * Latest version of DrupalConsole is installed locally for use at `vendor/bin/drupal`.
+* Creates environment variables based on your .env file. See [.env.example](.env.example).
 
 ## Updating Drupal Core
 

composer.json

@@ -22,6 +22,7 @@
         "drupal/console": "^1.0.2",
         "drupal/core": "~8.5",
         "drush/drush": "^9.0.0",
+        "vlucas/phpdotenv": "^2.4",
         "webflo/drupal-finder": "^1.0.0",
         "webmozart/path-util": "^2.3"
     },
@@ -39,7 +40,8 @@
     "autoload": {
         "classmap": [
             "scripts/composer/ScriptHandler.php"
-        ]
+        ],
+        "files": ["load.environment.php"]
     },
     "scripts": {
         "drupal-scaffold": "DrupalComposer\\DrupalScaffold\\Plugin::scaffold",

load.environment.php

@@ -0,0 +1,20 @@
+<?php
+
+/**
+ * This file is included very early. See autoload.files in composer.json and
+ * https://getcomposer.org/doc/04-schema.md#files
+ */
+
+use Dotenv\Dotenv;
+use Dotenv\Exception\InvalidPathException;
+
+/**
+ * Load any .env file. See /.env.example.
+ */
+$dotenv = new Dotenv(__DIR__);
+try {
+  $dotenv->load();
+}
+catch (InvalidPathException $e) {
+  // Do nothing. Production environments rarely use .env files.
+}