README

这是对主项目 drupal-composer/drupal-project 的适配。目标是安装在项目的根目录上。

安装

composer create-project renanmfd/drupal-project:8.x-dev some-dir --stability dev --no-interaction

原始

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

如果您想了解如何用它替代 Drush Make，请访问 drupal.org 上的文档。

用法

首先您需要 安装 composer。

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

之后您就可以创建项目了

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

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

cd some-dir
composer require drupal/devel:~1.0

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

模板做了什么？

当安装给定的 composer.json 时，一些任务会被处理

• Drupal 将安装在仓库的根目录。
• 实现了自动加载器，以使用位于 drupal-project/composer/autoload.php 的生成的 composer 自动加载器，而不是 Drupal 提供的自动加载器（vendor/autoload.php）。
• 模块（类型为 drupal-module 的包）将放置在 modules/contrib/
• 主题（类型为 drupal-theme 的包）将放置在 themes/contrib/
• 配置文件（类型为 drupal-profile 的包）将放置在 profiles/contrib/
• 创建默认可写版本的 settings.php 和 services.yml。
• 创建 sites/default/files 目录。
• 为在 drupal-project/composer/bin/drush 下使用，本地安装了最新的 drush 版本。
• 为在 drupal-project/composer/bin/drupal 下使用，本地安装了最新的 DrupalConsole 版本。

更新 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 可能与该项目的文件不同。

常见问题解答 (FAQ)

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

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 部分

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

我如何从 packagist.drupal-composer.org 切换到 packages.drupal.org？

请参阅 drupal.org 上的文档说明。