README

https://travis-ci.org/drupal-composer/drupal-project.svg?branch=8.x)](https://travis-ci.org/drupal-composer/drupal-project

此项目模板提供了使用Composer管理网站依赖项的入门工具包。

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

使用方法

首先您需要安装composer。

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

之后您可以创建项目

composer create-project drupal-composer/drupal-project:8.x-dev some-dir --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和services.yml。
创建了web/sites/default/files目录。
安装了最新版本的drush，用于在vendor/bin/drush中使用。
安装了最新版本的DrupalConsole，用于在vendor/bin/drupal中使用。
根据您的.env文件创建了环境变量。请参阅.env.example。

更新Drupal核心

此项目将尝试保持所有Drupal核心文件的最新状态；使用drupal-composer/drupal-scaffold确保每次更新drupal/core时，您的模板文件都会更新。如果您自定义了任何“模板”文件（通常是.htaccess），您可能需要解决任何在Drupal核心新版本中更新的自定义文件的合并冲突。

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

运行composer update drupal/core webflo/drupal-core-require-dev "symfony/*" --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 建议不要提交。他们提供了反对的理由，但同时也提供了如果项目决定这样做时的解决方案。

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

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

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

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

请遵循 drupal.org 上的说明。

如何指定 PHP 版本？

此项目支持 PHP 5.6 作为最低版本（请参阅 Drupal 8 PHP 要求），但是，执行 composer update 可能会升级某些包，这可能会导致需要 PHP 7+。

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

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

sailendhran / drupal-project

维护者

详细信息