README

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

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

用法

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

之后您可以创建项目

composer create-project getitdoneproperly/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将被安装在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，它期望配置文件在config/drupal/${site_name}中可用。
创建符号链接web/sites/${site_name}/files到data/drupal/${site_name}/files/public。
在本地安装最新的drush版本，用于在vendor/bin/drush中使用。
在本地安装最新的DrupalConsole版本，用于在vendor/bin/drupal中使用。
根据您的.env文件创建环境变量。请参阅.env.example。

更新Drupal Core

此项目将尝试保持您的所有Drupal Core文件是最新的；项目drupal-composer/drupal-scaffold用于确保在drupal/core更新时，您的模板文件也得到更新。如果您对任何“模板”文件（通常是.htaccess）进行了自定义，那么在Drupal核心的新版本中更新您修改的文件时，您可能需要解决合并冲突。

按照以下步骤更新您的核心文件。

运行composer update drupal/core webflo/drupal-core-require-dev symfony/* --with-dependencies以更新Drupal Core及其依赖项。
运行git diff以确定是否有任何模板文件已更改。检查文件以确定任何更改，并将任何自定义修改恢复到.htaccess或robots.txt。
将所有内容作为一个单独的提交提交，这样在检出分支或运行git bisect时，web将与core保持同步。
如果在第2步中出现非平凡的冲突，您可能希望在这些步骤上使用分支，并使用 git merge 将更新后的核心文件与您的自定义文件合并。这有助于使用kdiff3之类的三方合并工具。如果您的更改很简单，这种设置不是必需的；将所有修改保存在文件的开始或结尾是一个保持合并简单的好策略。

从现有项目生成 composer.json

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

常见问题解答

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

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

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

drupal-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，在 composer.json 的 extra 部分插入 patches 部分

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

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

请遵循drupal.org 上的说明。

如何指定 PHP 版本？

目前 Drupal 8 支持 PHP 5.5.9 作为最低版本（参见 Drupal 8 PHP 要求），然而，执行 composer update 可能会升级某些包，从而需要 PHP 7+。

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

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

getitdoneproperly / drupal-project

维护者

详细信息