README

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

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

用法

注意：以下说明针对的是全局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/core-composer-scaffold被用于确保在drupal/core更新时，您的模板文件也会更新。如果您自定义了任何“模板”文件（通常是 .htaccess），那么在Drupal核心的新版本发布时，您可能需要合并冲突，如果您的任何修改过的文件被更新。

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

运行composer update drupal/core drupal/core-dev --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可能与本项目文件不同。

常见问题解答

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

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

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

Drupal Composer 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",
        "..."
    ]
},

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

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

要将补丁添加到 drupal 模块 foobar，请将补丁部分插入 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 7.0 作为最低版本（请参阅Drupal 8 PHP 要求），但是有可能在执行composer update时升级某些包，这将需要 PHP 7+。

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

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

jaybeaton / drupal-project

维护者

详细信息