README

Drupal 项目的 Composer 模板

此项目模板应提供使用 Composer 管理站点依赖的启动。

使用方法

首先您需要 安装 composer。

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

然后您可以创建项目

composer create-project andeersg/bouvet-d8-project:8.x-dev test1 --stability dev --no-interaction

并使用 Drush 设置站点

drush site-install bouvet_profile --db-url='mysql://[db_user]:[db_pass]@localhost/[db_name]' --site-name=[site_name]

如果提供的数据库用户有创建权限，这将创建数据库。

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

下载更多模块

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

cd some-dir
composer require drupal/panels

模板做了什么？

在安装给定的 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 使用。

更新 Drupal 核心

此项目将尝试保持所有 Drupal 核心文件都是最新的；项目 drupal-composer/drupal-scaffold 被用来确保每次 drupal/core 更新时，您的框架文件都得到更新。如果您自定义了任何“框架”文件（通常是 .htaccess），那么在 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等三方合并工具。如果您的更改很简单，这种设置不是必需的；将所有修改保持在文件的开始或结尾是一个使合并变得容易的好策略。

从现有项目生成composer.json

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

常见问题解答

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

Composer建议不要这样做。他们提供了反对的论据，但如果项目决定这样做，也提供了解决方案。

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

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

"scripts": {
    "drupal-scaffold": "DrupalComposer\\DrupalScaffold\\Plugin::scaffold",
    "post-install-cmd": [
        "@drupal-scaffold",
        "..."
    ],
    "post-update-cmd": [
        "@drupal-scaffold",
        "..."
    ]
},

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

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

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

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