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作为安装后和更新后命令来实现这一点。

"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版本？

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

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

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

thegobeliners-drupal-composer / drupal-project

维护者

详情