README

基于 Drupal 项目的 Composer 模板 - https://github.com/drupal-composer/drupal-project

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

使用方法

注意：以下说明参考了全局 Composer 安装。您可能需要将 composer 替换为 php composer.phar（或类似）以适应您的配置。

然后您可以创建项目

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

或者为开发环境

composer create-project stratoserp/stratos-drupal-project:9.x-dev some-dir --prefer-source --keep-vcs

此文档的其余部分来自上述主 Drupal 项目存储库。

使用 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-*" --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，请将 patches 部分插入 composer.json 的 extra 部分

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

singularo / stratos-drupal-project

维护者

详细信息