README

此项目模板提供了一个使用 Composer 管理网站依赖项的入门套件。它是基于 Drupal 项目的 Composer 模板构建的，因此许多使用说明将非常相似。

对 Drupal 项目 Composer 模板的补充

此项目对标准安装的软件包有一些补充，具体如下

Behat、PHPUnit 和其他库以及支持 UAT 的工具集作为 "dev" 软件包安装
Roave 安全咨询工具集作为 "dev" 软件包安装。此 composer 插件在执行 composer install / update 命令时扫描非 Drupal php 库以检查安全漏洞。
默认包含以下 Drupal 扩展
- 配置拆分
- CTools
- Devel
- Diff
- 环境指示器
- 模块过滤器
- 段落
- 路径自动
- 重定向
- 风格指南

用法

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

之后，您可以创建项目

composer create-project promet-source/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 目录。
为在 vendor/bin/drush 下使用，安装最新版本的 drush。
为在 vendor/bin/drupal 下使用，安装最新版本的 DrupalConsole。
根据您的 .env 文件创建环境变量。请参阅 .env.example。

更新 Drupal 核心版本

此项目将尝试使您的所有 Drupal 核心文件保持最新；项目 drupal-composer/drupal-scaffold 用于确保在 drupal/core 更新时更新您的支架文件。如果您自定义了任何 "支架" 文件（通常是 .htaccess），则可能需要在 Drupal 核心的新版本中更新您修改的文件时解决冲突。

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

运行 composer update drupal/core webflo/drupal-core-require-dev "symfony/*" --with-dependencies 以更新 Drupal 核心和其依赖项。
运行git diff以确定任何脚手架文件是否已更改。检查文件以查找任何更改，并将对.htaccess或robots.txt的任何自定义更改恢复。
将所有内容一起提交到单个提交中，以便在检出分支或运行git bisect时，web将与core保持同步。
如果在第2步中存在非平凡的冲突，您可能希望在分支上执行这些步骤，并使用git merge将更新的核心文件与您的自定义文件合并。这有助于使用kdiff3等三向合并工具。如果您的更改很简单，则无需此设置；保持所有修改位于文件的开头或结尾是一种使合并变得容易的好策略。

从现有项目生成composer.json

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

常见问题解答

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

Composer建议不提交。他们提供了反对意见，但也提供了如果项目决定这样做的工作方案。

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

drupal-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",
        "..."
    ]
},

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

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

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

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

如何指定PHP版本？

本项目支持PHP 7.2作为最低版本（见Drupal 8 PHP需求），但是，在执行composer update时，可能会升级某些包，这将需要PHP 7.3+。

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

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

promet-source / drupal-project

维护者

详细信息