README

此项目模板提供了一个启动工具包，用于使用 Composer 管理您的网站依赖。

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

用法

首先您需要 安装 composer。

注意：以下说明参照 全局 composer 安装。根据您的配置，您可能需要将 composer 替换为 php composer.phar（或类似）。

之后，您可以创建项目

composer create-project drupal-composer/drupal-project:8.x-dev some-dir --no-interaction

使用 composer require ...，您可以下载新依赖到您的安装中。

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

composer create-project 命令将所有文件的所有权传递给创建的项目。您应该创建一个新的 Git 仓库，并提交所有未被 .gitignore 文件排除的文件。

模板做了什么？

在安装给定的 composer.json 时，会处理一些任务

• Drupal 将安装在 web 目录中。
• 实现了自动加载器，使用 vendor/autoload.php 中生成的 composer 自动加载器，而不是 Drupal 提供的自动加载器（web/vendor/autoload.php）。
• 模块（类型为 drupal-module 的包）将放置在 web/modules/contrib/。
• 主题（类型为 drupal-theme 的包）将放置在 web/themes/contrib/。
• 配置文件（类型为 drupal-profile 的包）将放置在 web/profiles/contrib/。
• 创建默认的可写版本的 settings.php 和 services.yml。
• 创建 web/sites/default/files 目录。
• 在本地安装最新版本的 drush，以便在 vendor/bin/drush 使用。
• 在本地安装最新版本的 DrupalConsole，以便在 vendor/bin/drupal 使用。
• 根据您的 .env 文件创建环境变量。请参阅 .env.example。

更新 Drupal 核心版本

该项目将尝试保持您的所有 Drupal 核心文件的最新状态；使用项目 drupal/core-composer-scaffold 确保每次 drupal/core 更新时，您的支架文件都会更新。如果您自定义了任何“支架”文件（通常是 .htaccess），那么在 Drupal 核心的新版本发布中更新了您修改的文件时，您可能需要解决合并冲突。

按照以下步骤更新您的核心文件。

1. 运行 composer update drupal/core drupal/core-dev --with-dependencies 以更新 Drupal 核心和其依赖项。
2. 运行 git diff 以确定是否有任何支架文件已更改。检查文件以查找任何更改，并恢复对 .htaccess 或 robots.txt 的任何自定义修改。
3. 将所有内容合并为单个提交，这样在检出分支或运行 git bisect 时，web 将与 core 保持同步。
4. 如果在第2步中存在非平凡冲突，您可能希望在分支上执行以下步骤，并使用 git merge 将更新的核心文件与您的自定义文件合并。这有助于使用诸如kdiff3之类的三方合并工具。如果您的更改很简单，则没有必要这样做；将所有修改保留在文件的开始或结束部分是一个保持合并简单的良好策略。

从现有项目生成composer.json

使用"Composer Generate" drush 扩展，您现在可以从现有项目生成一个基本的composer.json文件。请注意，生成的composer.json可能与该项目的文件不同。

常见问题解答（FAQ）

我应该提交下载的贡献模块吗？

Composer推荐不。他们提供反对的理由，同时也提供了如果项目决定这样做时的解决方案。

我应该提交脚手架文件吗？

Drupal Composer Scaffold 插件可以将脚手架文件（如index.php、update.php等）下载到您项目的web/目录。如果您没有自定义这些文件，可以选择不将它们提交到您的版本控制系统（例如git）。如果您的项目是这样，那么在每次安装或更新项目后自动运行drupal-scaffold插件可能很方便。您可以通过在composer.json中将@composer drupal:scaffold注册为post-install和post-update命令来实现这一点。

"scripts": {
    "post-install-cmd": [
        "@composer drupal:scaffold",
        "..."
    ],
    "post-update-cmd": [
        "@composer drupal:scaffold",
        "..."
    ]
},

我如何应用下载的模块的补丁？

如果您需要应用补丁（根据正在修改的项目，拉取请求通常是更好的解决方案），可以使用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版本？

该项目支持PHP 7.0作为最低版本（参见Drupal 8 PHP要求），但是可能存在composer update升级某些包的情况，这需要PHP 7+。

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

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