README

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

用法

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

之后您可以创建项目

composer create-project jrcz/d9-project some-dir --stability=dev --no-interaction

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

cd some-dir
composer require drupal/devel

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

模板做了什么？

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

Drupal将安装在web目录。
实现了Autoloader，以使用位于vendor/autoload.php的生成的Composer Autoloader，而不是Drupal提供的Autoloader（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注册为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.3作为最低版本（参见Drupal 9的环境要求），但是可能存在这种情况：运行composer update会升级某些包，然后需要PHP 7.3+。

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

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

jrcz / d9-project

维护者

详细信息