README

本项目模板提供了一套基础工具，用于使用Composer来管理您的网站依赖。

用法

首先，您需要安装Composer。

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

之后，您可以创建项目

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

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

cd some-dir
composer require drupal/devel

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核心的新版本中，如果您的修改文件有更新，可能需要解决冲突。

按照以下步骤更新核心文件：

运行composer update drupal/core-recommended drupal/core-dev --with-dependencies以更新Drupal核心及其依赖项。
运行git diff以确定是否有框架文件已更改。审查文件以查找任何更改，并将对.htaccess或robots.txt的任何自定义修改恢复。
将所有更改集中在一个提交中，这样在检出分支或运行git bisect时，web将保持与core同步。
如果在步骤2中存在非平凡的冲突，您可能希望在分支上执行这些步骤，并使用git merge将更新的核心文件与您的自定义文件合并。这有助于使用kdiff3之类的三向合并工具。如果您的更改很简单，则不需要此设置；将所有修改保持在文件的开头或结尾是保持合并简单的好策略。

常见问题解答

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

Composer建议不要这样做。他们提供了反对的理由以及如果项目决定这样做时的解决方案。

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

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

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

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

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

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

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

我该如何指定 PHP 版本？

此项目支持 PHP 7.3 作为最低版本（参见Drupal 9 的环境要求），但是，执行 composer update 可能会升级某些包，这可能会导致需要 PHP 7.3+。

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

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

reida010 / drupal

维护者

详细信息