README

此项目模板提供了一个起始套件，用于使用 Composer 管理您的网站依赖。

如果您想了解如何将其用作 Drush Make 的替代方案，请访问 drupal.org 上的文档。

用法

首先您需要 安装 Composer。

注意：以下说明适用于 全局 Composer 安装。您可能需要根据您的设置将 composer 替换为 php composer.phar（或类似）。

之后您可以创建项目

composer create-project merlin-tribukait/drupal-project:8.x-dev DIR-NAME --no-interaction

使用以下命令安装项目

composer install

注意：项目自动创建一个 docksal-local.env 文件，并将其填充为以 .docksal 作为虚拟主机。

运行 Docksal 容器

fin init

安装 Drupal 网站

fin init-site

> Note: The Drupal Administator account will be set automaticly to admin:admin, remember to change it before the site goes into production.
The Site will be installed with the minimal profile.
Following modules are enabled by default : Admin Toolbar, Admin Toolbar Tools, Adminimal Admin Toolbar and  Module Filter.
A Basic Landingpage Content Type will be automaticaly provided including a set of media settings.

With `composer require ...` you can download new dependencies to your
installation.

cd some-dir composer require drupal/devel:~1.0

The `composer create-project` command passes ownership of all files to the
project that is created. You should create a new git repository, and commit
all files not excluded by the .gitignore file.

## What does the template do?

When installing the given `composer.json` some tasks are taken care of:

* Drupal will be installed in the `web`-directory.
* Autoloader is implemented to use the generated composer autoloader in `vendor/autoload.php`,
  instead of the one provided by Drupal (`web/vendor/autoload.php`).
* Modules (packages of type `drupal-module`) will be placed in `web/modules/contrib/`
* Theme (packages of type `drupal-theme`) will be placed in `web/themes/contrib/`
* Profiles (packages of type `drupal-profile`) will be placed in `web/profiles/contrib/`
* Creates default writable versions of `settings.php` and `services.yml`.
* 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

This project will attempt to keep all of your Drupal Core files up-to-date; the
project [drupal-composer/drupal-scaffold](https://github.com/drupal-composer/drupal-scaffold)
is used to ensure that your scaffold files are updated every time drupal/core is
updated. If you customize any of the "scaffolding" files (commonly .htaccess),
you may need to merge conflicts if any of your modified files are updated in a
new release of Drupal core.

Follow the steps below to update your core files.

1. Run `composer update drupal/core webflo/drupal-core-require-dev symfony/* --with-dependencies` to update Drupal Core and its dependencies.
1. Run `git diff` to determine if any of the scaffolding files have changed.
   Review the files for any changes and restore any customizations to
  `.htaccess` or `robots.txt`.
1. Commit everything all together in a single commit, so `web` will remain in
   sync with the `core` when checking out branches or running `git bisect`.
1. In the event that there are non-trivial conflicts in step 2, you may wish
   to perform these steps on a branch, and use `git merge` to combine the
   updated core files with your customized files. This facilitates the use
   of a [three-way merge tool such as kdiff3](http://www.gitshah.com/2010/12/how-to-setup-kdiff-as-diff-tool-for-git.html). This setup is not necessary if your changes are simple;
   keeping all of your modifications at the beginning or end of the file is a
   good strategy to keep merges easy.

## Generate composer.json from existing project

With using [the "Composer Generate" drush extension](https://www.drupal.org/project/composer_generate)
you can now generate a basic `composer.json` file from an existing project. Note
that the generated `composer.json` might differ from this project's file.


## FAQ

### Should I commit the contrib modules I download?

Composer recommends **no**. They provide [argumentation against but also
workrounds if a project decides to do it anyway](https://getcomposer.org.cn/doc/faqs/should-i-commit-the-dependencies-in-my-vendor-directory.md).

### Should I commit the scaffolding files?

The [drupal-scaffold](https://github.com/drupal-composer/drupal-scaffold) plugin can download the scaffold files (like
index.php, update.php, …) to the web/ directory of your project. If you have not customized those files you could choose
to not check them into your version control system (e.g. git). If that is the case for your project it might be
convenient to automatically run the drupal-scaffold plugin after every install or update of your project. You can
achieve that by registering `@drupal-scaffold` as post-install and post-update command in your composer.json:

```json
"scripts": {
    "drupal-scaffold": "DrupalComposer\\DrupalScaffold\\Plugin::scaffold",
    "post-install-cmd": [
        "@drupal-scaffold",
        "..."
    ],
    "post-update-cmd": [
        "@drupal-scaffold",
        "..."
    ]
},

如何将补丁应用到下载的模块中？

如果您需要应用补丁（根据正在修改的项目，Pull Request 通常是一个更好的解决方案），您可以使用 composer-patches 插件。

要将补丁添加到 drupal 模块 foobar，在 composer.json 的 extra 部分插入 patches 部分

"extra": {
    "patches": {
        "drupal/foobar": {
            "Patch description": "URL or local path to patch"
        }
    }
}

如何从 packagist.drupal-composer.org 切换到 packages.drupal.org？

遵循 drupal.org 上的文档 中的说明。

如何指定 PHP 版本？

目前 Drupal 8 支持 PHP 5.5.9 作为最低版本（见 Drupal 8 PHP 要求），但是，执行 composer update 可能会升级某些包，从而需要 PHP 7+。

为了防止这种情况，您可以将以下代码添加到 composer.json 的 config 部分，以指定您想要使用的 PHP 版本

"config": {
    "sort-packages": true,
    "platform": {"php": "5.5.9"}
},