roygoldman/drupal-project

为使用composer的Drupal 8项目模板

8.5.5 2018-08-14 15:49 UTC

This package is auto-updated.

Last update: 2024-09-22 09:49:08 UTC


README

Build Status

此项目模板为使用Composer管理网站依赖项提供了一个启动套件。

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

用法

首先您需要安装composer

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

之后您可以创建项目

composer create-project roygoldman/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.phpservices.yml
  • 创建web/sites/default/files目录。
  • 将最新版本的drush本地安装以供在vendor/bin/drush中使用。
  • 将最新版本的DrupalConsole本地安装以供在vendor/bin/drupal中使用。
  • 根据您的.env文件创建环境变量。请参阅.env.example

更新Drupal Core

此项目将尝试保持所有Drupal Core文件的最新状态;项目drupal-composer/drupal-scaffold用于确保每次drupal/core更新时,您的模板文件都得到更新。如果您自定义了任何“模板”文件(通常为.htaccess),那么当您的修改文件在新版本的Drupal core中更新时,您可能需要合并冲突。

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

  1. 运行composer update drupal/core webflo/drupal-core-require-dev symfony/* --with-dependencies以更新Drupal Core及其依赖项。
  2. 运行git diff以确定是否有任何模板文件已更改。审查文件以查找任何更改,并将任何自定义更改恢复到.htaccessrobots.txt
  3. 将所有内容作为一个单独的提交一起提交,这样在检出分支或运行git bisect时,web将始终与core保持同步。
  4. 如果在步骤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作为安装后和更新后的命令来实现。

"scripts": {
    "post-install-cmd": [
        "@composer drupal:scaffold",
        "..."
    ],
    "post-update-cmd": [
        "@composer drupal:scaffold",
        "..."
    ]
},

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

如果您需要应用补丁(根据正在修改的项目,pull请求通常是一个更好的解决方案),您可以使用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"}
},