preventhivok/phok-platform

Drupal 8项目的Composer模板

dev-master 2017-02-12 23:40 UTC

This package is not auto-updated.

Last update: 2020-06-06 15:31:17 UTC


README

PHOK平台旨在成为非营利组织构建全面网站、吸引目标受众的完整解决方案。

@TODO 写得更多,并替换下面的文本。@TODO 设置TravisCI

Drupal项目的Composer模板

Build Status

此项目模板应提供使用Composer管理网站依赖关系的启动。

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

使用方法

首先您需要安装composer

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

之后您可以创建项目

composer create-project drupal-composer/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
  • 创建sites/default/files目录。
  • 安装最新版本的drush,以便在vendor/bin/drush中使用。
  • 安装最新版本的DrupalConsole,以便在vendor/bin/drupal中使用。

更新Drupal核心

该项目将尝试保持所有Drupal核心文件都是最新的;项目drupal-composer/drupal-scaffold用于确保每次drupal/core更新时,您的支架文件都会更新。如果您对任何“支架”文件(通常为.htaccess)进行了自定义,那么在Drupal核心的新版本中更新您的修改文件时,您可能需要解决合并冲突。

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

  1. 运行composer update drupal/core --with-dependencies来更新Drupal核心及其依赖项。
  2. 运行git diff以确定是否有任何脚手架文件已更改。检查文件以查找任何更改,并将对.htaccessrobots.txt的任何自定义更改恢复。
  3. 将所有内容一起提交到一个提交中,以便在检出分支或运行git bisect时,web将与core保持同步。
  4. 如果在步骤2中出现非平凡冲突,您可能希望在分支上执行这些步骤,并使用git merge将更新的核心文件与您的自定义文件合并。这有助于使用kdiff3之类的三向合并工具。如果您的更改很简单,则无需此设置;将所有修改保留在文件的开头或结尾是一种保持合并容易的好策略。

从现有项目生成composer.json

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

常见问题解答(FAQ)

我应该提交我下载的contrib模块吗?

Composer建议提交。他们提供了反对的论据,但也提供了如果项目决定这样做的话的解决方案

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

drupal-scaffold插件可以将脚手架文件(如index.php、update.php等)下载到您的项目的web/目录。如果您没有自定义这些文件,可以选择不将这些文件提交到您的版本控制系统(例如git)。如果您的项目是这样的,在项目的安装或更新后自动运行drupal-scaffold插件可能很方便。您可以通过在composer.json中将@drupal-scaffold注册为post-install和post-update命令来实现这一点。

"scripts": {
    "drupal-scaffold": "DrupalComposer\\DrupalScaffold\\Plugin::scaffold",
    "post-install-cmd": [
        "@drupal-scaffold",
        "..."
    ],
    "post-update-cmd": [
        "@drupal-scaffold",
        "..."
    ]
},

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

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

要将补丁应用到名为foobar的drupal模块中,在composer.json的extra部分中插入patches部分

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

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

请参阅drupal.org上的文档中的说明。