README

Drupal项目的Composer模板

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

用法

首先，您需要安装composer。

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

之后，您可以创建项目

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

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

cd some-dir
composer require drupal/devel:8.*

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。
创建 sites/default/files 目录。
为在 vendor/bin/drush 下使用，本地安装了 drush 的最新版本。
为在 vendor/bin/drupal 下使用，本地安装了 DrupalConsole 的最新版本。

更新Drupal核心

此项目将尝试保持所有Drupal核心文件是最新的；项目 drupal-composer/drupal-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等三向合并工具。如果您的更改很简单，则不需要此设置；将所有修改保存在文件开头或结尾是一个使合并变得容易的好策略。

从现有项目生成 composer.json

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

常见问题解答

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

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

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

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

要在 drupal 模块 foobar 中添加补丁，请将 patches 部分插入 composer.json 的 extra 部分

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

gyd / drupal-project

维护者

详细信息