README

此项目模板提供了一套管理网站依赖项的入门工具，使用Composer。

重要

Drupal 11分支 可用！

模板做什么？

• Drupal 将安装在 web 目录中。
• 使用 Drupal 核心提供的 web/vendor/autoload.php 替代生成的 composer 自动加载器 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 使用。
• 提供 .env 文件示例。

安装

注意

以下说明参考了 全局 Composer 安装。您可能需要根据您的设置将 composer 替换为 php composer.phar（或类似）。

创建您的项目

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

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

用法

添加新的依赖项

使用 composer require 添加并下载项目依赖项。

cd some-dir
composer require drupal/devel

默认情况下，此项目设置为仅安装依赖项的稳定版本，如 composer.json 中指定的 "minimum-stability": "stable"。如果需要使用非稳定版本（例如，alpha、beta、RC），则可以修改版本约束以允许此类版本。例如，要要求模块的 beta 版本

composer require drupal/devel:1.0.0-beta1

或者，您可以通过修改 composer.json 以包含所需的稳定性级别并显式允许它来全局调整稳定性设置

{
    "minimum-stability": "beta",
    "prefer-stable": true
}

此配置确保首选稳定版本，但在必要时允许安装非稳定包。

添加库

您可以通过 asset-packagist 仓库 使用 Composer 管理前端资产库。Composer 将检测并安装满足所述约束的新库版本。

composer require bower-asset/dropzone

库的自定义安装路径

可以通过将其添加到位于 web/libraries/{$name} 前面的 extra.installer-paths 配置中来控制特定库的安装路径。例如，chosen Drupal 模块期望 chosen 库位于 web/libraries/chosen，但 composer require npm-asset/chosen-js 会将库安装到 web/libraries/chosen-js。以下配置覆盖了将其安装到预期目录的操作

{
    "extra": {
        "installer-paths": {
            "web/libraries/chosen": [
                "npm-asset/chosen-js"
            ],
            "web/libraries/{$name}": [
                "type:drupal-library",
                "type:npm-asset",
                "type:bower-asset"
            ]
        }
    }
}

有关更多详细信息，请参阅 https://asset-packagist.org/site/about

更新 Drupal 核心文件

该项目将尝试使您所有的 Drupal 核心文件保持最新；该项目使用 drupal/core-composer-scaffold 确保每次更新 drupal/core 时，您的脚手架文件都会更新。

如果您自定义了任何“脚手架”文件（通常是 .htaccess），那么当 Drupal 核心的新版本发布时，您的修改文件如果有更新，您可能需要解决合并冲突。

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

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

常见问题解答（FAQs）

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

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"
        }
    }
}

如何指定 PHP 版本？

在解决依赖项时，Composer 将在两个位置查找 PHP 版本要求

1. composer.json 中的 require.php 版本值。
2. composer.json 中的 config.platform 版本值。

require.php 的目的是为包设置最低 PHP 语言要求。例如，Drupal 10.0 所需的最低版本是 8.0.2 或更高版本，可以指定为 >=8。

config.platform 的作用是为当前环境中运行的特定实例的 PHP 语言要求进行设置。例如，虽然 Drupal 10 所需的最低版本是 8.0.2 或更高，但托管提供商的实际 PHP 版本可能是 8.1.0。此字段的值应提供您确切的 PHP 版本，包括版本的所有三个部分。

在我的 Drupal 网站中应指定哪些版本？

此项目包含 drupal/core，其中已经添加了 require.php。您将继承此约束。不需要将 require.php 添加到您的 composer.json 文件中。

config.platform 是平台特定的。建议将 config.platform 指定为一个 特定版本（例如 8.1.19）约束，以确保仅使用当前环境支持的包版本。

"config": {
    "platform": {
        "php": "8.1.19"
    }
},